Purpose
Allow for searching entitlements during account anonymization.
The use of the term product in this document is derived from the Entitlements system and has no relation to Axis products.
Get Entitlements
GET /axis/entitlements/v1/search/options
Get a list of entitlements values and localized text.
Request URL Parameters
No parameters are sent.
Response
HTTP 200
Returns a list of supported entitlements.
{
"success": true,
"message": null,
"item": {
"products": [{
"name": "ESPNPLUS",
"statuses": [{
"name": "Anonymize Rejected",
"key": "ANONYMIZE_REJECTED"
}, {
"name": "Delete Requested",
"key": "DELETE_REQUESTED"
}],
"entitlements": [{
"name": "ESPN_PLUS_MLB"
}]
}]
}
}
The Entitlement model is as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | yes | The product description. |
| statuses | Array | yes | The list of status for the product. |
| entitlements | Array | yes | The list of entitlements for the product. |
The Status model is as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | yes | The localized status description. |
| key | String | yes | The status enum value. |
The Entitlement model is as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | yes | The localized entitlement description. |
HTTP 401
Indicates the user is not logged in
HTTP 403
Indicates the user is logged in but not permitted to access newsletter details
HTTP 500
Indicates there was an internal server error
Search Entitlements
GET /axis/entitlements/v1/search
Search for entitlements based on a given criteria.
Request URL Parameters
| Name | Type | Description |
|---|---|---|
| product | string | The key of the product the account is associated with |
| status | string | The status value. |
| entitlement | string | The source asset name. |
Response
HTTP 200
Returns a list of accounts with entitlements.
{
"success": true,
"message": null,
"items": [{
"accountId": "{XXX-XXXX-XXXX-XXXX-XXX}",
"status": "ANONYMIZE_REJECTED",
"product": "disneyid",
"entitlement": "ESPN_INSIDER",
"statusModifiedAt": 123456789,
"effectiveDate": 123456789,
"expirationTime": 123456789
}, {
"accountId": "{XXX-XXXX-XXXX-XXXX-XXX}",
"status": "ANONYMIZE_REJECTED",
"product": "disneyid",
"entitlement": "ESPN_INSIDER",
"statusModifiedAt": 123456789,
"effectiveDate": 123456789,
"expirationTime": 123456789
}],
"count": 2
}
The entitlement search result model is as follows:
| Name | Type | Required | Description |
|---|---|---|---|
| accountId | String | yes | The account SWID |
| status | String | yes | The status key. |
| product | String | yes | The key of the product the account is associated with |
| entitlement | String | no | The source asset name. |
| statusModifiedAt | Number | no | Status modified timestamp |
| effectiveDate | Number | no | |
| expirationTime | Number | no |
HTTP 401
Indicates the user is not logged in
HTTP 403
Indicates the user is logged in but not permitted to access newsletter details
HTTP 500
Indicates there was an internal server error