mirror of
https://github.com/KevinMidboe/zoff.git
synced 2026-01-18 15:35:36 +00:00
More RESTApi explanation in README and more endpoints
This commit is contained in:
@@ -4,7 +4,7 @@ Under ``` /server/apps/ ```, there are two files, ``` admin.js ``` and ``` clien
|
||||
|
||||
## REST
|
||||
|
||||
All PUT, DELETE and POST endpoints have a 2-second waitlimit for each command per client. You'll get a response with Retry-After header for how long you have to wait. Shuffling in a player has a 5-second waitlimit, but per channel instead of per client.
|
||||
All PUT, DELETE and POST endpoints have a 2-second waitlimit for each command per client. You'll get a response with Retry-After header for how long you have to wait. Shuffling in a player has a 5-second waitlimit, but per channel instead of per client.
|
||||
|
||||
Add song
|
||||
|
||||
@@ -19,6 +19,7 @@ POST /api/list/:channel_name/:video_id
|
||||
"userpass": USER_PASSWORD
|
||||
}
|
||||
|
||||
Returns 400 for bad request
|
||||
Returns 403 for bad authentication
|
||||
Returns 409 if the song exists
|
||||
Returns 429 if you're doing too much of this request, with a Retry-After int value in the header.
|
||||
@@ -33,8 +34,9 @@ DELETE /api/list/:channel_name/:video_id
|
||||
"userpass": USER_PASSWORD
|
||||
}
|
||||
|
||||
Returns 400 for bad request
|
||||
Returns 403 for bad authentication
|
||||
Returns 404 if the song doesnt exist
|
||||
Returns 404 if the song doesnt exist or is the currently playing song
|
||||
Returns 429 if you're doing too much of this request, with a Retry-After int value in the header.
|
||||
Returns 200 if successful
|
||||
```
|
||||
@@ -47,6 +49,7 @@ PUT /api/list/:channel_name/:video_id
|
||||
"userpass": USER_PASSWORD
|
||||
}
|
||||
|
||||
Returns 400 for bad request
|
||||
Returns 403 for bad authentication
|
||||
Returns 404 if the song doesnt exist
|
||||
Returns 409 if you've already voted on that song
|
||||
@@ -71,12 +74,103 @@ PUT /api/conf/:channel_name
|
||||
"userpass_changed": BOOLEAN (this must be true if you want to keep the userpassword you're sending)
|
||||
}
|
||||
|
||||
Returns 400 for bad request
|
||||
Returns 403 for bad authentication
|
||||
Returns 404 if the list doesn't exist
|
||||
Returns 429 if you're doing too much of this request, with a Retry-After int value in the header.
|
||||
Returns 200 and the newly added configuration if successful
|
||||
```
|
||||
|
||||
Get channelsettings
|
||||
```
|
||||
GET /api/conf/:channel_name/
|
||||
|
||||
Returns 403 for bad authentication (if you get this, try POST with userpassword attached)
|
||||
Returns 404 if the channel doesn't exist
|
||||
Returns 200 and the settings-object
|
||||
```
|
||||
|
||||
Get channelsettings (protected)
|
||||
```
|
||||
POST /api/conf/:channel_name/
|
||||
{
|
||||
"userpass": USERPASS
|
||||
}
|
||||
|
||||
Returns 400 for bad request
|
||||
Returns 403 for bad authentication
|
||||
Returns 404 if the channel doesn't exist
|
||||
Returns 200 and the settings-object
|
||||
```
|
||||
|
||||
Get song in channel
|
||||
```
|
||||
GET /api/list/:channel_name/
|
||||
|
||||
Returns 403 for bad authentication (if you get this, the channel is protected, try getting the full channel with POST, and search through the object)
|
||||
Returns 404 if the song doesn't exist
|
||||
Returns 200 and the song
|
||||
```
|
||||
|
||||
Get song in channel (protected)
|
||||
```
|
||||
// Important fetch_song is present, or else the request will try to add a song to the channel
|
||||
POST /api/list/:channel_name/
|
||||
{
|
||||
"fetch_song": ANYTHING_HERE,
|
||||
"userpass": USERPASS
|
||||
}
|
||||
|
||||
Returns 403 for bad authentication
|
||||
Returns 404 if the song doesn't exist
|
||||
Returns 200 and the song
|
||||
```
|
||||
|
||||
Get channelsettings
|
||||
```
|
||||
GET /api/list/:channel_name/
|
||||
|
||||
Returns 403 for bad authentication (if you get this, try POST with userpassword attached)
|
||||
Returns 404 if the channel doesn't exist
|
||||
Returns 200 and the objects in the channel
|
||||
```
|
||||
|
||||
Get channelsettings (protected)
|
||||
```
|
||||
POST /api/list/:channel_name/
|
||||
{
|
||||
"userpass": USERPASS
|
||||
}
|
||||
|
||||
Returns 400 for bad request
|
||||
Returns 403 for bad authentication
|
||||
Returns 404 if the channel doesn't exist
|
||||
Returns 200 and the objects in the channel
|
||||
```
|
||||
|
||||
Get now playing song
|
||||
```
|
||||
GET /api/list/:channel_name/__np__
|
||||
|
||||
Returns 400 for bad request
|
||||
Returns 403 for bad authentication (if you get this, try POST with userpassword attached)
|
||||
Returns 404 if the channel doesn't exist
|
||||
Returns 200 and the now playing object
|
||||
```
|
||||
|
||||
Get now playing song (protected)
|
||||
```
|
||||
POST /api/list/:channel_name/__np__
|
||||
{
|
||||
"userpass": USERPASS
|
||||
}
|
||||
|
||||
Returns 400 for bad request
|
||||
Returns 403 for bad authentication (if you get this, try POST with userpassword attached)
|
||||
Returns 404 if the channel doesn't exist
|
||||
Returns 200 and the now playing object
|
||||
```
|
||||
|
||||
Still to come: SKIP and SHUFFLE RESTApi calls..
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user