Is catalog item available
postGet title availability
post
https://api.rightsline.com/v3/avails/is-title-available
This endpoint returns the availability for a single catalog item.
Request
Response
Request
Headers
x-api-key
required
string
Your company's API key.
Authentication
required
string
Authentication token.
Body Parameters
recordId
required
integer
The ID of the catalog item
dim1
required
array
Array of type
INTEGER of desired dim1 valuesdim2
required
array
Array of type
INTEGER of desired dim2 valuesdim3
required
array
Array of type
INTEGER of desired dim3 valuesdim4
required
array
Array of type
INTEGER of desired dim4 valueswindowStart
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 of the catalog item.
{"isAvailable": true,"isExclusive": true}
{"recordId": 1288,"dim1": [2,3],"dim2": [1],"dim3": [4],"windowStart": "2018-12-22","windowEnd": "2019-12-22","isExclusive": true,"start": 0,"rows": 25}