Get availability
Get availability
POST
https://ris.rightsline.com/v4/avails/availability
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 |
---|---|---|
recordId | array | Array of type |
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) |
isWindowingEnforced | boolean | Enforce windowing |
showUnavailable | boolean | Show unavailable avails |
An API call can be made to this endpoint with a JSON body containing the following parameters:
Parameter | Type | Description | Required/Optional |
---|---|---|---|
recordId | array of numbers | entity ids | 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 ) |
matchType | fixed string values | Valid Values: CoverEntire OverlapPart StartWithin EndWithin | Required |
isExact | boolean | exact matches | Optional ( defaults to true if not specified ) |
isWindowingEnforced | boolean | enforce windowing | Optional ( defaults to false if not specified ) |
showUnavailable | boolean | show unavailable avails | Optional ( defaults to false if not specified ) |
start | number | start return row ( for pagination ) | Required |
rows | number | number of rows to return ( for pagination ) | Required |
truncateDatesToSearch | boolean | If true, the windowStart and windowEnd in the response will be truncated to the dates in the request | Optional ( defaults to false if not specified ) |
includeRecalcStatus | boolean | If true, a recalcStatus will be returned with the results | Optional (defaults to false if not specified ) |
Example API call body:
Response
On a successful API call ( HTTP Status 200 ) the following information will be returned:
Parameter | Type | Description |
---|---|---|
invalidRecordIds | int[] | A list of catalog item IDs from the request that are invalid. The catalog either does not exist or the API user does not have access to it. |
rowCount | int | number of rows returned |
rows | array of availability objects ( see table below) | availability data |
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. |
Availability Object
Parameter | Type | Description |
---|---|---|
LastUpdatedDate | string | Last update date / time |
Template | template data ( see table below ) | Template data structure |
Status | status data ( see table below ) | Status data structure |
WindowStart | YYYY-MM-DD | Start window date |
WindowEnd | YYYY-MM-DD | End window date |
Dim1 | array of char data data ( see table below ) | Dimension 1 data |
Dim2 | array of char data ( see table below ) | Dimension 2 data |
Dim3 | array of char data ( see table below ) | Dimension 3 data |
Dim4 | array of char data ( see table below ) | Dimension 4 data |
IsExclusive | bool | Flag for exclusivity |
IsExact | bool | Flag for exact match |
Available | string | Available status |
ReasonUnavailable | string | Reason if unavailable |
Template Data
Parameter | Type | Description |
---|---|---|
templateId | number | Template identifier |
templateName | string | Template name |
processId | number | Process identifier |
processName | string | Process name |
Status Data
Parameter | Type | Description |
---|---|---|
statusId | number | Status identifier |
statusName | string | Status name |
Dimension Data
Parameter | Type | Description |
---|---|---|
id | number | Identifier |
value | string | Dimension Value |
xref | string | Dimension Cross Reference Value |
Example API response:
Last updated