Adding
All playlist endpoints called with a post verb will create or add. All of these calls require a valid Access Token from a logged in user to be passed in the request header.
/Playlists/
POST - Create a new playlist.
Javascript Example
var hash = CryptoJS.HmacSHA256('POST&/Playlists/&name=New%20Playlist&mediaIds=53379368%2C2573243&access_token=ZT...DE=', 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 |
name |
string |
The name to call the Playlist |
New Playlist |
mediaIds |
string |
Comma delimited list of media ids |
53379368,2573243 |
access_token |
string |
Access Token |
ZTMyYzhjZmU4YTFlYzg5NWM4YzYzZmU1YmQ5MjQ5NDE= |
Returns
Type |
Description |
Example |
Playlist JSON |
The new 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": null,
"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/
POST - Add Media to a Playlist
Javascript Example
var hash = CryptoJS.HmacSHA256('POST&/Playlists/289/Media/&mediaIds=53379368%2C2573243&access_token=ZT...DE=', 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 |
playlistId |
integer |
id of Playlist |
289 |
mediaIds |
string |
Comma delimited list of media ids |
53379368,2573243 |
insertBehind |
integer |
Optional. Zero based index to insert media. Omit to insert at end of Playlist. |
3 |
access_token |
string |
Access Token |
ZTMyYzhjZmU4YTFlYzg5NWM4YzYzZmU1YmQ5MjQ5NDE= |
Returns
Type |
Description |
Example |
integer |
The id of the item added, or the number of items added for multiple items |
2
|
/Playlists/{id}/Playlists/
POST - Add a Playlist to a Playlist
Javascript Example
var hash = CryptoJS.HmacSHA256('POST&/Playlists/289/Playlists/&playlistId=301&access_token=ZT...DE=', 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 |
id |
integer |
id of Playlist to modify |
289 |
playlistId |
integer |
id of Playlist to add |
301 |
insertBehind |
integer |
Optional. Zero based index to insert media. Omit to insert at end of Playlist. |
3 |
access_token |
string |
Access Token |
ZTMyYzhjZmU4YTFlYzg5NWM4YzYzZmU1YmQ5MjQ5NDE= |
Returns
Type |
Description |
Example |
integer |
The id of the item added |
30261
|
/Playlists/{playlistId}/UploadImage/
POST - Upload an Image to associate with a Playlist. This uses our Rhymba Images service, and requires an account be setup.
Javascript Example
var hash = CryptoJS.HmacSHA256('POST&/Playlists/289/UploadImage/&access_token=ZT...DE=', 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 |
playlistId |
integer |
id of Playlist |
289 |
image |
binary |
image file |
n/a |
access_token |
string |
Access Token |
ZTMyYzhjZmU4YTFlYzg5NWM4YzYzZmU1YmQ5MjQ5NDE= |
Returns
Type |
Description |
Example |
boolean |
if the upload succeeded |
true
|
/Playlists/{playlistId}/Albums/
POST - Add an Album to a Playlist
Javascript Example
var hash = CryptoJS.HmacSHA256('POST&/Playlists/289/Albums/&albumId=53379368%2C2573243&access_token=ZT...DE=', 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 |
playlistId |
integer |
id of Playlist |
289 |
albumId |
integer |
album id |
53379368 |
insertBehind |
integer |
Optional. Zero based index to insert media. Omit to insert at end of Playlist. |
3 |
access_token |
string |
Access Token |
ZTMyYzhjZmU4YTFlYzg5NWM4YzYzZmU1YmQ5MjQ5NDE= |
Returns
Type |
Description |
Example |
integer |
The id of the item added |
30261
|
/Playlists/{playlistId}/Artists/
POST - Add an Artist to a Playlist
Javascript Example
var hash = CryptoJS.HmacSHA256('POST&/Playlists/289/Artist/&artistId=53379368&access_token=ZT...DE=', 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 |
playlistId |
integer |
id of Playlist |
289 |
artistId |
integer |
artist id |
53379368 |
insertBehind |
integer |
Optional. Zero based index to insert media. Omit to insert at end of Playlist. |
3 |
access_token |
string |
Access Token |
ZTMyYzhjZmU4YTFlYzg5NWM4YzYzZmU1YmQ5MjQ5NDE= |
Returns
Type |
Description |
Example |
integer |
The id of the item added |
30621
|
/Playlists/{id}/
POST - Make a copy of a Playlist
Javascript Example
var hash = CryptoJS.HmacSHA256('POST&/Playlists/289/&name=New%20Playlist&access_token=ZT...DE=', 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 |
id |
integer |
Playlist id to copy |
289 |
name |
string |
The name to call the Playlist |
New Playlist |
access_token |
string |
Access Token |
ZTMyYzhjZmU4YTFlYzg5NWM4YzYzZmU1YmQ5MjQ5NDE= |
Returns
Type |
Description |
Example |
Playlist JSON |
The new 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": null,
"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}/Users/
/Users/{userId}/Playlists/
POST - Add a User to a Playlist. Either endpoint can be used, both are included for completeness.
Javascript Example
var hash = CryptoJS.HmacSHA256('POST&/Playlists/289/Users/&userId=27&access_token=ZT...DE=', 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 |
playlistId |
integer |
Playlist id |
289 |
userId |
integer |
user id to add |
27 |
access_token |
string |
Access Token |
ZTMyYzhjZmU4YTFlYzg5NWM4YzYzZmU1YmQ5MjQ5NDE= |
Returns
Type |
Description |
Example |
Playlist JSON |
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": null,
"Image": null,
"ImageId": null,
"PlaylistId": 178,
"SortSeed": 691744021,
"IsRandom": false,
"DMCA": false,
"TotalItems": 2,
"Playing": false,
"currentItem": null,
"currentItemTime": 0,
"id": 12,
"order": null
}
|