Getting
All playlist endpoints called with a get verb will request data.
/Playlists/{Id}/
GET - Get a playlist.
Javascript Example
var hash = CryptoJS.HmacSHA256('GET&/Playlists/12/&', private_key);
var hash64 = CryptoJS.enc.Base64.stringify(hash);
Header Name |
Type |
Description |
Example |
system_access_token |
string |
Your Rhymba Access Token |
E32C8CFE8A1EC895C8C63FE5BD924941 |
system_access_secret |
string |
Your Rhymba Access Secret |
25BA2FADE0B0F47A0D913EBBC8F1EB6C |
hash |
string |
The request hash |
cndh6C/die66R+qwceUJW/dXBHYUwm6tVt8MhBayl/0= |
Field Name |
Type |
Description |
Example |
pageNum |
int |
Optional; Page Number. Defaults to 1. |
1 |
pageSize |
int |
Optional; Results per page. Defaults to 10. |
1 |
Returns
Type |
Description |
Example |
Playlist JSON |
The requested playlist object |
{
"Users": [{
"UserId": 27
}],
"Items": [{
"MediaId": 53379368,
"AlbumId": 8736662,
"ArtistId": 97847,
"TrackName": "The Diamond Sinners",
"AlbumName": "The Gospel",
"ArtistName": "Pig",
"TrackLength": 279,
"id": 764,
"order": 1
},
{
"MediaId": 2573243,
"AlbumId": 216154,
"ArtistId": 89991,
"TrackName": "Dead Souls (From \"The Crow\" Soundtrack)",
"AlbumName": "The Downward Spiral",
"ArtistName": "Nine Inch Nails",
"TrackLength": 293,
"id": 765,
"order": 2
}],
"Name": "New Playlist",
"Description": "A description for the Playlist",
"Image": null,
"ImageId": null,
"PlaylistId": 178,
"SortSeed": 691744021,
"IsRandom": false,
"DMCA": false,
"TotalItems": 2,
"Playing": false,
"currentItem": null,
"currentItemTime": 0,
"id": 12,
"order": null
}
|
/Playlists/{playlistId}/Media/
GET - Get list of Media associated in a Playlist. Note that metadata will only populate if the MediaId matches Media in your Whitelist, and that labels change what Media is Whitelisted.
Javascript Example
var hash = CryptoJS.HmacSHA256('GET&/Playlists/12/Media/&', private_key);
var hash64 = CryptoJS.enc.Base64.stringify(hash);
Header Name |
Type |
Description |
Example |
system_access_token |
string |
Your Rhymba Access Token |
E32C8CFE8A1EC895C8C63FE5BD924941 |
system_access_secret |
string |
Your Rhymba Access Secret |
25BA2FADE0B0F47A0D913EBBC8F1EB6C |
hash |
string |
The request hash |
cndh6C/die66R+qwceUJW/dXBHYUwm6tVt8MhBayl/0= |
Field Name |
Type |
Description |
Example |
pageNum |
int |
Optional; Page Number. Defaults to 1. |
1 |
pageSize |
int |
Optional; Results per page. Defaults to 10. |
1 |
Returns
Type |
Description |
Example |
Media Array |
Collection of Media objects |
[{
"MediaId": 53379368,
"AlbumId": 8736662,
"ArtistId": 97847,
"TrackName": "The Diamond Sinners",
"AlbumName": "The Gospel",
"ArtistName": "Pig",
"TrackLength": 279,
"id": 764,
"order": 1
},
{
"MediaId": 2573243,
"AlbumId": 216154,
"ArtistId": 89991,
"TrackName": "Dead Souls (From \"The Crow\" Soundtrack)",
"AlbumName": "The Downward Spiral",
"ArtistName": "Nine Inch Nails",
"TrackLength": 293,
"id": 765,
"order": 2
}]
|
/Playlists/{id}/Playlists/
GET - Get list of Playlists associated with a Playlist.
Javascript Example
var hash = CryptoJS.HmacSHA256('GET&/Playlists/12/Playlists/&', private_key);
var hash64 = CryptoJS.enc.Base64.stringify(hash);
Header Name |
Type |
Description |
Example |
system_access_token |
string |
Your Rhymba Access Token |
E32C8CFE8A1EC895C8C63FE5BD924941 |
system_access_secret |
string |
Your Rhymba Access Secret |
25BA2FADE0B0F47A0D913EBBC8F1EB6C |
hash |
string |
The request hash |
cndh6C/die66R+qwceUJW/dXBHYUwm6tVt8MhBayl/0= |
Field Name |
Type |
Description |
Example |
pageNum |
int |
Optional; Page Number. Defaults to 1. |
1 |
pageSize |
int |
Optional; Results per page. Defaults to 10. |
1 |
Returns
Type |
Description |
Example |
Playlist Array |
Collection of Playlist objects |
|
/Playlists/{playlistId}/Albums/
GET - Get list of Albums associated with a Playlist.
Javascript Example
var hash = CryptoJS.HmacSHA256('GET&/Playlists/12/Albums/&', private_key);
var hash64 = CryptoJS.enc.Base64.stringify(hash);
Header Name |
Type |
Description |
Example |
system_access_token |
string |
Your Rhymba Access Token |
E32C8CFE8A1EC895C8C63FE5BD924941 |
system_access_secret |
string |
Your Rhymba Access Secret |
25BA2FADE0B0F47A0D913EBBC8F1EB6C |
hash |
string |
The request hash |
cndh6C/die66R+qwceUJW/dXBHYUwm6tVt8MhBayl/0= |
Field Name |
Type |
Description |
Example |
pageNum |
int |
Optional; Page Number. Defaults to 1. |
1 |
pageSize |
int |
Optional; Results per page. Defaults to 10. |
1 |
Returns
Type |
Description |
Example |
Album Array |
Collection of Album objects |
[{
"AlbumId": 8736662,
"ArtistId": 97847,
"AlbumName": "The Gospel",
"ArtistName": "Pig",
"id": 764,
"order": 1
},
{
"AlbumId": 216154,
"ArtistId": 89991,
"AlbumName": "The Downward Spiral",
"ArtistName": "Nine Inch Nails",
"id": 765,
"order": 2
}]
|
/Playlists/{playlistId}/Artists/
GET - Get list of Artists associated with a Playlist.
Javascript Example
var hash = CryptoJS.HmacSHA256('GET&/Playlists/12/Artists/&', private_key);
var hash64 = CryptoJS.enc.Base64.stringify(hash);
Header Name |
Type |
Description |
Example |
system_access_token |
string |
Your Rhymba Access Token |
E32C8CFE8A1EC895C8C63FE5BD924941 |
system_access_secret |
string |
Your Rhymba Access Secret |
25BA2FADE0B0F47A0D913EBBC8F1EB6C |
hash |
string |
The request hash |
cndh6C/die66R+qwceUJW/dXBHYUwm6tVt8MhBayl/0= |
Field Name |
Type |
Description |
Example |
pageNum |
int |
Optional; Page Number. Defaults to 1. |
1 |
pageSize |
int |
Optional; Results per page. Defaults to 10. |
1 |
Returns
Type |
Description |
Example |
Artist Array |
Collection of Artist objects |
[{
"ArtistId": 97847,
"ArtistName": "Pig",
"id": 764,
"order": 1
},
{
"ArtistId": 89991,
"ArtistName": "Nine Inch Nails",
"id": 765,
"order": 2
}]
|
/Playlists/{playlistId}/Users/
GET - Get list of Users associated with a Playlist.
Javascript Example
var hash = CryptoJS.HmacSHA256('GET&/Playlists/12/Users/&', private_key);
var hash64 = CryptoJS.enc.Base64.stringify(hash);
Header Name |
Type |
Description |
Example |
system_access_token |
string |
Your Rhymba Access Token |
E32C8CFE8A1EC895C8C63FE5BD924941 |
system_access_secret |
string |
Your Rhymba Access Secret |
25BA2FADE0B0F47A0D913EBBC8F1EB6C |
hash |
string |
The request hash |
cndh6C/die66R+qwceUJW/dXBHYUwm6tVt8MhBayl/0= |
Field Name |
Type |
Description |
Example |
pageNum |
int |
Optional; Page Number. Defaults to 1. |
1 |
pageSize |
int |
Optional; Results per page. Defaults to 10. |
1 |
Returns
Type |
Description |
Example |
User Array |
Collection of User objects |
[{
"UserId": 27
},
{
"UserId": 28
}]
|
/Users/{userId}/Playlists/
GET - Get list of Playlists associated with a User.
Javascript Example
var hash = CryptoJS.HmacSHA256('GET&/Users/27/Playlists/&', private_key);
var hash64 = CryptoJS.enc.Base64.stringify(hash);
Header Name |
Type |
Description |
Example |
system_access_token |
string |
Your Rhymba Access Token |
E32C8CFE8A1EC895C8C63FE5BD924941 |
system_access_secret |
string |
Your Rhymba Access Secret |
25BA2FADE0B0F47A0D913EBBC8F1EB6C |
hash |
string |
The request hash |
cndh6C/die66R+qwceUJW/dXBHYUwm6tVt8MhBayl/0= |
Field Name |
Type |
Description |
Example |
pageNum |
int |
Optional; Page Number. Defaults to 1. |
1 |
pageSize |
int |
Optional; Results per page. Defaults to 10. |
1 |
Returns
Type |
Description |
Example |
Playlist Array |
Collection of Playlist objects |
[
{
"Users": [
{
"UserId": 27
}
],
"Items": null,
"Name": "New Playlist",
"Description": "A description for the Playlist",
"Image": null,
"ImageId": null,
"PlaylistId": 178,
"SortSeed": 691744021,
"IsRandom": false,
"DMCA": false,
"TotalItems": 2,
"Playing": false,
"currentItem": null,
"currentItemTime": 0,
"id": 12,
"order": null
},
{
"Users": [
{
"UserId": 27
}
],
"Items": null,
"Name": "New Playlist 2",
"Description": "A description for the Playlist",
"Image": null,
"ImageId": null,
"PlaylistId": 179,
"SortSeed": 691744022,
"IsRandom": false,
"DMCA": false,
"TotalItems": 5,
"Playing": false,
"currentItem": null,
"currentItemTime": 0,
"id": 13,
"order": null
}
]
|