SongbookStatus
Used to get the status of an in progress songbook action. When FINISHED, will contain the url of the songbook.
Example Object
{
"type": "SongbookStatus",
"id": "1",
"attributes": {
"status": "string",
"status_code": "string",
"status_token": "string",
"url": "string"
},
"relationships": {}
}
Attributes
| Name |
Type |
Description |
id |
primary_key |
|
status |
string |
|
status_code |
string |
|
status_token |
string |
|
url |
string |
|
Pagination
| Name |
Parameter |
Type |
Description |
| per_page |
per_page |
integer |
how many records to return per page (min=1, max=100, default=25) |
| offset |
offset |
integer |
get results from given offset |
Endpoints
Listing
| HTTP Method |
Endpoint |
| GET |
/services/v2 |
Reading
| HTTP Method |
Endpoint |
| GET |
/services/v2/{id} |