Is catalog item available
post
https://ris.rightsline.com
/v4/avails/is-title-available
Get title 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 )
Example API call body:
1
{
2
"recordId": 1288,
3
"dim1": [2,3],
4
"dim2": [1],
5
"dim3": [4],
6
"windowStart": "2018-12-22",
7
"windowEnd": "2019-12-22",
8
}
Copied!
Response
On a successful API call ( HTTP Status 200 ) the following information will be returned:
Parameter
Type
Description
isAvailable
boolean
True if the title is available
isExclusive
boolean
True if the title is exclusive
Example API response:
1
{
2
"isAvailable": true,
3
"isExclusive": false
4
}
Copied!
Copy link