Get available catalog items
Get available catalog items
POST
https://ris.rightsline.com/v4/avails/available-catalog-items
This endpoint returns the availability for the specified catalog-items for the given dimensions.
Headers
Name | Type | Description |
---|---|---|
x-api-key | string | Your company's API key. |
Authentication | string | Authentication token. |
Request Body
Name | Type | Description |
---|---|---|
dim1* | array | Array of type |
dim2* | array | Array of type |
dim3* | array | Array of type |
dim4* | array | Array of type |
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) |
characteristics | object | Filter by specific LOV characteristic values on the catalog-item. |
templateIds | array | Array of type |
statusIds | array | Array of type |
rightTemplateIds | array | Array of type |
includeRecalcStatus | boolean | If true, a recalcStatus will be returned with the results. Defaults to false. |
Example API request body
The characteristics field allows you to filter the catalog items in the response that contain a specific value or group of values for a given characteristic. In the example request above, only catalog items that have a genre value of Adventure will be returned in the response.
Example API response
Last updated