# Availability request vs Rights Explorer

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.

{% tabs %}
{% tab title="Rights" %}

<figure><img src="https://2092511861-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8zuJdsrsd_MeaESXRx-3778137224%2Fuploads%2F136pYhDUgrOASiEe3CJQ%2Frightsexplorer_dates.png?alt=media&#x26;token=db467bfb-382b-436a-b4ff-7d5f3748ba8e" alt=""><figcaption><p>Rights Explorer - Rights</p></figcaption></figure>

| API field             | API type | Description                                                                                                           | Rights Explorer field             |
| --------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| 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                           |
| {% endtab %}          |          |                                                                                                                       |                                   |

{% tab title="Catalog" %}

<figure><img src="https://2092511861-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8zuJdsrsd_MeaESXRx-3778137224%2Fuploads%2FXb3gR38glI9La8wzvyNk%2Frightsexplorer_catalog.png?alt=media&#x26;token=d7f82d12-1677-4433-9f8c-2cdf02856b54" alt=""><figcaption><p>Rights Explorer - Catalog</p></figcaption></figure>

<table><thead><tr><th width="157">API field</th><th width="190">API type</th><th>Description</th><th>Rights Explorer field</th></tr></thead><tbody><tr><td>recordId</td><td>array</td><td>Array of type <code>INTEGER</code> of desired catalog items</td><td>Select Catalog</td></tr><tr><td>templateIds</td><td>array</td><td>(Optional) - If <code>recordId</code> parameter is not included in request, you can specify specific template IDs of the catalog items instead. Array of type <code>INTEGER</code>.</td><td>Catalog Template</td></tr><tr><td>statusIds</td><td>array</td><td>(Optional) - If <code>recordId</code> parameter is not included in request, you can specify specific status IDs of the catalog items instead. Array of type <code>INTEGER</code>.</td><td>Catalog Status</td></tr><tr><td>characteristics</td><td>Map&#x3C;string,string[]></td><td>(Optional) - A key-value object of catalog characteristics that must match in the result records.</td><td>[Characteristics listed out individually]</td></tr></tbody></table>

{% endtab %}

{% tab title="Other" %}

<figure><img src="https://2092511861-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8zuJdsrsd_MeaESXRx-3778137224%2Fuploads%2FGQjbgSdNxnmp2JmQp6Bj%2Frightsexplorer_avail-display.png?alt=media&#x26;token=444bb475-d7bb-4305-88f4-5d9df65bfcb8" alt=""><figcaption><p>Rights Explorer - Display</p></figcaption></figure>

<figure><img src="https://2092511861-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8zuJdsrsd_MeaESXRx-3778137224%2Fuploads%2FPN1vkChPxFHTpyTg8DvN%2Frightsexplorer_other.png?alt=media&#x26;token=ea5fa662-89d5-4984-96dc-6262d90c5fbe" alt=""><figcaption><p>Rights Explorer - Other</p></figcaption></figure>

<figure><img src="https://2092511861-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M8zuJdsrsd_MeaESXRx-3778137224%2Fuploads%2FurmzYXavwVmi6G49kEtC%2Frightsexplorer_scope.png?alt=media&#x26;token=d83724c8-8ad1-4a5b-9dae-e0d9727c3315" alt=""><figcaption><p>Rights Explorer - Scope</p></figcaption></figure>

<table><thead><tr><th width="198">API field</th><th>API type</th><th>Description</th><th>Rights Explorer field</th></tr></thead><tbody><tr><td>isExact</td><td>boolean</td><td>True for if the window dates should match exactly, False for flexible</td><td>Availability Display -> Fully Available / Partially Available</td></tr><tr><td>showUnavailable</td><td>boolean</td><td>Show unavailable avails</td><td>Availability Display -> Unavailable</td></tr><tr><td>includeUserFriendlyDimensionDisplay</td><td>boolean</td><td>List out all 4 dimension fields using Excluding format if applicable.</td><td>Exclusion Display</td></tr><tr><td>rightTemplateIds</td><td>array</td><td>(Optional) - Scope the results to specific rights templates. Array of type <code>INTEGER</code>.</td><td>Rights History</td></tr><tr><td>rightsActions</td><td>array</td><td>(Optional) - Apply the specific rights actions to the result.</td><td>Rights Actions Conditions</td></tr><tr><td>scopeExclusivity</td><td>boolean</td><td>(Optional) - Scope the results to Exclusivity.</td><td>Scope Dimensions to Search -> Exclusivity</td></tr><tr><td>scopeDimensions</td><td>array</td><td>(Optional) - Scope the results to specific rights dimensions. Array of type <code>INTEGER</code>.</td><td>Scope Dimensions to Search -> Media, Territory, Channel</td></tr></tbody></table>
{% endtab %}

{% tab title="API specific fields" %}

| API field     | API type | Description                        |
| ------------- | -------- | ---------------------------------- |
| start         | string   | Record count start (0-based index) |
| rows          | integer  | Page result count (25 recommended) |
| {% endtab %}  |          |                                    |
| {% endtabs %} |          |                                    |