lockerData

Allows you to retrieve the contents of a user's locker. Contents can be retrieved by specifying a "type" parameter of "artist", "album", "track", etc (full list of valid types below). Results can also be returned in sets, so you can limit the number of items returned at one time and page through data.

Parameters

sid (required): A valid session id, received from the "login" method.
partner_token (required): A valid partner token. See Overview for more information.
type (required): Specifies the type of data to return. See the below list for valid types.
count (optional): Maximum number of results to be returned in a result set.
set (optional): The result set number to retrieve, note that set numbers are 0 based.
album_id (optional): Used when type=track to filter list of tracks by album. To retrieve a list of albums, set type=album.
artist_id (optional): Used when type=album to filter list of albums by artist, or when type=track to filter list of tracks by artist. To retrieve a list of artists, set type=artist.
playlist_id (optional): Used when type=track to filter list of tracks by playlist. To retrieve a list of playlists, set type=playlist or type=playmix. 3 hard-coded playlist ID's are also Available: RANDOM_TRACKS, NEWEST_TRACKS, RECENTLY_PLAYED
Set type=track and playlist_id=PLAYMIX_TRACK_1234567 to get back a list of tracks similar to the track_id passed in where 1234567 is the track_id.
noplaymix (optional): Used when type=playlist to exclude PlayMix lists. This would be used in combination with type=playmix in order to break out user created playlists separately from PlayMix lists.
token (optional): Can be used to filter 'artist', 'album' or 'track' types by the first letter of their names (i.e. all tracks that start with "B", token=B).
mindata (Optional): Used to set the data fields returned. Valid values being "true" (default) or "false". If set to "true", the following fields are removed from the results returned for each track: Track Number, Album Year, Track File Name, Track Size, Track File Format, Play Mix Available, Track File ID, Download URL, Album Art URL.
output (Optional): Your preferred output format. These include xml, and json.

Valid Types:

artist: All results are contained within an "artistList" object or node.
album: All results are contained within an "albumList" object or node.
video: All results are contained within a "trackList" object or node.
trash: All results are contained within a "trackList" object or node.
playlist: All results are contained within a "playlistList" object or node.
playmix: All results are contained within a "playlistList" object or node.
artist_token: All results are contained within a "tokenList" object or node. Obtains a list of tokens (A-Z, 0-9) for which there is at least one result value.
album_token: All results are contained within a "tokenList" object or node. Obtains a list of tokens (A-Z, 0-9) for which there is at least one result value.
track_token: All results are contained within a "tokenList" object or node. Obtains a list of tokens (A-Z, 0-9) for which there is at least one result value.

Example Request (Get a list of artists):

http://ws.mp3tunes.com/api/v1/lockerData?output=xml&sid=<sid>&partner_token=999999999
&type=artist

Example Response:


  
    artist
    7
  
  
    
      9864
      Django Reinhardt
      55936279
      1
      10
    
    
      274
      Jimi Hendrix
      3681749
      4
      5
    
    
      43
      Miles Davis Quintet
      7033334
      1
      1
    
    ...

Example Request (Get a list of albums):

http://ws.mp3tunes.com/api/v1/lockerData?output=xml&sid=<sid>&partner_token=999999999
&type=album

Example Response:


  
    album
    43
    1
  
  
    
      56
      Relaxin' With The Miles Davis
      43
      Miles Davis Quintet
      1
      7033334
      
      
      2

Example Request (Get a list of tracks for an album):

http://ws.mp3tunes.com/api/v1/lockerData?output=xml&sid=<sid>&partner_token=999999999
&type=track&album_id=56

Example Response:


  
    56
    Relaxin' With The Miles Davis
    43
    Miles Davis Quintet
    1
    7033334
    
    
    2
  
  
    
      423
      Oleo
      4
      
      04 Oleo.mp3
      7c653bfdfd2e93dc5e04140c0b5b7287
      7033334
      http://content.mp3tunes.com/storage/lockerget/7c653bfdfd2e93dc5e04140c0b5b7287?sid=d102188b626c678a42a681cfc5d3685f&partner_token=
      http://content.mp3tunes.com/storage/lockerplay/7c653bfdfd2e93dc5e04140c0b5b7287?sid=d102188b626c678a42a681cfc5d3685f&partner_token=
      56
      Relaxin' With The Miles Davis
      1956
      43
      Miles Davis Quintet
      http://content.mp3tunes.com/storage/albumartget/7c653bfdfd2e93dc5e04140c0b5b7287?sid=d102188b626c678a42a681cfc5d3685f
    
  
  
    track
    56
    1

Example Request (Get a list of artists that start with the letter "B"):

http://ws.mp3tunes.com/api/v1/lockerData?output=xml&sid=<sid>&partner_token=999999999
&type=artist&token=B

Example Response:


  
    artist
    B
    56
  
  
    
      14
      Backbeat Acid Jazz Allstars
      7777516
      1
      1
    
    
      89
      Bad Religion
      2783360
      1
      1
    
    
      116
      Barbra Streisand
      4957500
      1
      1
    
    
      13187
      Barney Kessel
      60082846
      2
      11