User.setArtistAction

From MeeMixWiki

Contents 1 Overview 2 Request 3 Response 4 Faults

Overview

Notifies MeeMix about an action the user took regarding a specific artist (e.g., searched for an event by the artist).

Request

Parameters:

Required	Name	Type	Description
required	partnerId	string	your assigned partner ID.
required	partnerKey	string	your assigned 32-character partner key.
required	userId	string	unique user ID.
required	linkType	mediaType (string based)	see linkType for a list of available options.
required	action	user action (string based)	a choice between the following options: searched liked hated
optional	libId	string	the media library (created before with lib.create) to set the action in. Should be used only if using libArtistId.
optional	libArtistId	string	action performed concerns this artist (specified by your local artist identifier).
optional	artistId	string	action performed concerns this artist (specified by its MeeMix artistId).
optional	artistName	string	action performed concerns this artist (specified by its artistName).

NOTE: either libArtistId, artistId or artistName must be specified in the request. In case you are using libArtistId, libId must be sent as well.

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:userSetArtistActionRequest>
           <partnerId>1001</partnerId>
           <partnerKey>...</partnerKey>
           <userId>jim</userId>
           <linkType>event</linkType>
           <action>liked</action>           
           <artistName>eminem</artistName>
       </q0:userSetTrackActionRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

Data Types:

• Artist Suggestions

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
       <userSetArtistActionResponse xmlns:ns1="http://ws.meemix.com/mxws/">
           <success>true</success>
           <artistSuggestions />
       </userSetArtistActionResponse>
   </soapenv:Body>
</soapenv:Envelope>

In case of a spelling mistake in the artistName, the artist Suggestions will be sent in the response. In this case, the operation can be called again using one of the artist IDs supplied in this response to complete setting the artist action process.

Faults

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

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