Is catalog item available
Get title availability
POST
https://ris.rightsline.com/v4/avails/is-title-available
This endpoint returns the availability for a single catalog item.
Headers
x-api-key
string
Your company's API key.
Authentication
string
Authentication token.
Request Body
recordId
integer
The ID of the catalog item
dim1
array
Array of type INTEGER
of desired dim1 values
dim2
array
Array of type INTEGER
of desired dim2 values
dim3
array
Array of type INTEGER
of desired dim3 values
dim4
array
Array of type INTEGER
of desired dim4 values
windowStart
string
yyyy-mm-dd format
windowEnd
string
yyyy-mm-dd format
matchType
string
CoverEntire, OverlapPart, StartWithin, EndWithin
isExact
boolean
True for if the window dates should match exactly, False for flexible
isExclusive
boolean
True for Exclusive, False for Non-Exclusive, null for no value
start
string
Record count start (0-based index)
rows
integer
Page result count (25 recommended)
An API call can be made to this endpoint with a JSON body containing the following parameters:
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 )
includeRecalcStatus
boolean
If true, a recalcStatus will be returned with the results
Optional ( defaults to false if not specifiec )
Example API call body:
Response
On a successful API call ( HTTP Status 200 ) the following information will be returned:
invalidRecordIds
int[]
List of catalog item IDs that are invalid from the request. The catalog item either does not exist or the API user does not have access to it.
isAvailable
boolean
True if the title is available
isExclusive
boolean
True if the title is exclusive
recalcStatus
string
Only returned if includeRecalc = true in the request. Returns 'calculating' If a recalculation of availabilities is currently underway, 'paused' if that recalculation has been paused, and 'calculated' if availability calculations are up to date.
Example API response:
Last updated