Get available catalog items
post
https://ris.rightsline.com
/v4/avails/available-catalog-items
Get available catalog items
Example API call body:
{
"dim1": [6],
"dim2": [43],
"dim3": [29],
"dim4": [],
"windowStart": "2021-10-01",
"windowEnd": "2021-10-31",
"isExclusive": false,
"matchType": "CoverEntire",
"isExact": false,
"start": 0,
"rows": 25,
"templateIds": [1,2],
"statusIds": [1],
"characteristics":{
"genre":["Adventure"]
},
"rightTemplateIds":[2,4]
}
The characteristics field allows you to filter the catalog items in the response that contain a specific value or group of values for a given characteristic. In the example request above, only catalog items that have a genre value of Adventure will be returned in the response.
Response
On a successful API call (HTTP Status 200) the following information will be returned:
Parameter | Type | Description |
|---|---|---|
rowCount | number | number of rows returned |
rows | array of availability objects (see table below) | availability data |
Availability Object
Parameter | Type | Description |
|---|---|---|
LastUpdatedDate | string | Last updated date / time |
Template | template data (see table below) | Template data structure |
Status | status data (see table below) | Status data structure |
WindowStart | YYYY-MM-DD | Start window date |
WindowEnd | YYYY-MM-DD | End window date |
Dim1 | array of char data (see table below) | Dimension 1 data |
Dim2 | array of char data (see table below) | Dimension 2 data |
Dim3 | array of char data (see table below) | Dimension 3 data |
Dim4 | array of char data (see table below) | Dimension 4 data |
IsExclusive | bool | Flag for exclusivity |
IsExact | bool | Flag for exact match |
Available | string | Available status |
ReasonUnavailable | string | Reason, if unavailable |
Template Data
Parameter | Type | Description |
|---|---|---|
templateId | number | Template identifier |
templateName | string | Template name |
processId | number | Process identifier |
processName | string | Process name |
Status Data
Parameter | Type | Description |
|---|---|---|
statusId | number | Status identifier |
statusName | string | Status name |
Dimension Data
Parameter | Type | Description |
|---|---|---|
id | number | Identifier |
value | string | Dimension Value |
xref | string | Dimension Cross Reference Value |
Example API response:
{
"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-31",
"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 modified 1mo ago