Get availability

post
Get availability

https://api.rightsline.com/v3/avails/availability
This endpoint returns the availability for the specified catalog-items for the given dimensions.
Request
Response
Request
Headers
x-api-key
required
string
Your company's API key.
Authentication
required
string
Authentication token.
Body Parameters
recordId
required
array
Array of type INTEGER of desired catalog items
dim1
required
array
Array of type INTEGER of desired dim1 values
dim2
required
array
Array of type INTEGER of desired dim2 values
dim3
required
array
Array of type INTEGER of desired dim3 values
dim4
required
array
Array of type INTEGER of desired dim4 values
windowStart
required
string
yyyy-mm-dd format
windowEnd
required
string
yyyy-mm-dd format
matchType
optional
string
CoverEntire, OverlapPart, StartWithin, EndWithin
isExact
optional
boolean
True for if the window dates should match exactly, False for flexible
isExclusive
required
boolean
True for Exclusive, False for Non-Exclusive, null for no value
start
required
string
Record count start (0-based index)
rows
required
integer
Page result count (25 recommended)
Response
200: OK
The availability for the requested catalog items.
{
"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"
}
]
}

‚Äč