Similar.getArtistsByArtist

From MeeMixWiki

Jump to: navigation, search

Contents

Overview

In Single Request Discovery Mode, this operation will search for standalone artist recommendations according to a given artist name, your local artist id, or MeeMix artist ID, using your partner ID and partner key. Recommendations are based on musical DNA similarity.

Request

Parameters:

Required Name Type Description
required partnerId string your assigned partner ID.
required partnerKey string your assigned partner key.
optional libId string look for artists based on media library created with lib.create.
optional linkType string look for artists based on a specific Content Type (e.g, events) submitted with lib.submitArtistLinks.
optional libArtistId string look for artists based on your local artist id submitted with lib.submitTrack.
optional artistId string look for artists based on an MeeMix artist ID.
optional artistName string look for artists based on an artist name.

Note: either libArtistId, artistId or artistName must be presented in the request. Internal search order respectively.


SOAP request example:

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:q0="http://ws.meemix.com/mxws/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
   xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
   <soapenv:Body>
       <q0:similarGetArtistsByArtistRequest>
           <partnerId>1001</partnerId>
           <partnerKey>...</partnerKey>
           <artistName>pink floyd</artistName>
           <artistId/>
       </q0:similarGetArtistsByArtistRequest>
   </soapenv:Body>
 </soapenv:Envelope>

REST request example:

http://ws.shadow.meemix.com:8080/mxws/services/mxws/similar.getArtistsByArtist?partnerId=1001&partnerKey=...&artistName=pink%20floyd

Response

Data Types:

Here is an example of successful response (looking for artistName "Pink Floyd"):

<ns1:similarGetArtistsByArtistResponse
   xmlns:ns1="http://ws.meemix.com/mxws/">
   <artists>
       <artist>
           <artistId>5987</artistId>
           <libArtistId>5987</libArtistId>
           <artistName>Camel</artistName>
           <links xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:nil="1" />
       </artist>
       <artist>
           <artistId>15045</artistId>
           <libArtistId>15045</libArtistId>
           <artistName>Chris Squire</artistName>
           <links xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:nil="1" />
       </artist>
       <artist>
           <artistId>23685</artistId>
           <libArtistId>23685</libArtistId>
           <artistName>Wigwam</artistName>
           <links xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:nil="1" />
       </artist>
       <artist>
           <artistId>23680</artistId>
           <libArtistId>23680</libArtistId>
           <artistName>Nektar</artistName>
           <links>
               <link>
                   <linkType>event</linkType>
                   <linksData>
                     <linkData>
                        <linkId>1071284</linkId>                    
                        <linkCookie>http://tickets.meemix.com/ResultsTicket.aspx?evtid=1071284</linkCookie>
                     </linkData>
                   </linksData> 
               </link>
           </links>
       </artist>
       ..
       ..
   </artists>
   <artistSuggestions />
</ns1:similarGetArtistsByArtistResponse>

Faults

Code Description
1 Invalid partner ID
2 Invalid partner key
7 Artist name not found
8 Invalid artist ID
17 Invalid input (either artistId or artistName must be specified in the request)

For a full faults list and example of soapFault please visit the Faults page.

Personal tools
        © 2009 MeeMix ltd