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.
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