User.getPlaylists
From MeeMixWiki
Contents |
Overview
Retrieves the user's personalized playlists.
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 |
REST request example:
http://ws.shadow.meemix.com:8080/mxws/services/mxws/user.getPlaylists?partnerId=1001&partnerKey=...&userId=jim
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:userGetPlaylistsRequest> <partnerId>1001</partnerId> <partnerKey>...</partnerKey> <userId>jim</userId> </q0:userGetPlaylistsRequest> </soapenv:Body> </soapenv:Envelope>
Response
Returns the user's playlists. See Playlist for more information about the playlist structure.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <userGetPlaylistsResponse xmlns:ns1="http://ws.meemix.com:8080/mxws/"> <playlists> <playlist> <playlistId>17</playlistId> <playlistName>Nirvana</playlistName> <pulse>3</pulse> <surprise>0</surprise> <atmosphere>4</atmosphere> </playlist> <playlist> <playlistId>18</playlistId> <playlistName>Pearl Jam</playlistName> <pulse>2</pulse> <surprise>0</surprise> <atmosphere>4</atmosphere> </playlist> <playlist> <playlistId>19</playlistId> <playlistName>Pink Floyd</playlistName> <pulse>2</pulse> <surprise>0</surprise> <atmosphere>4</atmosphere> </playlist> <playlist> <playlistId>20</playlistId> <playlistName>November Rain</playlistName> <pulse>3</pulse> <surprise>0</surprise> <atmosphere>5</atmosphere> </playlist> <playlist> <playlistId>21</playlistId> <playlistName>One</playlistName> <pulse>3</pulse> <surprise>0</surprise> <atmosphere>3</atmosphere> </playlist> </playlists> </userGetPlaylistsResponse> </soapenv:Body> </soapenv:Envelope>
Faults
| Code | Description |
|---|---|
| 1 | Invalid partner ID |
| 2 | Invalid partner key |
| 4 | Invalid user ID |
For a full faults list and example of soapFault please visit the Faults page.
