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
number
entity id
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:
1
{
2
"recordId": [
3
      36816
4
  ], 
5
  "dim1": [],
6
  "dim2": [],
7
  "dim3": [],
8
  "dim4": [], 
9
  "windowStart": "2021-10-01", 
10
  "windowEnd": "2021-10-31",   
11
  "isExclusive": false,
12
  "matchType": "CoverEntire",
13
  "isExact": false,
14
  "start": 0,   
15
  "rows": 25
16
}
Copied!
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 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:
1
{
2
  "rowCount": 1,
3
  "rows": [
4
    {
5
      "lastUpdatedDate": "2021-10-05T22:41:58.467Z",
6
      "template": {
7
        "templateId": 19,
8
        "templateName": "Movie",
9
        "processId": 0,
10
        "processName": null
11
      },
12
      "status": {
13
        "statusId": 11,
14
        "statusName": "Approved"
15
      },
16
      "windowStart": "2021-10-01",
17
      "windowEnd": "2021-10-31",
18
      "dim1": [
19
        {
20
          "id": 6,
21
          "value": "SVOD - Sublicense",
22
          "xref": "SVOD"
23
        }
24
      ],
25
      "dim2": [
26
        {
27
          "id": 43,
28
          "value": "North America",
29
          "xref": null
30
        }
31
      ],
32
      "dim3": [
33
        {
34
          "id": 29,
35
          "value": "English",
36
          "xref": "en"
37
        }
38
      ],
39
      "dim4": null,
40
      "isExclusive": false,
41
      "isExact": false,
42
      "matchType": "CoverEntire",
43
      "available": "Partially",
44
      "reasonUnavailable": "Limited (Term)",
45
      "id": 36816,
46
      "title": "title"
47
    }
48
  ]
49
}
Copied!

AVAILS - Previous

Get dimension data

Next - AVAILS

Is catalog item available

Last modified 2mo ago

Copy link