Playlist.rateTrack

From MeeMixWiki

Contents 1 Overview 2 Request 3 Response 4 Faults

Overview

Rate a track (that was provided by the playlist.getTrack operation) on a playlist.

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	playlistId	string	the playlistId provided earlier by calling either the user.getPlaylists operation or the user.createPlaylistBy* operations.
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	rate a track based on your local track id submitted with lib.submitTrack.
optional	trackId	string	the ID of the track to rate, provided earlier by calling playlist.getTrack operation.
required	rateLevel	int	the new track rating. An integer between -6 and 6, where -6 means the user really disliked the track, and 6 means the user really liked the track.

Note: either libTrackID or trackId must be presented in the request. In case you are using libTrackId, libId must be presented as well.

REST request example:

http://ws.shadow.meemix.com:8080/mxws/services/mxws/playlist.rateTrack?partnerId=1001&partnerKey=...&userId=jim&playlistId=17&trackId=6470&rateLevel=3

SOAP request example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:q0="http://ws.meemix.com:8080/mxws/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
   xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
   <soapenv:Body>
       <q0:playlistRateTrackRequest>
           <partnerId>1001</partnerId>
           <partnerKey>...</partnerKey>
           <userId>jim</userId>
           <playlistId>17</playlistId>
           <trackId>6470</trackId>
           <rateLevel>3</rateLevel>
       </q0:playlistRateTrackRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

If no faults have been thrown, the track was rated successfully.

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

Faults

Code	Description
1	Invalid partner ID
2	Invalid partner key
4	Invalid user ID
6	Invalid playlist ID
10	Invalid track ID.

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