Rights Locker API API documentation
https://rl.ooyala.com/v2/
Description
Rights Locker (Warden) is the service we use for storing user specific data. We have a set of APIs that can be used to manage entitlements, devices, and concurrent streaming.
/pcode/{pcode}/account_id/{account_id}/limit/{limit}
Modify concurrent streams {limit} for specific {account_id} of a provider identified by {pcode}
Modify Max Concurrent Streams limit for a User It will overwrite the current concurrent stream {limit} for a specific {account_id} of a provider identified by {pcode}
post /pcode/{pcode}/account_id/{account_id}/limit/{limit}
Modify Max Concurrent Streams limit for a User It will overwrite the current concurrent stream {limit} for a specific {account_id} of a provider identified by {pcode}
URI Parameters
-
account_id: required (string)
Account ID
Example:
testAccount
-
pcode: required (string)
Provider Code
Example:
199999
-
limit: required (integer)
Limit
Example:
3
HTTP status code 200
OK
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"message": {
"$id": "/properties/message",
"type": "string",
"title": "Message",
"default": "",
"examples": [
"OK"
]
}
}
}
Example:
{
"message": "OK"
}
HTTP status code 400
Bad Request
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"message": {
"$id": "/properties/message",
"type": "string",
"title": "Message",
"default": "",
"examples": [
"max_concurrent_streams limit should be a number"
]
}
}
}
Example:
{
"message": "max_concurrent_streams limit should be a number"
}
HTTP status code 500
Internal Server Error
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"message": {
"$id": "/properties/message",
"type": "string",
"title": "Message",
"default": "",
"examples": [
"Read-only database"
]
}
}
}
Example:
{
"message": "Read-only database"
}
/pcode/{pcode}/account_id/{account_id}/limit
Remove Concurrent Stream limit for specific {account_id} of a provider identified by {pcode}
Remove Max Concurrent Streams limit for a User
delete /pcode/{pcode}/account_id/{account_id}/limit
Remove Max Concurrent Streams limit for a User
URI Parameters
-
account_id: required (string)
Account ID
Example:
testAccount
-
pcode: required (string)
Provider Code
Example:
199999
HTTP status code 200
OK
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"message": {
"$id": "/properties/message",
"type": "string",
"title": "Message",
"default": "",
"examples": [
"OK"
]
}
}
}
Example:
{
"message": "OK"
}
/pcode/{pcode}/account_id/{account_id}
Create, retrieve, update and delete limits on categories for specific {account_id} of a provider identifed by {pcode}
Set category limits for a User It will overwrite the categories associated with a specific {account_id} To edit the categories, use PATCH route To delete all limits, use DELETE route
Edit category limits for a User It will update the limits for existing categories of a specific {account_id} Any other categories not included will remain unchanged
Get category limits for a User It will retrieve the list of the limits for every category associated with a specific {account_id}
Delete category limits for a User It will delete the categories associated with a specific {account_id}
post /pcode/{pcode}/account_id/{account_id}
Set category limits for a User It will overwrite the categories associated with a specific {account_id} To edit the categories, use PATCH route To delete all limits, use DELETE route
URI Parameters
-
account_id: required (string)
Account ID
Example:
testAccount
-
pcode: required (string)
Provider Code
Example:
199999
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"users": {
"$id": "/properties/users",
"type": "array",
"items": {
"$id": "/properties/users/items",
"type": "string",
"title": "categories",
"default": "",
"examples": [
"cat1",
"cat2",
"cat3"
]
}
}
}
}
Example:
{
"categories": [
"cat1",
"cat2",
"cat3"
]
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"message": {
"$id": "/properties/message",
"type": "string",
"title": "Message",
"default": "",
"examples": [
"OK"
]
}
}
}
Example:
{
"message": "OK"
}
patch /pcode/{pcode}/account_id/{account_id}
Edit category limits for a User It will update the limits for existing categories of a specific {account_id} Any other categories not included will remain unchanged
URI Parameters
-
account_id: required (string)
Account ID
Example:
testAccount
-
pcode: required (string)
Provider Code
Example:
199999
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"users": {
"$id": "/properties/users",
"type": "array",
"items": {
"$id": "/properties/users/items",
"type": "string",
"title": "categories",
"default": "",
"examples": [
"cat1",
"cat2",
"cat3"
]
}
}
}
}
Example:
{
"categories": [
"cat1",
"cat2",
"cat3"
]
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"message": {
"$id": "/properties/message",
"type": "string",
"title": "Message",
"default": "",
"examples": [
"OK"
]
}
}
}
Example:
{
"message": "OK"
}
get /pcode/{pcode}/account_id/{account_id}
Get category limits for a User It will retrieve the list of the limits for every category associated with a specific {account_id}
URI Parameters
-
account_id: required (string)
Account ID
Example:
testAccount
-
pcode: required (string)
Provider Code
Example:
199999
HTTP status code 200
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"users": {
"$id": "/properties/users",
"type": "array",
"items": {
"$id": "/properties/users/items",
"type": "string",
"title": "categories",
"default": "",
"examples": [
"cat1",
"cat2",
"cat3"
]
}
}
}
}
Example:
{
"categories": [
"cat1",
"cat2",
"cat3"
]
}
delete /pcode/{pcode}/account_id/{account_id}
Delete category limits for a User It will delete the categories associated with a specific {account_id}
URI Parameters
-
account_id: required (string)
Account ID
Example:
testAccount
-
pcode: required (string)
Provider Code
Example:
199999
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"users": {
"$id": "/properties/users",
"type": "array",
"items": {
"$id": "/properties/users/items",
"type": "string",
"title": "categories",
"default": "",
"examples": [
"cat1",
"cat2",
"cat3"
]
}
}
}
}
Example:
{
"categories": [
"cat1",
"cat2",
"cat3"
]
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"message": {
"$id": "/properties/message",
"type": "string",
"title": "Message",
"default": "",
"examples": [
"OK"
]
}
}
}
Example:
{
"message": "OK"
}
/providers/{pcode}/accounts/{account_id}/content
Interact with specific {account_id} entitlements
Get all entitlements for a specific {account_id}
Remove all {account_id} entitlements
Create an entitlement with identifiers for labels and publishing rules in the POST body. If the unique combination of {label_id}, {user_id} and {external_product_id} matches an existing entitlement, it will be updated.
get /providers/{pcode}/accounts/{account_id}/content
Get all entitlements for a specific {account_id}
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
account_id: required (string)
Account ID
Example:
accessTest
Query Parameters
-
api_key: (string)
API Key (optional)
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm4rCv
HTTP status code 200
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"pcode": {
"$id": "/properties/pcode",
"type": "string",
"title": "Pcode",
"default": "",
"examples": [
"EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm"
]
},
"account_id": {
"$id": "/properties/account_id",
"type": "string",
"title": "Account_id",
"default": "",
"examples": [
"accessTest"
]
},
"content": {
"$id": "/properties/content",
"type": "object",
"properties": {
"assets": {
"$id": "/properties/content/properties/assets",
"type": "array",
"items": {
"$id": "/properties/content/properties/assets/items",
"type": "object",
"properties": {
"content_id": {
"$id": "/properties/content/properties/assets/items/properties/content_id",
"type": "string",
"title": "Content_id",
"default": "",
"examples": [
"123"
]
},
"updated_at": {
"$id": "/properties/content/properties/assets/items/properties/updated_at",
"type": "string",
"title": "Updated_at",
"default": "",
"examples": [
"2018-07-03T19:40:51+00:00"
]
},
"publishing_rule_id": {
"$id": "/properties/content/properties/assets/items/properties/publishing_rule_id",
"type": "null",
"title": "Publishing_rule_id",
"default": null,
"examples": [
null
]
},
"external_product_id": {
"$id": "/properties/content/properties/assets/items/properties/external_product_id",
"type": "string",
"title": "External_product_id",
"default": "",
"examples": [
"123"
]
}
}
}
},
"assets_offline": {
"$id": "/properties/content/properties/assets_offline",
"type": "array",
"items": {
"$id": "/properties/content/properties/assets_offline/items",
"type": "object",
"properties": {
"content_id": {
"$id": "/properties/content/properties/assets_offline/items/properties/content_id",
"type": "string",
"title": "Content_id",
"default": "",
"examples": [
"assetOffline"
]
},
"updated_at": {
"$id": "/properties/content/properties/assets_offline/items/properties/updated_at",
"type": "string",
"title": "Updated_at",
"default": "",
"examples": [
"2018-07-09T14:40:09+00:00"
]
},
"publishing_rule_id": {
"$id": "/properties/content/properties/assets_offline/items/properties/publishing_rule_id",
"type": "null",
"title": "Publishing_rule_id",
"default": null,
"examples": [
null
]
},
"external_product_id": {
"$id": "/properties/content/properties/assets_offline/items/properties/external_product_id",
"type": "string",
"title": "External_product_id",
"default": "",
"examples": [
"default"
]
}
}
}
},
"labels": {
"$id": "/properties/content/properties/labels",
"type": "array",
"items": {
"$id": "/properties/content/properties/labels/items",
"type": "object",
"properties": {
"content_id": {
"$id": "/properties/content/properties/labels/items/properties/content_id",
"type": "string",
"title": "Content_id",
"default": "",
"examples": [
"labelTest"
]
},
"updated_at": {
"$id": "/properties/content/properties/labels/items/properties/updated_at",
"type": "string",
"title": " Updated_at",
"default": "",
"examples": [
"2018-07-09T12:09:13+00:00"
]
},
"publishing_rule_id": {
"$id": "/properties/content/properties/labels/items/properties/publishing_rule_id",
"type": "null",
"title": "Publishing_rule_id",
"default": null,
"examples": [
null
]
},
"external_product_id": {
"$id": "/properties/content/properties/labels/items/properties/external_product_id",
"type": "string",
"title": "External_product_id",
"default": "",
"examples": [
"default"
]
}
}
}
},
"labels_offline": {
"$id": "/properties/content/properties/labels_offline",
"type": "array",
"items": {
"$id": "/properties/content/properties/labels_offline/items",
"type": "object",
"properties": {
"content_id": {
"$id": "/properties/content/properties/labels_offline/items/properties/content_id",
"type": "string",
"title": "Content_id",
"default": "",
"examples": [
"labelOffline"
]
},
"updated_at": {
"$id": "/properties/content/properties/labels_offline/items/properties/updated_at",
"type": "string",
"title": "Updated_at",
"default": "",
"examples": [
"2018-07-09T12:56:53+00:00"
]
},
"publishing_rule_id": {
"$id": "/properties/content/properties/labels_offline/items/properties/publishing_rule_id",
"type": "null",
"title": "Publishing_rule_id",
"default": null,
"examples": [
null
]
},
"external_product_id": {
"$id": "/properties/content/properties/labels_offline/items/properties/external_product_id",
"type": "string",
"title": "External_product_id",
"default": "",
"examples": [
"default"
]
}
}
}
}
}
}
}
}
Example:
{
"pcode": "EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm",
"account_id": "accessTest",
"content": {
"assets": [
{
"content_id": "123",
"updated_at": "2018-07-03T19:40:51+00:00",
"publishing_rule_id": null,
"external_product_id": "123"
},
{
"content_id": "hwb21vZjE6qeQ2eAWts1YwWGKPojdhTA",
"updated_at": "2018-07-03T17:14:54+00:00",
"publishing_rule_id": "160bb50dcdd04faa8ddee0db68516a81",
"external_product_id": "default",
"num_devices_to_bind": 2
},
{
"content_id": "newAsset",
"updated_at": "2018-07-09T14:56:20+00:00",
"publishing_rule_id": "publishing_rule",
"external_product_id": "default",
"start_time": "2018-06-09T09:40:35+00:00",
"end_time": "2020-06-09T09:40:35+00:00"
},
{
"content_id": "UwODEzYjE6C0MFx3rEfkl_QQ3_wbdlGG",
"updated_at": "2018-04-19T17:24:13+00:00",
"publishing_rule_id": null,
"external_product_id": "defult",
"num_devices_to_bind": 1
}
],
"assets_offline": [
{
"content_id": "assetOffline",
"updated_at": "2018-07-09T14:40:09+00:00",
"publishing_rule_id": null,
"external_product_id": "default"
}
],
"labels": [
{
"content_id": "labelTest",
"updated_at": "2018-07-09T12:09:13+00:00",
"publishing_rule_id": null,
"external_product_id": "default"
}
],
"labels_offline": [
{
"content_id": "labelOffline",
"updated_at": "2018-07-09T12:56:53+00:00",
"publishing_rule_id": null,
"external_product_id": "default"
}
]
}
}
HTTP status code 403
Forbidden
Body
Type: application/json
Example:
Unauthorized api_key
HTTP status code 404
Not Found
delete /providers/{pcode}/accounts/{account_id}/content
Remove all {account_id} entitlements
post /providers/{pcode}/accounts/{account_id}/content
Create an entitlement with identifiers for labels and publishing rules in the POST body. If the unique combination of {label_id}, {user_id} and {external_product_id} matches an existing entitlement, it will be updated.
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
account_id: required (string)
Account ID
Example:
accessTest
Body
Type: application/json
Example:
{
"assets":[
{
"content_id":"newAsset",
"publishing_rule_id":"publishing_rule",
"external_product_id":"default",
"start_time":"2018-06-9T09:40:35+00:00",
"end_time":"2020-06-9T09:40:35+00:00"
}
]
}
/providers/{pcode}/accounts/{account_id}/content/assets/{asset_id}/external_products/{external_product_id}
Interact with specific {asset_id} entitlements
/providers/{pcode}/accounts/{account_id}/content/assets/{asset_id}/external_products/{external_product_id} get delete
Get entitlements for a specific {asset_id}
Remove {account_id} entitlements to content identified by {asset_id}
get /providers/{pcode}/accounts/{account_id}/content/assets/{asset_id}/external_products/{external_product_id}
Get entitlements for a specific {asset_id}
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
account_id: required (string)
Account ID
Example:
accessTest
-
asset_id: required (string)
Asset ID
Example:
rsda8XoRTy0esRlgCxqjGZ3vFcWgXa0l
-
external_product_id: required (string)
External Product ID
Example:
default
Query Parameters
-
api_key: (string)
API Key (optional)
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm4rCv
HTTP status code 200
Body
Type: application/json
Example:
{
"pcode": "EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm",
"account_id": "accessTest",
"content": {
"assets": [
{
"content_id": "hwb21vZjE6qeQ2eAWts1YwWGKPojdhTA",
"updated_at": "2018-07-03T17:14:54+00:00",
"publishing_rule_id": "160bb50dcdd04faa8ddee0db68516a81",
"external_product_id": "default",
"num_devices_to_bind": 2
}
]
}
}
HTTP status code 403
Forbidden
Body
Type: application/json
Example:
Unauthorized api_key
HTTP status code 404
Not Found
delete /providers/{pcode}/accounts/{account_id}/content/assets/{asset_id}/external_products/{external_product_id}
Remove {account_id} entitlements to content identified by {asset_id}
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
account_id: required (string)
Account ID
Example:
accessTest
-
asset_id: required (string)
Asset ID
Example:
rsda8XoRTy0esRlgCxqjGZ3vFcWgXa0l
-
external_product_id: required (string)
External Product ID
Example:
default
/providers/{pcode}/accounts/{account_id}/content/labels/{label_id}/external_products/{external_product_id}
Interact with specific {label_id} entitlements
/providers/{pcode}/accounts/{account_id}/content/labels/{label_id}/external_products/{external_product_id} get delete
Get entitlements for a specific {label_id}
Remove {account_id} entitlements to content identified by {label_id}
get /providers/{pcode}/accounts/{account_id}/content/labels/{label_id}/external_products/{external_product_id}
Get entitlements for a specific {label_id}
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
account_id: required (string)
Account ID
Example:
accessTest
-
label_id: required (string)
Label ID
Example:
labelTest
-
external_product_id: required (string)
External Product ID
Example:
default
Query Parameters
-
api_key: (string)
API Key (optional)
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm4rCv
HTTP status code 200
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"pcode": {
"$id": "/properties/pcode",
"type": "string",
"title": "Pcode",
"default": "",
"examples": [
"EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm"
]
},
"account_id": {
"$id": "/properties/account_id",
"type": "string",
"title": "Account_id",
"default": "",
"examples": [
"accessTest"
]
},
"content": {
"$id": "/properties/content",
"type": "object",
"properties": {
"labels": {
"$id": "/properties/content/properties/labels",
"type": "array",
"items": {
"$id": "/properties/content/properties/labels/items",
"type": "object",
"properties": {
"content_id": {
"$id": "/properties/content/properties/labels/items/properties/content_id",
"type": "string",
"title": "Content_id",
"default": "",
"examples": [
"labelTest"
]
},
"updated_at": {
"$id": "/properties/content/properties/labels/items/properties/updated_at",
"type": "string",
"title": "Updated_at",
"default": "",
"examples": [
"2018-07-09T12:09:13+00:00"
]
},
"publishing_rule_id": {
"$id": "/properties/content/properties/labels/items/properties/publishing_rule_id",
"type": "null",
"title": "Publishing_rule_id",
"default": null,
"examples": [
null
]
},
"external_product_id": {
"$id": "/properties/content/properties/labels/items/properties/external_product_id",
"type": "string",
"title": "External_product_id",
"default": "",
"examples": [
"default"
]
}
}
}
}
}
}
}
}
Example:
{
"pcode": "EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm",
"account_id": "accessTest",
"content": {
"labels": [
{
"content_id": "labelTest",
"updated_at": "2018-07-09T12:09:13+00:00",
"publishing_rule_id": null,
"external_product_id": "default"
}
]
}
}
HTTP status code 403
Forbidden
Body
Type: application/json
Example:
Unauthorized api_key
HTTP status code 404
Not Found
delete /providers/{pcode}/accounts/{account_id}/content/labels/{label_id}/external_products/{external_product_id}
Remove {account_id} entitlements to content identified by {label_id}
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
account_id: required (string)
Account ID
Example:
accessTest
-
label_id: required (string)
Label ID
Example:
labelTest
-
external_product_id: required (string)
External Product ID
Example:
default
/providers/{pcode}/accounts/{account_id}/content/assets_offline/{asset_id}/external_products/{external_product_id}
Interact with specific offline {asset_id} entitlements
/providers/{pcode}/accounts/{account_id}/content/assets_offline/{asset_id}/external_products/{external_product_id} get delete
Get entitlements for a specific offline {asset_id}
Remove {account_id} entitlements to content identified by offline {asset_id}
get /providers/{pcode}/accounts/{account_id}/content/assets_offline/{asset_id}/external_products/{external_product_id}
Get entitlements for a specific offline {asset_id}
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
account_id: required (string)
Account ID
Example:
accessTest
-
asset_id: required (string)
Offline Asset ID
Example:
assetOffline
-
external_product_id: required (string)
External Product ID
Example:
default
Query Parameters
-
api_key: (string)
API Key (optional)
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm4rCv
HTTP status code 200
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"pcode": {
"$id": "/properties/pcode",
"type": "string",
"title": "Pcode",
"default": "",
"examples": [
"EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm"
]
},
"account_id": {
"$id": "/properties/account_id",
"type": "string",
"title": "Account_id",
"default": "",
"examples": [
"accessTest"
]
},
"content": {
"$id": "/properties/content",
"type": "object",
"properties": {
"assets_offline": {
"$id": "/properties/content/properties/assets_offline",
"type": "array",
"items": {
"$id": "/properties/content/properties/assets_offline/items",
"type": "object",
"properties": {
"content_id": {
"$id": "/properties/content/properties/assets_offline/items/properties/content_id",
"type": "string",
"title": "Content_id",
"default": "",
"examples": [
"assetOffline"
]
},
"updated_at": {
"$id": "/properties/content/properties/assets_offline/items/properties/updated_at",
"type": "string",
"title": "Updated_at",
"default": "",
"examples": [
"2018-07-09T14:40:09+00:00"
]
},
"publishing_rule_id": {
"$id": "/properties/content/properties/assets_offline/items/properties/publishing_rule_id",
"type": "null",
"title": "Publishing_rule_id",
"default": null,
"examples": [
null
]
},
"external_product_id": {
"$id": "/properties/content/properties/assets_offline/items/properties/external_product_id",
"type": "string",
"title": "External_product_id",
"default": "",
"examples": [
"default"
]
}
}
}
}
}
}
}
}
Example:
{
"pcode": "EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm",
"account_id": "accessTest",
"content": {
"assets_offline": [
{
"content_id": "assetOffline",
"updated_at": "2018-07-09T14:40:09+00:00",
"publishing_rule_id": null,
"external_product_id": "default"
}
]
}
}
HTTP status code 403
Forbidden
Body
Type: application/json
Example:
Unauthorized api_key
HTTP status code 404
Not Found
delete /providers/{pcode}/accounts/{account_id}/content/assets_offline/{asset_id}/external_products/{external_product_id}
Remove {account_id} entitlements to content identified by offline {asset_id}
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
account_id: required (string)
Account ID
Example:
accessTest
-
asset_id: required (string)
Offline Asset ID
Example:
assetOffline
-
external_product_id: required (string)
External Product ID
Example:
default
/providers/{pcode}/accounts/{account_id}/content/labels_offline/{label_id}/external_products/{external_product_id}
Interact with specific offline {label_id} entitlements
/providers/{pcode}/accounts/{account_id}/content/labels_offline/{label_id}/external_products/{external_product_id} get delete
Get entitlements for a specific offline {label_id}
Remove {account_id} entitlements to content identified by offline {label_id}
get /providers/{pcode}/accounts/{account_id}/content/labels_offline/{label_id}/external_products/{external_product_id}
Get entitlements for a specific offline {label_id}
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
account_id: required (string)
Account ID
Example:
accessTest
-
label_id: required (string)
Offline Label ID
Example:
labelOffline
-
external_product_id: required (string)
External Product ID
Example:
default
Query Parameters
-
api_key: (string)
API Key (optional)
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm4rCv
HTTP status code 200
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"pcode": {
"$id": "/properties/pcode",
"type": "string",
"title": "The Pcode Schema ",
"default": "",
"examples": [
"EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm"
]
},
"account_id": {
"$id": "/properties/account_id",
"type": "string",
"title": "The Account_id Schema ",
"default": "",
"examples": [
"accessTest"
]
},
"content": {
"$id": "/properties/content",
"type": "object",
"properties": {
"labels_offline": {
"$id": "/properties/content/properties/labels_offline",
"type": "array",
"items": {
"$id": "/properties/content/properties/labels_offline/items",
"type": "object",
"properties": {
"content_id": {
"$id": "/properties/content/properties/labels_offline/items/properties/content_id",
"type": "string",
"title": "The Content_id Schema ",
"default": "",
"examples": [
"labelOffline"
]
},
"updated_at": {
"$id": "/properties/content/properties/labels_offline/items/properties/updated_at",
"type": "string",
"title": "The Updated_at Schema ",
"default": "",
"examples": [
"2018-07-09T12:56:53+00:00"
]
},
"publishing_rule_id": {
"$id": "/properties/content/properties/labels_offline/items/properties/publishing_rule_id",
"type": "null",
"title": "The Publishing_rule_id Schema ",
"default": null,
"examples": [
null
]
},
"external_product_id": {
"$id": "/properties/content/properties/labels_offline/items/properties/external_product_id",
"type": "string",
"title": "The External_product_id Schema ",
"default": "",
"examples": [
"default"
]
}
}
}
}
}
}
}
}
Example:
{
"pcode": "EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm",
"account_id": "accessTest",
"content": {
"labels_offline": [
{
"content_id": "labelOffline",
"updated_at": "2018-07-09T12:56:53+00:00",
"publishing_rule_id": null,
"external_product_id": "default"
}
]
}
}
HTTP status code 403
Forbidden
Body
Type: application/json
Example:
Unauthorized api_key
HTTP status code 404
Not Found
delete /providers/{pcode}/accounts/{account_id}/content/labels_offline/{label_id}/external_products/{external_product_id}
Remove {account_id} entitlements to content identified by offline {label_id}
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
account_id: required (string)
Account ID
Example:
accessTest
-
label_id: required (string)
Offline Label ID
Example:
labelOffline
-
external_product_id: required (string)
External Product ID
Example:
default
/providers/{pcode}/users/{content_type}/{content_id}/external_products/{external_product_id}
Get a list of users for an entitlement
Get a list of users for an entitlement
get /providers/{pcode}/users/{content_type}/{content_id}/external_products/{external_product_id}
Get a list of users for an entitlement
URI Parameters
-
pcode: required (string)
Provider Code
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm
-
content_type: required (string)
Content Type (asset, assets_offline, label, label_offline, offer or offer_offline)
Example:
asset
-
content_id: required (string)
Content ID
Example:
hwb21vZjE6qeQ2eAWts1YwWGKPojdhTA
-
external_product_id: required (string)
External Product ID
Example:
default
Query Parameters
-
api_key: (string)
API Key (optional)
Example:
EQp0X8uhDsFAPpkzXXqQwoKS32cd9zAm4rCv
-
last_shard: (integer)
The unique identifier of the last shard visited (optional) If the number of qualified users exceeds 1000, pagination occurs In this case the response will contain not only users, but also {last_shard} and {last_id} You can append these two parameters to the GET request url to retrieve the next 1000 users
Example:
1 -
last_id: (string)
The last user id in the previous response (optional) If the number of qualified users exceeds 1000, pagination occurs In this case the response will contain not only users, but also {last_shard} and {last_id} You can append these two parameters to the GET request url to retrieve the next 1000 users
Example:
109812
HTTP status code 200
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"users": {
"$id": "/properties/users",
"type": "array",
"items": {
"$id": "/properties/users/items",
"type": "string",
"title": "Users",
"default": "",
"examples": [
"accessTest"
]
}
}
}
}
Example:
{
"users": [
"accessTest"
]
}
HTTP status code 403
Forbidden
Body
Type: application/json
Example:
Unauthorized api_key
HTTP status code 404
Not Found