Get availability
Get availability
POST
https://ris.rightsline.com/v4/avails/availability
This endpoint returns the availability for the specified catalog-items for the given dimensions.
Headers
Request Body
{
"invalidCatalogIds": [],
"rowCount": 1,
"rows": [
{
"dim1": [
{
"id": 1,
"value": "All Media",
"xref": null
}
],
"dim2": [
{
"id": 1,
"value": "World",
"xref": null
}
],
"dim3": [
{
"id": 1,
"value": "All Languages",
"xref": null
}
],
"dim4": null,
"id": 111,
"isExclusive": true,
"lastUpdatedDate": "2018-09-20T11:20:20.260Z",
"status": {
"statusId": 1,
"statusName": "Approved"
},
"template": {
"fields": [],
"processId": 0,
"processName": null,
"templateId": 1,
"templateName": "Series"
},
"title": "Title 111",
"windowEnd": "2018-09-24",
"windowStart": "2018-09-01"
}
]
}
{
"invalidCatalogIds": [999,1800],
"rowCount": 1,
"rows": [
{
"dim1": [
{
"id": 1,
"value": "All Media",
"xref": null
}
],
"dim2": [
{
"id": 1,
"value": "World",
"xref": null
}
],
"dim3": [
{
"id": 1,
"value": "All Languages",
"xref": null
}
],
"dim4": null,
"id": 111,
"isExclusive": true,
"lastUpdatedDate": "2018-09-20T11:20:20.260Z",
"status": {
"statusId": 1,
"statusName": "Approved"
},
"template": {
"fields": [],
"processId": 0,
"processName": null,
"templateId": 1,
"templateName": "Series"
},
"title": "Title 111",
"windowEnd": "2018-09-24",
"windowStart": "2018-09-01"
}
]
}
An API call can be made to this endpoint with a JSON body containing the following parameters:
Example API call body:
{
"recordId": [
36816
],
"dim1": [],
"dim2": [],
"dim3": [],
"dim4": [],
"windowStart": "2021-10-01",
"windowEnd": "2021-10-31",
"isExclusive": false,
"matchType": "CoverEntire",
"isExact": false,
"start": 0,
"rows": 25
}
Response
On a successful API call ( HTTP Status 200 ) the following information will be returned:
Availability Object
Template Data
Status Data
Dimension Data
Example API response:
{
"invalidRecordIds": [],
"rowCount": 1,
"rows": [
{
"lastUpdatedDate": "2021-10-05T22:41:58.467Z",
"template": {
"templateId": 19,
"templateName": "Movie",
"processId": 0,
"processName": null
},
"status": {
"statusId": 11,
"statusName": "Approved"
},
"windowStart": "2021-10-01",
"windowEnd": "2021-10-15",
"dim1": [
{
"id": 6,
"value": "SVOD - Sublicense",
"xref": "SVOD"
}
],
"dim2": [
{
"id": 43,
"value": "North America",
"xref": null
}
],
"dim3": [
{
"id": 29,
"value": "English",
"xref": "en"
}
],
"dim4": null,
"isExclusive": false,
"isExact": false,
"matchType": "CoverEntire",
"available": "Partially",
"reasonUnavailable": "Limited (Term)",
"id": 36816,
"title": "title"
}
]
}
Last updated