Radios
Overview
Endpoints for retrieving, searching and managing radios.
List Radios
Use this endpoint to list all radios.
GET /radiosInput
| Name | Type | Description |
|---|---|---|
| page | Integer | Page number (default 1) |
| page_size | Integer | Result number per page (default 20, max 1000) |
Example
GET /radios?key=...&page_size=1Response
For a valid query
Status: 200 OKFor an invalid query
Status: 400 Bad RequestGet a Radio
Use this endpoint to retrieve a specifi radio.
GET /radios/{radio_id}Example
GET /radios/563b9cb15fb5b184008b4604?key=...Response
For a valid radio id
Status: 200 OKFor an invalid radio id
Status: 404 Not FoundCreate a Radio
Use this endpoint to create a new radio based on tracks and/or tags and/or user.
POST /radiosInput
| Name | Type | Description |
|---|---|---|
| seeds | Array | Array of Niland Track IDs |
| tags | Array | Array of Tag IDs |
| user | String | User Reference |
| discovery_rate | Integer | Percentage of track discovery (between 0 and 100, default 70) |
Example
Response
For a valid query
Status: 201 Created OR 200 OK if a radio already exists with those parametersFor an invalid query
Status: 400 Bad RequestEdit a Radio
Use this endpoint to edit a radio.
PATCH /radios/{radio_id}Input
| Name | Type | Description |
|---|---|---|
| seeds | Array | Array of Niland Track IDs |
| tags | Array | Array of Tag IDs |
| user | String | User external ID |
| discovery_rate | Integer | Percentage of track discovery (between 0 and 100, default 70) |
Example
PATCH /radios/56420e1ff799b98527f3109dResponse
For a valid query
Status: 200 OKFor an invalid query
Status: 400 Bad RequestDelete a Radio
Use this endpoint to delete a radio.
DELETE /radios/{radio_id}Response
For a valid radio id
Status: 204 No ContentFor an invalid radio id
Status: 404 Not FoundGet Next Radio Tracks
Use this endpoint to retrieve the next tracks to play.
GET /radios/{radio_id}/nextResponse
For a valid radio id which is not yet prepared
This means that the radio is not ready yet. You have to follow the redirect until you get a 200 status.
Status: 302 RedirectFor a valid radio id
Status: 200 OKFor an invalid radio id
Status: 404 Not FoundNotify a Skip
In order to get better results, you should tell us when a user skips a track.
POST /radios/{radio_id}/skipsInput
Notice: One parameter only is required.
| Name | Type | Description |
|---|---|---|
| track | Integer | Niland Track ID |
| reference | String | Track Reference |
Example
POST /radios/56420e1ff799b98527f3109d/skipsResponse
For a valid query
Status: 201 CreatedFor an invalid query
Status: 400 Bad RequestFor an invalid radio id
Status: 404 Not FoundNotify a Like
In order to get better results, you should tell us when a user likes a track.
POST /radios/{radio_id}/likesInput
Notice: One parameter only is required.
| Name | Type | Description |
|---|---|---|
| track | Integer | Niland Track ID |
| reference | String | Track Reference |
Example
POST /radios/56420e1ff799b98527f3109d/likesResponse
For a valid query
Status: 201 CreatedFor an invalid query
Status: 400 Bad RequestFor an invalid radio id
Status: 404 Not FoundNotify a Dislike
In order to get better results, you should tell us when a user dislikes a track.
POST /radios/{radio_id}/dislikesInput
Notice: One parameter only is required.
| Name | Type | Description |
|---|---|---|
| track | Integer | Niland Track ID |
| reference | String | Track Reference |
Example
POST /radios/56420e1ff799b98527f3109d/dislikesResponse
For a valid query
Status: 201 CreatedFor an invalid query
Status: 400 Bad RequestFor an invalid radio id
Status: 404 Not FoundNotify a Ban
In order to get better results, you should tell us when a user bans a track.
POST /radios/{radio_id}/bansInput
Notice: One parameter only is required.
| Name | Type | Description |
|---|---|---|
| track | Integer | Niland Track ID |
| reference | String | Track Reference |
Example
POST /radios/56420e1ff799b98527f3109d/bansResponse
For a valid query
Status: 201 CreatedFor an invalid query
Status: 400 Bad RequestFor an invalid radio id
Status: 404 Not FoundNotify a Favorite
In order to get better results, you should tell us when a user add a track to his favorites.
POST /radios/{radio_id}/favoritesInput
Notice: One parameter only is required.
| Name | Type | Description |
|---|---|---|
| track | Integer | Niland Track ID |
| reference | String | Track Reference |
Example
POST /radios/56420e1ff799b98527f3109d/favoritesResponse
For a valid query
Status: 201 CreatedFor an invalid query
Status: 400 Bad RequestFor an invalid radio id
Status: 404 Not FoundNotify a Not Played Track
In order to get better results, you should tell us when a user has not played a track before get the next tracks.
POST /radios/{radio_id}/notplayedsInput
Notice: One parameter only is required.
| Name | Type | Description |
|---|---|---|
| track | Integer | Niland Track ID |
| reference | String | Track Reference |
Example
POST /radios/56420e1ff799b98527f3109d/notplayedsResponse
For a valid query
Status: 201 CreatedFor an invalid query
Status: 400 Bad RequestFor an invalid radio id
Status: 404 Not Found