Availability request vs Rights Explorer
Last updated
Last updated
The Availability API request is meant to provide catalog availability results that mimic the Rights Explorer in the Rightsline application. Listed below are the fields of the API Availability request and the corresponding fields in Rights Explorer.
| API field | API type | Description | Rights Explorer field |
|---|---|---|---|
| API field | API type | Description | Rights Explorer field |
|---|---|---|---|
| API field | API type | Description | Rights Explorer field |
|---|---|---|---|
| API field | API type | Description |
|---|---|---|
recordId
array
Array of type INTEGER of desired catalog items
Select Catalog
templateIds
array
(Optional) - If recordId parameter is not included in request, you can specify specific template IDs of the catalog items instead. Array of type INTEGER.
Catalog Template
statusIds
array
(Optional) - If recordId parameter is not included in request, you can specify specific status IDs of the catalog items instead. Array of type INTEGER.
Catalog Status
characteristics
Map<string,string[]>
(Optional) - A key-value object of catalog characteristics that must match in the result records.
[Characteristics listed out individually]
isExact
boolean
True for if the window dates should match exactly, False for flexible
Availability Display -> Fully Available / Partially Available
showUnavailable
boolean
Show unavailable avails
Availability Display -> Unavailable
includeUserFriendlyDimensionDisplay
boolean
List out all 4 dimension fields using Excluding format if applicable.
Exclusion Display
rightTemplateIds
array
(Optional) - Scope the results to specific rights templates. Array of type INTEGER.
Rights History
rightsActions
array
(Optional) - Apply the specific rights actions to the result.
Rights Actions Conditions
scopeExclusivity
boolean
(Optional) - Scope the results to Exclusivity.
Scope Dimensions to Search -> Exclusivity
scopeDimensions
array
(Optional) - Scope the results to specific rights dimensions. Array of type INTEGER.
Scope Dimensions to Search -> Media, Territory, Channel
start
string
Record count start (0-based index)
rows
integer
Page result count (25 recommended)
windowStart
string
yyyy-mm-dd format
Dates -> Start Date
windowEnd
string
yyyy-mm-dd format
Dates -> End Date
minWindowDays
integer
(Optional) - The minimum availability window in days.
Dates -> Minimum Window (in Days)
matchType
string
CoverEntire, OverlapPart, StartWithin, EndWithin
Dates -> Availability Windows
truncateDatesToSearch
boolean
True to truncate start and end dates in result to windowStart and windowEnd date parameters, False for entire window.
Dates -> Truncate Dates To Search
isExclusive
boolean
True for Exclusive, False for Non-Exclusive, null for no value
Exclusivity
rollupDimId
integer
(Optional) - The rights dimension to rollup.
Rollup
dim1
array
Array of type INTEGER of desired dim1 values
Media
dim2
array
Array of type INTEGER of desired dim2 values
Territory
dim3
array
Array of type INTEGER of desired dim3 values
Language
dim4
array
Array of type INTEGER of desired dim4 values
Channel
