Get availability
post
https://ris.rightsline.com
/v4/avails/availability
Get availability
An API call can be made to this endpoint with a JSON body containing the following parameters:
Parameter | Type | Description | Required/Optional |
|---|---|---|---|
recordId | array of numbers | entity ids | Required |
dim1 | array of numbers | Dimension Values | Optional |
dim2 | array of numbers | Dimension Values | Optional |
dim3 | array of numbers | Dimension Values | Optional |
dim4 | array of numbers | Dimension Values | Optional |
windowStart | string | YYYY-MM-DD | Required |
windowEnd | string | YYYY-MM-DD | Required |
isExclusive | boolean | exclusive title flag | Optional ( defaults to true if not specified ) |
matchType | fixed string values | Valid Values: CoverEntire OverlapPart StartWithin EndWithin | Required |
isExact | boolean | exact matches | Optional ( defaults to true if not specified ) |
isWindowingEnforced | boolean | enforce windowing | Optional ( defaults to false if not specified ) |
showUnavailable | boolean | show unavailable avails | Optional ( defaults to false if not specified ) |
start | number | start return row ( for pagination ) | Required |
rows | number | number of rows to return ( for pagination ) | Required |
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:
Parameter | Type | Description |
|---|---|---|
invalidRecordIds | int[] | A list of catalog item IDs from the request that are invalid. The catalog either does not exist or the API user does not have access to it. |
rowCount | int | number of rows returned |
rows | array of availability objects ( see table below) | availability data |
Availability Object
Parameter | Type | Description |
|---|---|---|
LastUpdatedDate | string | Last update 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 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:
{
"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-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 11d ago