Playlist.blockTrack

From MeeMixWiki

Contents 1 Overview 2 Request 3 Response 4 Faults

Overview

Block a specific track (previously provided by the playlist.getTrack operation) from playing on this playlist for a given period of time.

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 user.getPlaylists operation or the user.createPlaylistBy* operations.
optional	libId	string	block track based on media library created with lib.create. Should be used only if using the libTrackId.
optional	libTrackId	string	block track based on your local track id submitted with lib.submitTrack.
optional	trackId	string	the ID of the track to block, provided earlier by calling playlist.getTrack operation.
required	period	int	an integer between 0 and 2, where: 0 - block the track forever. 1 - block the track for one week. 2 - block the track for one month.

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.blockTrack?partnerId=1001&partnerKey=...&userId=1febadd&playlistId=17&trackId=6470&period=2

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:playlistBlockTrackRequest>
           <partnerId>1001</partnerId>
           <partnerKey>...</partnerKey>
           <userId>jim</userId>
           <playlistId>17</playlistId>
           <trackId>6470</trackId>
           <period>2</period>
       </q0:playlistBlockTrackRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response

If no faults have been thrown, the track was blocked successfully for the requested period.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
       <playlistBlockTrackResponse xmlns:ns1="http://ws.meemix.com:8080/mxws/">
            <success>true</success>
       </playlistBlockTrackResponse>
   </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.