Item Status
The item status api allows you to check the status of projects/playlists/clips.
Actions
|
Read item status |
POST |
/api/item_status |
body: { "project_ids": ["1"], "playlist_ids": ["2"], "clip_ids": ["3"] } |
Possible states
State |
Description |
visible |
User has access permission |
missing |
Item does not exist |
no_permission |
User does not have permission to access item |
ended (project only) |
Project has ended |
Example request
Example:
POST /api/item_status HTTP/1.1
{ "project_ids": ["1"],
"playlist_ids": ["2"],
"clip_ids": ["3"] }
Curl Example:
curl -X POST \
https://medel.webgate.io/api/item_status \
-H 'authorization: Bearer example-token' \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-d '{ "project_ids": ["1"], "playlist_ids": ["2"], "clip_ids": ["3"] }'
Successful Response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": 200,
"status_message": "OK",
"info": "",
"data": {
"hash": {
"projects": {
"1": {
"status": "ended",
"name": "expired project"
}
},
"playlists": {
"2": {
"status": "visible",
"name": "a playlist"
}
},
"clips": {
"3": {
"status": "missing",
"name": "a clip"
}
}
}
}
}