User.setTrackAction

From MeeMixWiki

Jump to: navigation, search

Contents

Overview

Notifies MeeMix about an action the user took regarding a specific track (e.g., purchased track, downloaded its ringtone).

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:
  • purchased
  • downloaded
  • played
  • searched
  • related info
  • liked
  • hated
optional libId string rate a track based on media library created with lib.create. Should be used only if using the libTrackId.
optional libTrackId string action performed concerns this track (by your local track identifier).
optional trackId string action performed concerns this track (by its trackId).
optional trackName string action performed concerns this track (by its trackName).
optional artistName string In case you are trying to set an action using the trackName option, it is recommended to send the artistName as well.

NOTE: either libTrackId, trackId or trackName must be specified in the request. In case you are using libTrackId, libId must be presented 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:userSetTrackActionRequest>
           <partnerId>1001</partnerId>
           <partnerKey>...</partnerKey>
           <userId>jim</userId>
           <linkType>ringone</linkType>
           <action>purchased</action>
           <trackName>stan</trackName>
           <trackId />
           <artistName>eminem</artistName>
       </q0:userSetTrackActionRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

Data Types:

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

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


Faults

Code Description
1 Invalid partner ID
2 Invalid partner key
4 Invalid user ID
9 Track name not found
10 Invalid track ID
17 Invalid input (either libTrackId, trackId or trackName 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