Client library for Rocket Services
npm install --save @datafire/britboxlet britbox = require('@datafire/britbox').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: "",
resetPasswordAuth: "",
verifyEmailAuth: ""
});
.then(data => {
console.log(data);
});An Orchestration Layer that takes ISL services and packages them in a more targeted way for front-end applications. This in turn makes client integration easier and reduces the complexity and size of front-end applications.
Rocket is also customisable - allowing UI engineers to ‘remix’ the existing back-end services into something that best suits the application they are developing.
Exchange the code passed to your redirect URI for an access_token
britbox.oauthCallback({
"code": ""
}, context)- input
object- code required
string
- code required
- output
object- access_token
string - refresh_token
string - token_type
string - scope
string - expiration
string
- access_token
Exchange a refresh_token for an access_token
britbox.oauthRefresh(null, context)This action has no parameters
- output
object- access_token
string - refresh_token
string - token_type
string - scope
string - expiration
string
- access_token
Get the details of an account along with the profiles and entitlements under it.
britbox.getAccount({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
- output Account
Update the details of an account.
With the exception of the address, this supports partial updates, so you can send just the properties you wish to update.
When the address is provided any properties which are omitted from the address will be cleared.
britbox.updateAccount({
"body": {}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required AccountUpdateRequest
- ff
Output schema unknown
Get the available payment methods under an account.
britbox.getPaymentMethods({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
- output
array- items PaymentMethod
Add a new payment method to an account.
britbox.addPaymentMethod({
"body": {
"token": "",
"type": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required AddPaymentMethodRequest
- ff
- output PaymentMethod
Remove a payment method from an account.
britbox.removePaymentMethod({
"id": ""
}, context)- input
object- id required
string: The id of the payment method to remove. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
Output schema unknown
Get a payment method under an account.
britbox.getPaymentMethod({
"id": ""
}, context)- input
object- id required
string: The id of the payment method to get. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output PaymentMethod
Get a list of all purchases made under an account.
britbox.getPurchases({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
- output
array- items Purchase
Purchase a plan or item offer. The result of a successful transaction is a new entitlement.
britbox.makePurchase({
"body": {}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required PurchaseRequest
- ff
- output Entitlement
Cancel a plan subscription.
A cancelled subscription will continue to be valid until the subscription expiry date or next renewal date.
britbox.cancelSubscription({
"id": ""
}, context)- input
object- id required
string: The identifier of the current active subscription membership of the account. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
Output schema unknown
Renew a cancelled subscription or switch subscription to a different plan.
When renewing a cancelled subscription membership, hit this endpoint with the id of subscription to renew.
To switch plans provide the id of the current active subscription membership of the account, and in the query specify the id of the plan to switch to.
britbox.updateSubscription({
"id": ""
}, context)- input
object- id required
string: The identifier of the current subscription membership - planId
string: The id of the plan to switch to if switching plans. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
Output schema unknown
Get all devices registered under this account.
Also includes information around device registration and deregistration limits.
britbox.getDevices({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
- output AccountDevices
Register a playback device under an account.
If a device with the same id already exists a 409 conflict will be returned.
britbox.registerDevice({
"body": {
"id": "",
"name": "",
"type": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required DeviceRegistrationRequest
- ff
- output Device
Authorize a device from a generated device authorization code.
This is the second step in the process of authorizing a device by pin code.
Firstly the device must request a generated authorization code via the
/authorization/device/code endpoint.
This endpoint then authorizes the device associated with the code to sign in to a user account. Typically this endpoint will be called from a page presented in the web app under the account section.
Once authorized, the device will then be able to sign in to that account
via the /authorization/device endpoint, without needing to provide the
credentials of the user.
britbox.authorizeDevice({
"body": {
"code": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required DeviceAuthorizationCode
- ff
Output schema unknown
Deregister a playback device from an account.
britbox.deregisterDevice({
"id": ""
}, context)- input
object- id required
string: The unique identifier for the registered device e.g. serial number. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
Output schema unknown
Get a registered device.
britbox.getDevice({
"id": ""
}, context)- input
object- id required
string: The unique identifier for the registered device e.g. serial number. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output Device
Rename a device
britbox.renameDevice({
"id": "",
"name": ""
}, context)- input
object- id required
string: The unique identifier for this registered device e.g. serial number. - name required
string: The new name for the device. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
Output schema unknown
Get all entitlements under the account.
This list is returned under the call to get account information so a call here is only required when wishing to refresh a local copy of entitlements.
britbox.getEntitlements({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
- output
array- items Entitlement
Get the video files associated with an item given maximum resolution, device type and one or more delivery types.
This endpoint accepts an Account Catalog token, however if when requesting
playback files you receive an 403 status code with error code 1 then the file
you're requesting is classification restricted. This means you should switch
to target the /account/items/{id}/videos-guarded endpoint, passing it an Account
Playback token. If not already obtained, this token can be requested via the
/itv/pinauthorization endpoint with an account level pin.
For convenience you may also access free / public files through this endpoint instead of the /items/{id}/videos endpoint, when authenticated.
Returns an array of video file objects which each include a url to a video.
The first entry in the array contains what is predicted to be the best match. The remainder of the entries, if any, may contain resolutions below what was requests. For example if you request HD-720 the response may also contain SD entries.
If you specify multiple delivery types, then the response array will insert
types in the order you specify them in the query. For example stream,progressive
would return an array with 0 or more stream files followed by 0 or more progressive files.
If no files are found a 404 is returned.
britbox.getItemMediaFiles({
"id": "",
"delivery": [],
"resolution": ""
}, context)- input
object- id required
string: The identifier of the item whose video files to load. - delivery required
array: The video delivery type you require. - resolution required
string(values: HD-4K, HD-1080, HD-720, SD, External): The maximum resolution the device to playback the media can present. - formats
array: The set of media file formats that the device supports, in the order of preference. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output
array- items MediaFile
Get the video files associated with an item given maximum resolution, device type and one or more delivery types.
This endpoint is identical to the /account/items/{id}/videos however it expects
an Account Playback token. This token, and in association this endpoint, is specifically
for use when playback files are classification restricted and require an account
level pin to access them.
Returns an array of video file objects which each include a url to a video.
The first entry in the array contains what is predicted to be the best match. The remainder of the entries, if any, may contain resolutions below what was requests. For example if you request HD-720 the response may also contain SD entries.
If you specify multiple delivery types, then the response array will insert
types in the order you specify them in the query. For example stream,progressive
would return an array with 0 or more stream files followed by 0 or more progressive files.
If no files are found a 404 is returned.
britbox.getItemMediaFilesGuarded({
"id": "",
"delivery": [],
"resolution": ""
}, context)- input
object- id required
string: The identifier of the item whose video files to load. - delivery required
array: The video delivery type you require. - resolution required
string(values: HD-4K, HD-1080, HD-720, SD, External): The maximum resolution the device to playback the media can present. - formats
array: The set of media file formats that the device supports, in the order of preference. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output
array- items MediaFile
Generate a new account nonce.
A nonce may be required to help sign a response from a third party service which will be passed back to these services.
For example a Facebook single-sign-on request initiated by a client application may first get a nonce from here to include in the request. Facebook will then include the nonce in the auth token it issues. This token can be passed back to our services and the nonce checked for validity.
britbox.generateNonce({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
- output AccountNonce
Change the password of an account.
The expected token scope is Settings.
britbox.changePassword({
"body": {
"password": "",
"profileToken": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ChangePasswordRequest
- ff
Output schema unknown
Change the pin of an account.
britbox.changePin({
"body": {
"pin": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ChangePinRequest
- ff
Output schema unknown
Get the details of the active profile, including watched, bookmarked and rated items.
britbox.getProfile({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
- output ProfileDetail
Get the map of bookmarked item ids (itemId => creationDate) under the active profile.
britbox.getBookmarks({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
- output
object
Returns the list of bookmarked items under the active profile.
britbox.getBookmarkList({}, context)- input
object- page
integer: The page of items to load. Starts from page 1. - page_size
integer: The number of items to return in a page. - order
string(values: asc, desc): The list sort order, either 'asc' or 'desc'. - item_type
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset): The item type to filter by. Defaults to unspecified. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- page
- output ItemList
Unbookmark an item under the active profile.
britbox.deleteItemBookmark({
"itemId": ""
}, context)- input
object- itemId required
string: The identifier of the bookmark to delete. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- itemId required
Output schema unknown
Get the bookmark for an item under the active profile.
britbox.getItemBookmark({
"itemId": ""
}, context)- input
object- itemId required
string: The id of the item to get the bookmark for. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- itemId required
- output Bookmark
Bookmark an item under the active profile.
Creates one if it doesn't exist, overwrites one if it does.
britbox.bookmarkItem({
"itemId": ""
}, context)- input
object- itemId required
string: The id of the item to bookmark. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- itemId required
- output Bookmark
Returns a list of items which have been watched but not completed under the active profile.
Multiple episodes under the same show may be watched or in progress, however only a single item belonging to a particular show will be included in the returned list.
The next episode to continue watching for a particular show will be the most recent
incompletely watched episode, or the next episode following the most recently
completely watched episode. Based on the specified show_item_type type, either the next
episode, the season of the next episode, or the show will be included in the list.
britbox.getContinueWatchingList({}, context)- input
object- show_item_type
string(values: episode, season, show): The item type to be returned for continue watching items belonging to a show. - include
array: Include one opr more ancestor/children for items belonging to a show. Extra items - page
integer: The page of items to load. Starts from page 1. - page_size
integer: The number of items to return in a page. - max_rating
string: The maximum rating (inclusive) of an item returned, e.g. 'auoflc-pg'. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- show_item_type
- output ItemList
Returns the next item to play given a source item id.
For an unwatched show it returns the first episode available to the account.
For a watched show it returns the last incompletely watched episode by the profile, or the episode that immediately follows the last completely watched episode or nothing.
For an episode it always returns the immediately following episode, if available to the account, or nothing.
If the response does not contain a next property then no item was found.
britbox.getNextPlaybackItem({
"itemId": ""
}, context)- input
object- itemId required
string: The identifier of the source item to base the next to watch item off. - max_rating
string: The maximum rating (inclusive) of an item returned, e.g. 'auoflc-pg'. - expand
string(values: parent, ancestors): If no value is specified no dependencies are expanded. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- itemId required
- output NextPlaybackItem
Get the map of rated item ids (itemId => rating out of 10) under the active profile.
britbox.getRatings({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
- output
object
Returns the list of rated items under the active profile.
britbox.getRatingsList({}, context)- input
object- page
integer: The page of items to load. Starts from page 1. - page_size
integer: The number of items to return in a page. - order
string(values: asc, desc): The list sort order, either 'asc' or 'desc'. - order_by
string(values: date-added, date-modified): What to order by. - item_type
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset): The item type to filter by. Defaults to unspecified. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- page
- output ItemList
Get the rating info for an item under the active profile.
britbox.getItemRating({
"itemId": ""
}, context)- input
object- itemId required
string: The id of the item to get the rating info for. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- itemId required
- output UserRating
Rate an item under the active profile.
Creates one if it doesn't exist, overwrites one if it does.
britbox.rateItem({
"itemId": "",
"rating": 0
}, context)- input
object- itemId required
string: The id of the item to rate. - rating required
integer: The item rating between 1 and 10 inclusive. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- itemId required
- output UserRating
Remove the watched status of items under the active profile. Passing in
specific itemIds to the item_ids query parameter will cause only these
items to be removed. If this list is missing all watched items will be
removed
britbox.deleteWatched({}, context)- input
object- item_ids
array: List ofitemIds to delete. Omit this parameter to delete all items - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- item_ids
Output schema unknown
Get the map of watched item ids (itemId => last playhead position) under the active profile.
britbox.getWatched({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
- output
object
Returns the list of watched items under the active profile.
britbox.getWatchedList({}, context)- input
object- page
integer: The page of items to load. Starts from page 1. - page_size
integer: The number of items to return in a page. - completed
boolean: Filter by whether an item has been fully watched (completed) or not. - order
string(values: asc, desc): The list sort order, either 'asc' or 'desc'. - order_by
string(values: date-added, date-modified): What to order by. - item_type
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset): The item type to filter by. Defaults to unspecified. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- page
- output ItemList
Get the watched status info for an item under the active profile.
britbox.getItemWatchedStatus({
"itemId": ""
}, context)- input
object- itemId required
string: The id of the item to get the watched status for. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- itemId required
- output Watched
Record the watched playhead position of a video under the active profile.
Can be used later to resume a video from where it was last watched.
Creates one if it doesn't exist, overwrites one if it does.
britbox.setItemWatchedStatus({
"itemId": "",
"position": 0
}, context)- input
object- itemId required
string: The id of the item being watched. - position required
integer: The playhead position to record. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- itemId required
- output Watched
Create a new profile under the active account.
britbox.createProfile({
"body": {
"name": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ProfileCreationRequest
- ff
- output ProfileDetail
Delete a profile with a specific id under the active account.
Note that you cannot delete the primary profile.
britbox.deleteProfileWithId({
"id": ""
}, context)- input
object- id required
string: The identifier of the profile to delete. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
Output schema unknown
Get the summary of a profile with a specific id under the active account.
britbox.getProfileWithId({
"id": ""
}, context)- input
object- id required
string: The identifier of the profile to return. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output ProfileSummary
Update the summary of a profile with a specific id under the active account.
This supports partial updates so you can send just the properties you wish to update.
britbox.updateProfileWithId({
"id": "",
"body": {}
}, context)- input
object- id required
string: The identifier of the profile to update. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ProfileUpdateRequest
- id required
Output schema unknown
Request that the email address tied to an account be verified.
This will send a verification email to the email address of the primary profile containing a link which, once clicked, completes the verification process via the /verify-email endpoint.
Note that when an account is created this email is sent automatically so there's no need to call this directly.
If the user doesn't click the link before it expires then this endpoint can be called to request a new verification email. In the future it may also be used if we add support for changing an account email address.
britbox.requestEmailVerification({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
Output schema unknown
When a user signs out of an application we need to clear some basic cookies we assigned them during token authorization.
britbox.signOut({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
Output schema unknown
Request one or more Account level authorization tokens each with a chosen scope.
Tokens are used to access restricted service endpoints. These restricted endpoints will require a specific token type (e.g Account) with a specific scope (e.g. Catalog) before access is granted.
For convenience, where a Profile level token with the same scope exists it will also be returned.
Authorization with pin is not supported on this endpoint anymore. Use /itv/pinauthorization
endpoint instead.
britbox.getAccountToken({
"body": {
"email": "",
"password": "",
"scopes": []
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required AccountTokenRequest
- ff
- output
array- items AccessToken
Get Catalog tokens for an account using a device authorization code. Where a Profile level token of Catalog scope exists it will also be returned.
This is the final step in the process of authorizing a device by pin code.
Firstly the device must request a generated authorization code via the
/authorization/device/code endpoint.
The code is subsequently used to authorize the device to sign in to a given
account via the /account/devices/authorization endpoint. Typically this
will be from a page presented in the web app under the account section.
Once authorized, this endpoint will allow the device to sign in without needing to provide the credentials of the user.
britbox.getAccountTokenByCode({
"body": {
"id": "",
"code": "",
"scopes": []
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required AccountTokenByCodeRequest
- ff
- output
array- items AccessToken
Get a generated device authorization code.
This is the first step in the process of authorizing a device by pin code. The device will make a request to this endpoint providing a unique identifier for the device such as a serial number. This endpoint will then return a generated code which is tied to the given device.
The code may subsequently be used to authorize the device to sign in to an
account via the /account/devices/authorization endpoint. Typically this
will be from a page presented in the web app under the account section.
Once authorized, the device will then be able to sign in to that account
via the /authorization/device endpoint, without needing to provide the
credentials of the user.
britbox.generateDeviceAuthorizationCode({
"body": {
"id": "",
"name": "",
"type": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required DeviceRegistrationRequest
- ff
- output DeviceAuthorizationCode
Request one or more Profile level authorization tokens each with a chosen scope.
Tokens are used to access restricted service endpoints. These restriced endpoints will require a specific token type (e.g Profile) with a specific scope (e.g. Catalog) before access is granted.
britbox.getProfileToken({
"body": {
"profileId": "",
"scopes": []
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ProfileTokenRequest
- ff
- output
array- items AccessToken
Refresh an account or profile level authorization token which is marked as refreshable.
britbox.refreshToken({
"body": {
"token": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required TokenRefreshRequest
- ff
- output AccessToken
Exchange a third party single-sign-on token for our own authorization tokens.
britbox.singleSignOn({
"body": {
"provider": "",
"token": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required SingleSignOnRequest
- ff
- output
array- items AccessToken
Returns all the plans available for BT flow including additional description data.
britbox.getPlansBT({}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response.
- lang
- output BtPlans
Assigns an UserToken to a profile on the ITV side. Currently throws an exception.
britbox.assignToken({
"body": {
"token": "",
"profileToken": ""
}
}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response. - body required ItvAssignBtTokenRequest
- lang
Output schema unknown
Checks a provided token for BT eligible user.
britbox.checkUserToken({
"id": ""
}, context)- input
object- id required
string: User token provided by BT. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
Output schema unknown
Returns the details of subscription data for a user with specified id.
britbox.getSubscriptionData({
"id": ""
}, context)- input
object- id required
string: The identifier of the user to load.
- id required
- output SubscriptionDetails
Get the global configuration for an application. Should be called during app statup.
This includes things like device and playback rules, classifications, sitemap and subscriptions.
You have the option to select specific configuration objects using the 'include' parameter, or if unspecified, getting all configuration.
britbox.getAppConfig({}, context)- input
object- include
array: A comma delimited list of config objects to return. - system
string: Classification system to load in case include = classification. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- include
- output AppConfig
Check whether or not a user is eligible for switching to Bt or EE offers.
britbox.checkEeBtEligibility({}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response.
- lang
- output EeBtEligibility
Assigns a msisdn to a profile on ITV side.
britbox.assignMsisdn({
"body": {
"msisdn": "",
"profileToken": "",
"trackingHeader": "",
"eeProductId": ""
}
}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response. - body required ItvAssignMsisdnRequest
- lang
Output schema unknown
Returns eligible partner specific offers for the querying partner for an EE MSISDN. This call is supposed to be called after we have MSISDN accired. This call should be followed by POST /ee/msisdn.
britbox.getEligibleOffers({
"body": {
"msisdn": "",
"accessToken": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required EeOffersRequest
- ff
- output EeOffersResponse
Validate PIN request created by calling POST /ee/pin This call is to validate MSISDN entered by a user not comming through EE network. This call should be called after PUT /ee/pin. This call should be followed by POST /ee/offers.
britbox.validatePinRequest({
"body": {
"pinReference": "",
"pin": "",
"accessToken": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required EeValidatePinRequest
- ff
- output EeValidatePinResponse
Creates a PIN request that will send an SMS to the given msisdn. This call is to validate MSISDN entered by a user not comming through EE network. This call should be followed by POST ee/pin.
britbox.createPinRequest({
"body": {
"msisdn": "",
"accessToken": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required EeCreatePinRequest
- ff
- output EeCreatePinResponse
Returns all the plans available for EE flow including additional description data.
britbox.getPlansEE({}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response.
- lang
- output EePlans
Returns the plan description for EE flow including additional description data.
britbox.getPlanEE({
"id": ""
}, context)- input
object- id required
string: The identifier of the plan received from ee/offers. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output EePlanListItem
Returns a token for later calls to EE API. TTL is one hour. Recommended is FE refreshes this token before each call.
britbox.createToken(null, context)This action has no parameters
- output EeCreateTokenResponse
Returns the details of an item with the specified id.
britbox.getItem({
"id": ""
}, context)- input
object- id required
string: The identifier of the item to load. - max_rating
string: The maximum rating (inclusive) of items returned, e.g. 'auoflc-pg'. - expand
string(values: all, children, ancestors, parent): If no value is specified no dependencies are expanded. - select_season
string(values: first, latest): Given a provided show id, it can be useful to get the details of a child season. This option - use_custom_id
boolean: Set to true when passing a custom Id as theidpath parameter. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output ItemDetail
Returns the List of child summary items under an item.
If the item is a Season then the children will be episodes and ordered by episode number.
If the item is a Show then the children will be Seasons and ordered by season number.
Returns 404 if no children found.
britbox.getItemChildrenList({
"id": ""
}, context)- input
object- id required
string: The identifier of the item whose children to load. - page
integer: The page of items to load. Starts from page 1. - page_size
integer: The number of items to return in a page. - max_rating
string: The maximum rating (inclusive) of items returned, e.g. 'auoflc-pg'. - order
string(values: asc, desc): The list sort order, either 'asc' or 'desc'. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output ItemList
Returns the list of items related to the parent item.
Note for now, due to the size of the list being unknown, only a single page will be returned.
britbox.getItemRelatedList({
"id": ""
}, context)- input
object- id required
string: The identifier of the item to based related items off. - page
integer: The page of items to load. Starts from page 1. - page_size
integer: The number of items to return in a page. - max_rating
string: The maximum rating (inclusive) of items returned, e.g. 'auoflc-pg'. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output ItemList
Get the free / public video files associated with an item given maximum resolution, device type and one or more delivery types.
Returns an array of video file objects which each include a url to a video.
The first entry in the array contains what is predicted to be the best match. The remainder of the entries, if any, may contain resolutions below what was requests. For example if you request HD-720 the response may also contain SD entries.
If you specify multiple delivery types, then the response array will insert
types in the order you specify them in the query. For example stream,progressive
would return an array with 0 or more stream files followed by 0 or more progressive files.
If no files are found a 404 is returned.
britbox.getPublicItemMediaFiles({
"id": "",
"delivery": [],
"resolution": ""
}, context)- input
object- id required
string: The identifier of the item whose video files to load. - delivery required
array: The video delivery type you require. - resolution required
string(values: HD-4K, HD-1080, HD-720, SD, External): The maximum resolution the device to playback the media can present. - formats
array: The set of media file formats that the device supports, in the order of preference. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output
array- items MediaFile
Identical to GET /account/profile/items/{itemId}/next route but for users that are not logged in i.e. this endpoint does not require authorisation
britbox.getAnonNextPlaybackItem({
"itemId": ""
}, context)- input
object- itemId required
string: The identifier of the source item to base the next to watch item off. - max_rating
string: The maximum rating (inclusive) of an item returned, e.g. 'auoflc-pg'. - expand
string(values: parent, ancestors): If no value is specified no dependencies are expanded. - device
string: The type of device the content is targeting. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- itemId required
- output NextPlaybackItem
Returns the list of billing records for specified payment platform.
britbox.getBillingHistory({
"platform": "",
"body": {
"profileToken": ""
}
}, context)- input
object- platform required
string: The identifier of the payment platform (stripe/itunes). - lang
string: Language code for the preferred language to be returned in the response. - body required ItvBillingHistoryRequest
- platform required
- output ItvBillingHistory
Get payment card details.
britbox.getCardDetails({
"platform": "",
"body": {
"profileToken": ""
}
}, context)- input
object- platform required
string: The identifier of the payment platform (stripe/itunes). - lang
string: Language code for the preferred language to be returned in the response. - body required ItvGetCardDetailsRequest
- platform required
- output ItvCardDetails
Change payment card details.
britbox.changeCardDetails({
"platform": "",
"body": {
"profileToken": "",
"cardToken": ""
}
}, context)- input
object- platform required
string: The identifier of the payment platform (stripe/itunes). - lang
string: Language code for the preferred language to be returned in the response. - body required ItvChangeCardDetailsRequest
- platform required
Output schema unknown
Change email address related to account/profile.
The expected token scope is Settings.
britbox.changeEmail({
"body": {
"email": "",
"profileToken": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ItvChangeEmailRequest
- ff
Output schema unknown
Change marketing preferences related to account/profile.
The expected token scope is Settings.
britbox.changeMarketing({
"body": {
"emailOptIn": true,
"profileToken": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ItvChangeMarketingRequest
- ff
Output schema unknown
Delete account in compliance with GDPR.
The expected token scope is Settings.
britbox.deleteAccount({
"body": {
"profileToken": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ItvDeleteAccountRequest
- ff
Output schema unknown
Returns the state of subscription for any payment platform.
britbox.getEntitlementsHistory({}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response.
- lang
- output ItvEntitlementsHistory
Gets info whether or not a feature is enabled or disabled using a feature flag. Feature flags are set as a custom field within PM. It also supports custom feature flag data if needed. Such data can be return as well.
britbox.getFeatureFlag({
"feature": ""
}, context)- input
object- feature required
string: The identifier of the feature to check for feature flag. - lang
string: Language code for the preferred language to be returned in the response.
- feature required
- output ItvFeatureFlag
Returns the details of an item with the specified id.
britbox.getItemDownloadables({
"body": {
"ids": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ItemDownloadableRequest
- ff
- output ItemDownloadableList
Redirects to corresponding Axis Item details page.
britbox.getItemItv({
"externalId": ""
}, context)- input
object- externalId required
string: The external identifier of the item.
- externalId required
- output
object
Returns a page with the specified id.
This is a cut down version for low memory devices.123
If targeting the search page you must url encode the search term as a parameter
using the q key. For example if your browser path looks like /search?q=the
then what you pass to this endpoint would look like /itv/page?path=/search%3Fq%3Dthe.
britbox.getItvPage({
"path": ""
}, context)- input
object- path required
string: The path of the page to load, e.g. '/movies'. - list_page_size
integer: The number of items to load when prefetching and paging each list in the page row. - list_page_size_large
integer: The number of items to load when prefetching a continuous scroll list entry in a page. - max_list_prefetch
integer: The maximum number of lists to prefetch in the page. - item_detail_expand
string(values: all, children, ancestors): Only relevant when loading item detail pages as these embed a detailed item in the main page entry. - item_detail_select_season
string(values: first, latest): Only relevant when loading show detail pages as these embed a detailed item in the main page entry. - text_entry_format
string(values: markdown, html): Only relevant to page entries of typeTextEntry. - max_rating
string: The maximum rating (inclusive) of items returned, e.g. 'auoflc-pg'. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- path required
- output Page
Provides authorization with parental control pin.
Returns an array containing account token with Playback scope.
Requires access token with Catalog scope.
Pin must be a 4-digit string
britbox.getAccountTokenWithPin({
"body": {
"pin": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ItvPinAuthRequest
- ff
- output
array- items AccessToken
Upgrades the plan for the current user.
britbox.upgradePlan({
"platform": "",
"body": {
"planId": ""
}
}, context)- input
object- platform required
string: The identifier of the payment platform (stripe/itunes). Only Stripe is supported - lang
string: Language code for the preferred language to be returned in the response. - body required ItvUpgradePlanRequest
- platform required
Output schema unknown
Returns the plans available for specified payment platform.
britbox.getPlansITV({
"platform": ""
}, context)- input
object- platform required
string: The identifier of the payment platform (stripe/itunes). - lang
string: Language code for the preferred language to be returned in the response.
- platform required
- output ItvPlans
Returns the ITV profile object.
britbox.getProfileItv({}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response.
- lang
- output
object
Update ITV profile.
The expected token scope is Settings.
britbox.updateProfile({
"body": {
"profileToken": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required ItvUpdateProfileRequest
- ff
Output schema unknown
Returns the ITV profile token.
britbox.getItvProfileToken({
"body": {
"password": ""
}
}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response. - body required ItvProfileTokenRequest
- lang
- output ItvProfileToken
Cancel a plan subscription.
A cancelled subscription will continue to be valid until the subscription expiry date or next renewal date.
britbox.cancelSubscriptionItv({
"platform": "",
"body": {
"profileToken": ""
}
}, context)- input
object- platform required
string: The identifier of the payment platform (stripe/itunes). - lang
string: Language code for the preferred language to be returned in the response. - body required ItvCancelSubscriptionRequest
- platform required
Output schema unknown
Returns the details of current subscription for specified payment platform.
britbox.getCurrentSubscription({
"platform": ""
}, context)- input
object- platform required
string: The identifier of the payment platform (stripe/itunes). - lang
string: Language code for the preferred language to be returned in the response.
- platform required
- output ItvCurrentSubscription
Confirms purchase and returns the details of purchased subscription for specified payment platform.
britbox.confirmPurchase({
"platform": "",
"body": {
"planId": "",
"profileToken": "",
"cardToken": ""
}
}, context)- input
object- platform required
string: The identifier of the payment platform (stripe/itunes). - lang
string: Language code for the preferred language to be returned in the response. - body required ItvPurchaseRequest
- platform required
- output ItvPurchase
Checks the provided coupon id for a user. Only Stripe platform is currently supported.
britbox.getSaveOffer({}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response.
- lang
- output ItvGetDiscountResponse
Activates the discount for a user. Only Stripe platform is currently supported.
britbox.activateSaveOffer({
"body": ""
}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response. - body required
string
- lang
Output schema unknown
Returns the state of subscription for any payment platform.
britbox.getSubscriptionState({}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response.
- lang
- output ItvSubscriptionState
Returns an upcoming invoice
britbox.getUpcomingInvoice({}, context)- input
object- lang
string: Language code for the preferred language to be returned in the response.
- lang
- output ItvGetDiscountResponse
Validates the coupon/voucher for specified payment platform.
britbox.checkVoucher({
"platform": "",
"body": {
"voucher": ""
}
}, context)- input
object- platform required
string: The identifier of the payment platform (stripe/itunes). - lang
string: Language code for the preferred language to be returned in the response. - body required ItvVoucherRequest
- platform required
- output ItvVoucher
Returns an array of item lists with their first page of content resolved.
britbox.getLists({
"ids": []
}, context)- input
object- ids required
array: A comma delimited list of item list identifiers. - page_size
integer: The number of items to return in a page. - max_rating
string: The maximum rating (inclusive) of items returned, e.g. 'auoflc-pg'. - order
string(values: asc, desc): The list sort order, either 'asc' or 'desc'. - order_by
string(values: a-z, release-year, date-added): What to order by. - item_type
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset): The item type to filter by. Defaults to unspecified. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ids required
- output
array- items ItemList
Returns a list of items under the specified item list
britbox.getList({
"id": ""
}, context)- input
object- id required
string: The identifier of the list to load. - page
integer: The page of items to load. Starts from page 1. - page_size
integer: The number of items to return in a page. - max_rating
string: The maximum rating (inclusive) of items returned, e.g. 'auoflc-pg'. - order
string(values: asc, desc): The list sort order, either 'asc' or 'desc'. - order_by
string(values: a-z, release-year, date-added): What to order by. - param
string: The list parameter in format 'key:value', e.g. 'genre:action'. - item_type
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset): The item type to filter by. Defaults to unspecified. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output ItemList
Returns a page with the specified id.
If targeting the search page you must url encode the search term as a parameter
using the q key. For example if your browser path looks like /search?q=the
then what you pass to this endpoint would look like /page?path=/search%3Fq%3Dthe.
britbox.getPage({
"path": ""
}, context)- input
object- path required
string: The path of the page to load, e.g. '/movies'. - list_page_size
integer: The number of items to load when prefetching and paging each list in the page row. - list_page_size_large
integer: The number of items to load when prefetching a continuous scroll list entry in a page. - max_list_prefetch
integer: The maximum number of lists to prefetch in the page. - item_detail_expand
string(values: all, children, ancestors): Only relevant when loading item detail pages as these embed a detailed item in the main page entry. - item_detail_select_season
string(values: first, latest): Only relevant when loading show detail pages as these embed a detailed item in the main page entry. - text_entry_format
string(values: markdown, html): Only relevant to page entries of typeTextEntry. - max_rating
string: The maximum rating (inclusive) of items returned, e.g. 'auoflc-pg'. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- path required
- output Page
Returns the details of a Plan with the specified id.
britbox.getPlan({
"id": ""
}, context)- input
object- id required
string: The identifier of the Plan to load. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- id required
- output Plan
Register a new user, creating them an account.
Registration, when successful, will return an array of access tokens so the user is immediately signed in.
It returns Catalog and Commerce scoped tokens for both Account and Profile. The Commerce ones are intended to allow the purchase of a subscription plan in the step after registration, without the user being prompted to enter their username and password again.
An email will also be sent with a link they need to click to confirm their email address. This confirmation is done via the /verify-email endpoint.
britbox.register({
"body": {
"email": "",
"password": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required RegistrationRequest
- ff
- output
array- items AccessToken
Request the password of an account's primary profile be reset.
Should be called when a user has forgotten their password.
This will send an email with a password reset link to the email address of the primary profile of an account.
The link, once clicked, should take the user to the "reset-password" page of the website. Here they will enter their new password and submit to the /reset-password endpoint here, along with the password reset token provided in the original link.
britbox.forgotPassword({
"body": {
"email": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required PasswordResetEmailRequest
- ff
Output schema unknown
When a user requests to reset their password via the /request-password-reset endpoint, an email is sent to the email address of the primary profile of the account. This email contains a link with a reset token as query parameter. The link should take the user to the "reset-password" page of the website.
From the reset-password page a user should enter the new password they wish to use. It should then be submitted to this endpoint, along with the reset token from the email link. The token should be provided in the body as resetToken property.
britbox.resetPassword({
"body": {
"resetToken": "",
"password": ""
}
}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response. - body required PasswordResetRequest
- ff
Output schema unknown
Returns public preview for Samsung based on the page '/samsung-preview' configured in PresentationManager. There is a hard limit of max 40 items to be returned. It splits evenly items count into the page rows, remaining items are added into the first row.
britbox.getPublicPreview(null, context)This action has no parameters
- output SamsungPreview
Returns schedules for a defined set of channels over a requested period.
Schedules are requested in hour blocks and returned grouped by the channel they belong to.
For example, to load 12 hours of schedules for channels 4343 and 5234,
on 21/2/2017 starting from 08:00.
channels=4343,5234
date=2017-02-21
hour=8
duration=12
Please remember that date and hour combined represent a normal datetime,
so they should be converted to UTC on the client - this will help to avoid
issues with EPG schedules near midnight.
If a channel id is passed which doesn't exist then this endpoint will return an empty schedule list for it. If instead we returned 404, this would invalidate all other channel schedules in the same request which would be unfriendly for clients presenting these channel schedules.
britbox.getSchedules({
"channels": [],
"date": "",
"hour": 0,
"duration": 0
}, context)- input
object- channels required
array: The list of channel ids to get schedules for. - date required
string: The date to target in ISO format, e.g.2017-05-23(converted to UTC - see main description). - hour required
integer: The base hour in the day, defined by thedateparameter, you wish to load schedules for - duration required
integer: The number of hours of schedules to load from the basehourparameter. - intersect
boolean: Flag indicating whether schedules should intersect or be contained in the - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- channels required
- output
array- items ItemScheduleList
Search the catalog of items and people.
britbox.search({
"term": ""
}, context)- input
object- term required
string: The search term to query. - include
array: By default people, movies and tv (shows + programs) will be included - group
boolean: When this option is set, instead of all search result items being returned - max_results
integer: The maximum number of results to return. - max_rating
string: The maximum rating (inclusive) of items returned, e.g. 'auoflc-pg'. - device
string: The type of device the content is targeting. - sub
string: The active subscription code. - segments
array: The list of segments to filter the response by. - ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- term required
- output SearchResults
When an account is created an email is sent to the email address of the new account. This contains a link, which once clicked, verifies the email address of the account is correct.
The link contains a token as a query parameter which should be passed as the authorization bearer token to this endpoint to complete email verification.
The token has en expiry, so if the link is not clicked before it expires, the account holder may need to request a new verification email be sent. This can be done via the endpoint /account/request-email-verification.
britbox.verifyEmail({}, context)- input
object- ff
array: The set of opt in feature flags which cause breaking changes to responses. - lang
string: Language code for the preferred language to be returned in the response.
- ff
Output schema unknown
- AccessToken
object- accountCreated
boolean: When aUserAccounttoken is issued during a single-sign-on flow - expirationDate required
string: The timestamp this token expires. - refreshable required
boolean: True if this token can be refreshed, false if not. - type required
string(values: UserAccount, UserProfile): The type of the token. - value required
string: The token value used for authenticated requests.
- accountCreated
- Account
object- address Address
- defaultPaymentInstrumentId
string: The id of the payment instrument to use by default for account transactions. - defaultPaymentMethodId
string: The id of the payment method to use by default for account transactions. - email required
string: The email address belonging to the account. - emailVerified
boolean: Whether the email address has been verified. - entitlements
array: The list of entitlements to playback specific items.- items Entitlement
- firstName
string: The first name of the account holder. - id required
string: The id of the account. - isFirstTimeSubscriber
boolean: Whether the account has the very first subscription. - lastName
string: The last name of the account holder. - marketingEnabled required
boolean: Whether the account has opted in or out of marketing material. - minRatingPlaybackGuard
string: The classification rating defining the minimum rating level a user should be - pinEnabled required
boolean: When an account level pin is defined this will be true. - primaryProfileId required
string: The id of the primary profile. - profiles required
array: The list of profiles under this account.- items ProfileSummary
- segments
array: The segments an account has been placed under- items
string
- items
- subscriptionCode required
string: The active subscription code for an account. - subscriptions
array: The list of subscriptions, if any, the account has signed up to.- items Subscription
- trackingEnabled required
boolean: Whether usage tracking is associated with the account or anonymous. - usedFreeTrial
boolean: Whether the account has used up their free trial period of a plan.
- AccountDevices
object- deregistrationWindow DeviceRegistrationWindow
- devices required
array: The array of registered playack devices.- items Device
- maxRegistered required
integer: The maximum number of playback devices that can be registered - registrationWindow DeviceRegistrationWindow
- AccountNonce
object- value required
string: The nonce value.
- value required
- AccountTokenByCodeRequest
object- code required
string: The generated device authorization code. - id required
string: The unique identifier for the device e.g. serial number. - scopes required
array: The scope(s) of the token(s) required.- items
string(values: Catalog, Commerce, Settings, Playback)
- items
- code required
- AccountTokenRequest
object- cookieType
string(values: Session, Persistent): If you specify a cookie type then a content filter cookie will be returned - email required
string: The email associated with the account. - password required
string: The password associated with the account. - scopes required
array: The scope(s) of the tokens required.- items
string(values: Catalog, Commerce, Settings, Playback)
- items
- cookieType
- AccountUpdateRequest
object- address Address
- defaultPaymentInstrumentId
string: The id of the payment instrument to use by default for account transactions. - defaultPaymentMethodId
string: The id of the payment method to use by default for account transactions. - firstName
string: The first name of the account holder. - lastName
string: The last name of the account holder. - minRatingPlaybackGuard
string: The classification rating defining the minimum rating level a user should be - segments
array: The segments an account should be placed under- items
string
- items
- trackingEnabled
boolean: Whether usage tracking is associated with an account or anonymous.
- AddPaymentMethodRequest
object- makeDefault
boolean: Whether this payment method should become the account default when - token required
string: The payment provider token representing a payment method, obtained by - type required
string(values: Card): The type of payment method.
- makeDefault
- Address
object- addressLine1
string: The first line of the street address. - addressLine2
string: The second line of the street address. - city
string: The city name. - country
string: The country name or code. - postcode
string: The postal or zip code. - state
string: The state name or abbreviation.
- addressLine1
- AppConfig
object- classification
object: The map of classification ratings. - display AppConfigDisplay
- general AppConfigGeneral
- i18n AppConfigI18n
- linear AppConfigLinear
- navigation Navigation
- playback AppConfigPlayback
- sitemap
array- items PageSummary
- subscription AppConfigSubscription
- classification
- AppConfigDisplay
object- themes required
array: An array of globally configured themes.- items Theme
- themes required
- AppConfigGeneral
object- currencyCode
string: The currency code to target. - customFields
object: A map of custom configuration fields. - defaultTimeZone
string: The default time zone of the site. e.g. "Etc/GMT" - facebookAppId
string: The Facebook application id associated with an environment. - gaToken
string: A Google Analytics token to track applicaton user events. - itemImageTypes
object: A map of default item image types where the key is the item types. - mandatorySignIn
boolean: Whether to require sign in for customers to access content. - maxUserRating
integer: The maximum value allowed for user ratings. - stripeKey
string: The public Stripe key to use for payment transactions. - websiteUrl
string: The url of the primary website.
- currencyCode
- AppConfigI18n
object- languages required
array: An array of available languages.- items Language
- languages required
- AppConfigLinear
object- viewingWindowDaysAfter
integer: Number of available upcoming day schedules. - viewingWindowDaysBefore
integer: Number of available day schedules in the past.
- viewingWindowDaysAfter
- AppConfigPlayback
object- chainPlayCountdown required
integer: The number of seconds before autoplay of next video. - chainPlaySqueezeback required
integer: The number of seconds before the end of playback when the current video - chainPlayTimeout required
integer: The number of minutes of user inactivity before autoplay is paused. - heartbeatFrequency required
integer: How often a heartbeat should be renewed during playback. - viewEventPoints required
array: An array of percentage points in which to fire off plabyack view events.- items
number
- items
- chainPlayCountdown required
- AppConfigSubscription
object- plans
array: The available public plans a user can subscribe to.- items Plan
- plans
- Bookmark
object- creationDate required
string: The date the bookmark was created. - itemId required
string: The id of the item bookmarked.
- creationDate required
- BtPlanListItem
object- amount
number: The price of a plan. If a free plan then undefined. - ctaText required
string: The textual description. - currency required
string: The currency a plan is offered in. - description required
string: The textual description. - ees07PlanDescription
string - ees07PlanTitle
string - ees07Title
string - headerText required
string: The textual description. - heroText required
string: The textual description. - id required
string: The identifier of a plan. - interval
string(values: day, week, month, year, none): The type of billing period used. - intervalCount
integer: Given theintervalthis is how frequently it will run. e.g. every 2 weeks. - longText required
string: The textual description. - nickname required
string: The title of a plan. - noThanksText
string - product required
string: The product of a plan. - switchingText
string - termsAndConditionsItunes
string - termsAndConditionsStripe
string - trialPeriodDays required
integer: How many days a trial period runs for a plan. Only valid ifhasTrialPeriodis true.
- amount
- BtPlans
object- plans required
array: The list of available plans.- items BtPlanListItem
- plans required
- BtValidateTokenResponse
object
- ChangePasswordRequest
object- password required
string: The new password for the account. - profileToken required
string: The ITV profile token.
- password required
- ChangePinRequest
object- pin required
string: The new pin to set.
- pin required
- Classification
- code required
string: The unique code for a classification. - name required
string: The name of the classification for display. - advisoryText
string: Parental advisort text. - images required
object - level required
integer: The level of this classification when compared with its siblings. - system required
string: The parent system code of the classification.
- code required
- ClassificationSummary
object- code required
string: The unique code for a classification. - name required
string: The name of the classification for display.
- code required
- ContinueWatchingListData
object: List data for ContinueWatching List- itemInclusions
object: Object where keys are itemIds for the items in the list and values are objects
- itemInclusions
- ContinueWatchingListDataExpansion
object- episode ItemSummary
- season ItemSummary
- show ItemSummary
- Credit
- name required
string: The name of the person. - path required
string: The path to the person - character
string: The name of the character. - role required
string(values: actor, associateproducer, coactor, director, executiveproducer, filminglocation, guest, narrator, other, presenter, producer, productmanager, thememusicby, voice, writer): The type of role the credit performed, e.g. actor.
- name required
- Device
object- id required
string: The unique identifier for this device e.g. serial number. - name required
string: The human recognisable name for this device. - registrationDate required
string: The date this device was registered. - type required
string: The device type e.g. web_browser.
- id required
- DeviceAuthorizationCode
object- code required
string: The generated device authorization code.
- code required
- DeviceRegistrationRequest
object- id required
string: The unique identifier for this device e.g. serial number. - name required
string: A human recognisable name for this device. - type required
string: The device type e.g. web_browser.
- id required
- DeviceRegistrationWindow
object- endDate required
string: The end date of the current period. - limit required
integer: The maximum de/registrations that can be made in a period. - periodDays required
integer: The number of days a de/registration period runs for. - remaining required
integer: The remaining de/registrations that can be made in the current period. - startDate required
string: The start date of the current period.
- endDate required
- EeBtEligibility
object- eligible required
boolean: Whether or not user is eligible - plan
string: The identifier of a plan. - source
string: Stripe etc.
- eligible required
- EeCreatePinRequest
object- accessToken required
string: EE API authorization Token received from GET /ee/token/create. - msisdn required
string: The msisdn. - trackingHeader
string: trackingHeader
- accessToken required
- EeCreatePinResponse
object- pinReference required
string: The pinReference. - trackingHeader required
string: trackingHeader
- pinReference required
- EeCreateTokenResponse
object- accessToken
string: The authentication token for later use to call EE endpoints. - expiresIn
number - tokenType
string
- accessToken
- EeIdentityRequest
object- accessToken required
string: EE API authorization Token received from GET /ee/token/create. - sessionId required
string: The sessionId returned in the ee/session response.
- accessToken required
- EeIdentityResponse
object- brand
string: The operator brand. - brandCode
string: The brand code. - msisdn required
string: The msisdn. - trackingHeader required
string: trackingHeader
- brand
- EeOfferItem
object- name required
string: The identifier of an offer.
- name required
- EeOffersRequest
object- accessToken required
string: EE API authorization Token received from GET /ee/token/create. - msisdn required
string: The msisdn. - trackingHeader
string: trackingHeader.
- accessToken required
- EeOffersResponse
object- eligibleOffers required
array: The list of eligible offers.- items EeOfferItem
- eligibleOffers required
- EePlanListItem
object- amount
number: The price of a plan. If a free plan then undefined. - ctaText required
string: The textual description. - currency required
string: The currency a plan is offered in. - description required
string: The textual description. - headerText required
string: The textual description. - heroText required
string: The textual description. - id required
string: The identifier of a plan. - interval
string(values: day, week, month, year, none): The type of billing period used. - intervalCount
integer: Given theintervalthis is how frequently it will run. e.g. every 2 weeks. - longText required
string: The textual description. - nickname required
string: The title of a plan. - product required
string: The product of a plan. - trialPeriodDays required
integer: How many days a trial period runs for a plan. Only valid ifhasTrialPeriodis true.
- amount
- EePlans
object- plans required
array: The list of available plans.- items EePlanListItem
- plans required
- EeSessionIdRequest
object- accessToken required
string: EE API authorization Token received from GET /ee/token/create. - clientIP required
string: The IP address of the requesting device.
- accessToken required
- EeSessionIdResponse
object- sessionId required
string: The assigned SessionId.
- sessionId required
- EeValidatePinRequest
object- accessToken required
string: EE API authorization Token received from GET /ee/token/create. - pin required
string: The pin entered by a user. 6 digits - pinReference required
string: The pinReference. - trackingHeader
string: Tracking header to be able to search logs for a specific user requests. If not provided it will be generated. FE should store it for later user.
- accessToken required
- EeValidatePinResponse
object- pinValid
string: The validation status. - trackingHeader required
string: trackingHeader
- pinValid
- Entitlement
- deliveryType required
string(values: Stream, Download, StreamOrDownload, ProgressiveDownload, None) - exclusionRules
array: Any specific playback exclusion rules.- items ExclusionRule
- maxDownloads
integer: The maximum number of allowed downloads. - maxPlays
integer: The maximum number of allowed plays. - ownership required
string(values: Subscription, Free, Rent, Own, None) - playPeriod
integer: The length of time in minutes which the rental will last once played for the first time. - rentalPeriod
integer: The length of time in minutes which the rental will last once purchased. - resolution required
string(values: SD, HD-720, HD-1080, HD-4K, External, Unknown) - scopes required
array- items
string
- items
- activationDate
string: The date of activation. If no date is defined the entitlement has not be activated. - classification ClassificationSummary
- creationDate
string: The date the entitlement was created. - expirationDate
string: The date the entitlement expires. - itemId
string: The id of the item this entitlement is for. - itemType
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset): The type of item this entitlement is for. - mediaDuration
integer: The duration of the entitled media. - planId
string: The id of the plan this entitlement is for. - playCount
integer: How many times the media has been played. - remainingDownloads
integer: How many more downloads of this media are available.
- deliveryType required
- ExclusionRule
object: Defines playback exclusion rules for an Offer or Entitlement.- description
string - device
string: The device type that the exclusion rules apply to. - excludeAirplay
boolean: Prevent airplay from an apple device. - excludeChromecast
boolean: Prevent chromecasting. - excludeDelivery
string(values: Stream, Download, StreamOrDownload, ProgressiveDownload, None) - excludeMinResolution
string(values: SD, HD-720, HD-1080, HD-4K, External, Unknown)
- description
- ItemCustomMetadata
object: Custom metadata associated with an item.- name required
string: The name of the custom metadata. - value required
string: The value of the custom metadata.
- name required
- ItemDetail
- advisoryText
string: Advisory text about this item, related to the classification - availableEpisodeCount
integer: The number of available episodes in the season, if the item is a season. - availableSeasonCount
integer: The number of available seasons in the show, if the item is a show. - averageUserRating
number: The average user rating. - badge
string: The badge this item has. - channelShortCode
string: The channel short code, if the item is a channel. - classification ClassificationSummary
- contextualTitle
string: A contextually relative title to display after a parent title. - customFields
object: A map of custom fields defined by a curator for an item. - customId
string: A custom identifier for this item. - duration
integer: The duration of the media in seconds. - episodeCount
integer: The number of episodes in the season, if the item is a season. - episodeName
string: The full name of an episode. - episodeNumber
integer: The number of an episode, if the item is an episode. - genres
array: The array of genres this item belongs to.- items
string
- items
- hasClosedCaptions
boolean: Whether closed captioning is available. - id required
string: Unique identifier for an Item - images
object - offers
array: The array of available offers for this item.- items Offer
- path required
string: The path to the detail page of this item. Can be used to load the item detail page via the /page endpoint. - releaseYear
integer: The year this item was released - scopes
array: The scopes for this item- items
string
- items
- seasonId
string: The identifier of the season this item belongs to, if the item is an episode. - seasonNumber
integer: The number of a season, if the item is a season. - shortDescription
string: A truncated description of the item - showId
string: The identifier of the show this item belongs to, if the item is a season or episode. - showTitle
string: The title of the show this item belongs to, if the item is a season or episode. - subtype
string: Subtype of the item. Mainly used to identify different types whentype - tagline
string: The tagline of the item - themes
array: Gets themes associated with the item- items Theme
- title required
string: The display title of the item. - type required
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset): The type of item - watchPath
string: The path to watch this item, if the item is a watchable type, e.g. amovie,programandepisode. - copyright
string: Copyright information about this item - credits
array: A list of credits associated with this item.- items Credit
- customMetadata
array: An ordered list of custom name-value-pair item metadata.- items ItemCustomMetadata
- description
string: The description of this item. - distributor
string: The distributor of this item. - episodes ItemList
- eventDate
string: The optional date of an event. - genrePaths
array: An array of genre paths mapping to the values within thegenresarray from ItemSummary.- items
string
- items
- location
string: The optional location (e.g. city) of an event. - season ItemDetail
- seasons ItemList
- show ItemDetail
- totalUserRatings
integer: The total number of users who have rated this item. - trailers
array: A list of trailers associated with this item.- items ItemSummary
- venue
string: The optional venue of an event.
- advisoryText
- ItemDownloadable
object- downloadable required
boolean: is the item downloadable? - id required
string: Unique identifier for an Item
- downloadable required
- ItemDownloadableList
object: A list of items downloadable data.- items required
array: A list of items- items ItemDownloadable
- items required
- ItemDownloadableRequest
object- ids required
string: Comma-separated list of AXIS item ids.
- ids required
- ItemList
object: A pageable list of items.- customFields
object: A map of custom fields defined by a curator for a list. - description
string: A full description of this list. - id required
string: The id of this list - images
object - itemTypes
array: The types of items in the list- items
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset)
- items
- items required
array: A list of items- items ItemSummary
- listData ListData
- paging required Pagination
- parameter
string: If this list is parameterized, then this contains the parameter of the list in the formatname:value. - path required
string: The path of this list - shortDescription
string: A short description of this list. - size required
integer: The total size of the list - tagline
string: The tagline of the item. - themes
array- items Theme
- title
string: The title of this list
- customFields
- ItemPurchase
object- id required
string: The identifier of the purchased item. - ownership required
string(values: Subscription, Free, Rent, Own, None): The ownership of the purchased item. - resolution required
string(values: SD, HD-720, HD-1080, HD-4K, External, Unknown): The resolution of the purchased item. - title required
string: The title of the purchased item. - type required
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset): The type of item purchased.
- id required
- ItemSchedule
object- blackout
boolean: True if this schedule represents time when the channel is completely off air. - channelId required
string: The id of the channel item this schedule belongs to. - endDate required
string: The date and time this schedule ends. - featured
boolean: True if this is a featured item schedule. - id required
string - item ItemSummary
- live
boolean: True if this is a live event. - repeat
boolean: True if this has been aired previously on the same channel. - startDate required
string: The date and time this schedule starts.
- blackout
- ItemScheduleList
object- channelId required
string: The id of the channel the schedules belong to. - endDate required
string: The date and time this list of schedules ends. - schedules required
array: The list of item schedules.- items ItemSchedule
- startDate required
string: The date and time this list of schedules starts.
- channelId required
- ItemSummary
object- advisoryText
string: Advisory text about this item, related to the classification - availableEpisodeCount
integer: The number of available episodes in the season, if the item is a season. - availableSeasonCount
integer: The number of available seasons in the show, if the item is a show. - averageUserRating
number: The average user rating. - badge
string: The badge this item has. - channelShortCode
string: The channel short code, if the item is a channel. - classification ClassificationSummary
- contextualTitle
string: A contextually relative title to display after a parent title. - customFields
object: A map of custom fields defined by a curator for an item. - customId
string: A custom identifier for this item. - duration
integer: The duration of the media in seconds. - episodeCount
integer: The number of episodes in the season, if the item is a season. - episodeName
string: The full name of an episode. - episodeNumber
integer: The number of an episode, if the item is an episode. - genres
array: The array of genres this item belongs to.- items
string
- items
- hasClosedCaptions
boolean: Whether closed captioning is available. - id required
string: Unique identifier for an Item - images
object - offers
array: The array of available offers for this item.- items Offer
- path required
string: The path to the detail page of this item. Can be used to load the item detail page via the /page endpoint. - releaseYear
integer: The year this item was released - scopes
array: The scopes for this item- items
string
- items
- seasonId
string: The identifier of the season this item belongs to, if the item is an episode. - seasonNumber
integer: The number of a season, if the item is a season. - shortDescription
string: A truncated description of the item - showId
string: The identifier of the show this item belongs to, if the item is a season or episode. - showTitle
string: The title of the show this item belongs to, if the item is a season or episode. - subtype
string: Subtype of the item. Mainly used to identify different types whentype - tagline
string: The tagline of the item - themes
array: Gets themes associated with the item- items Theme
- title required
string: The display title of the item. - type required
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset): The type of item - watchPath
string: The path to watch this item, if the item is a watchable type, e.g. amovie,programandepisode.
- advisoryText
- ItvAssignBtTokenRequest
object- profileToken required
string: The ITV profile token - token required
string: The validated userToken.
- profileToken required
- ItvAssignMsisdnRequest
object- eeProductId required
string: Product id from /ee/offers - msisdn required
string: The validated msisdn. - profileToken required
string: The ITV profile token - trackingHeader required
string: trackingHeader
- eeProductId required
- ItvBillingHistory
object- payment_history required
array: The array of objects with subscription payment details.- items ItvBillingHistoryRecord
- payment_history required
- ItvBillingHistoryRecord
object- card required
object: The card info. - charge required
object: The amount charged. - invoice required
object: The object with invoice details. - subscription required
object: The object with subscription payment details.
- card required
- ItvBillingHistoryRequest
object- profileToken required
string: The ITV profile token.
- profileToken required
- ItvCancelSubscriptionRequest
object- profileToken required
string: The ITV profile token.
- profileToken required
- ItvCardDetails
object- card_type required
string: The payment card type (Visa/Mastercard/etc). - exp_month required
integer: Expiry date month. - exp_year required
integer: Expiry date year. - last4 required
string: The last 4 digit of card number.
- card_type required
- ItvChangeCardDetailsRequest
object- cardToken required
string: The credit card token. - profileToken required
string: The ITV profile token.
- cardToken required
- ItvChangeEmailRequest
object- email required
string: New email address for account/profile. - profileToken required
string: The ITV profile token.
- email required
- ItvChangeMarketingRequest
object- emailOptIn required
boolean: Updated marketing preferences for account/profile. - profileToken required
string: The ITV profile token.
- emailOptIn required
- ItvCurrentSubscription
object- cancelAtPeriodEnd required
boolean: The cancellation period end flag. - collectionMethod required
string: The description of payment collection method. - created required
integer: The creation timestamp. - currentPeriodEnd required
integer: The end of period timestamp. - currentPeriodStart required
integer: The start of period timestamp. - plan required
object: The plan used during subsribing. - status required
string: The status of subscription.
- cancelAtPeriodEnd required
- ItvDeleteAccountRequest
object- profileToken required
string: The ITV profile token.
- profileToken required
- ItvEntitlement
object- card_type
string: Start of subscription. - expiry required
string: Expiry of subscription. - plan required
object: Purchased plan data. - source required
string: Source platform of purchase. - subscriptionId required
string: Id of subscription.
- card_type
- ItvEntitlementCancelation
object- cancelled_at required
string: Cancelation datetime. - itvId required
string: Itv internal id. - source required
string: Source platform of cancelation. - subscriptionId required
string: Id of subscription.
- cancelled_at required
- ItvEntitlementPlan
object- cost required
integer: Source platform of purchase. - interval required
string(values: day, week, month, year, none): The type of billing period used. - trialLength required
integer: Given theintervalthis is how frequently it will run. e.g. every 2 weeks. - type required
string: Type of the plan.
- cost required
- ItvEntitlementsHistory
object- cancellations required
array: The results of availability checks. - entitlements required
array: The results of availability checks.- items ItvEntitlement
- cancellations required
- ItvFeatureFlag
object- enabled required
boolean: Is the feature enabled? - flag
string: Feature flag data.
- enabled required
- ItvGetCardDetailsRequest
object- profileToken required
string: The ITV profile token.
- profileToken required
- ItvGetDiscountResponse
object- currency
string: Payment currency. - description
string: Description - headline
string: Headline - id required
string: The if of a discount for a user. - initialCost
number: The initial cost. - longDescription
string: Long description - nickname
string: Discount nickname. - offerdurationperiod
string: How long the descount will be valid for. - shortDescription
string: Short description
- currency
- ItvPinAuthRequest
object- cookieType
string(values: Session, Persistent): If you specify a cookie type then a content filter cookie will be returned - pin required
string: The 4-digit parental control pin. - scopes
array: The scope(s) of the token(s) required.- items
string(values: Catalog, Commerce, Settings, Playback)
- items
- cookieType
- ItvPlanListItem
object- amount required
number: The price of a plan. If a free plan then undefined. - currency required
string: The currency a plan is offered in. - description required
string: The textual description. - id required
string: The identifier of a plan. - interval required
string(values: day, week, month, year, none): The type of billing period used. - intervalCount required
integer: Given theintervalthis is how frequently it will run. e.g. every 2 weeks. - nickname required
string: The title of a plan. - product required
string: The product description. - switchingText
string: The text to switch for. - trialPeriodDays
integer: How many days a trial period runs for a plan. Only valid ifhasTrialPeriodis true.
- amount required
- ItvPlans
object- plans required
array: The list of available plans.- items ItvPlanListItem
- plans required
- ItvProfileToken
object- profileToken required
string: The ITV profile token.
- profileToken required
- ItvProfileTokenRequest
object- password required
string: The password.
- password required
- ItvPurchase
object- customerId
string: The identifier of user in payment system. - planId required
string: The identifier of subscription plan. - subscriptionId
string: The identifier of subscription in payment system.
- customerId
- ItvPurchaseRequest
object- cardToken required
string: The credit card token. - planId required
string: The identifier of the plan to purchase. - profileToken required
string: The ITV profile token. - voucher
string: A coupon/voucher for a discount.
- cardToken required
- ItvSubscriptionState
object- effective_entitlements required
array: The array of entitlement objects.- items
object
- items
- failed_availability_checks required
array: The results of availability checks.- items
string
- items
- purchased required
array: The array of entitlement names.- items
string
- items
- source required
string: The payment provider (stripe/itunes)
- effective_entitlements required
- ItvUpdateProfileRequest
object- dateOfBirth
string: The date of birth. - email
string: The email address. - firstName
string: Last name. - lastName
string: First name. - postcode
string: The postal code. - profileToken required
string: The ITV profile token. - title
string: The title.
- dateOfBirth
- ItvUpgradePlanRequest
object- planId required
string: The identifier of the plan to purchase.
- planId required
- ItvVoucher
object- amountOff required
number: The absolute amount off. - currency required
string: The currency of a given discount. - duration required
string: The duration descriptor for a given discount. - durationInMonths required
integer: The duration in months for a given discount. - id required
string: The coupon/voucher. - longDescription required
string: The coupon/voucher long description. - percentOff required
number: The percentage off. - shortDescription required
string: The coupon/voucher short description. - valid required
boolean: The coupon/voucher validity.
- amountOff required
- ItvVoucherRequest
object- voucher required
string: The voucher.
- voucher required
- Language
object- code required
string: The ISO language code of the language e.g. "en-US". - label required
string: Display label for the language. - title required
string: Display title for the language.
- code required
- ListData
object: Extra data to accompany ItemList content. The (single) key in the object is- ContinueWatching ContinueWatchingListData
- MediaFile
object- channels
integer: The number of audio channels. - deliveryType required
string(values: Stream, Progressive, Download): The way in which the media file is delivered. - drm required
string: The type of drm used to encrypt the media. 'None' if unencrypted. - format required
string: The format the media was encoded in. - height required
integer: The height of the video media. - language required
string: The language code for the media, e.g. 'en'. - name required
string: The name of the media file. - resolution required
string(values: SD, HD-720, HD-1080, HD-4K, External, Unknown): The resolution of the video media. - url required
string: The url to access the media file. - width required
integer: The width of the video media.
- channels
- NavContent
object- imageType
string: The image type to target when rendering items of the list. - list ItemList
- title
string: The title of the embedded navigation content.
- imageType
- NavEntry
object- children
array: Child nav entries.- items NavEntry
- content NavContent
- customFields
object: A map of custom fields defined by a curator for a nav entry. - depth required
integer: The depth of the NavEntry (top level is 0) - featured
boolean: True if this is a featured menu item. - label
string: The text label for this nav entry. - path
string: The path this nav entry links to.
- children
- Navigation
object
- NextPlaybackItem
object- firstWatchedDate
string: Time when the item corresponding to the itemId passed in by the client was - lastWatchedDate
string: Time when the item corresponding to the itemId passed in by the client was - next ItemDetail
- sourceItemId required
string: The id of the item used to determine the next item to play. - suggestionType
string(values: StartWatching, ContinueWatching, RestartWatching, Sequential, None): Field indicating the type or reason behind the suggestion.
- firstWatchedDate
- Offer
- deliveryType required
string(values: Stream, Download, StreamOrDownload, ProgressiveDownload, None) - exclusionRules
array: Any specific playback exclusion rules.- items ExclusionRule
- maxDownloads
integer: The maximum number of allowed downloads. - maxPlays
integer: The maximum number of allowed plays. - ownership required
string(values: Subscription, Free, Rent, Own, None) - playPeriod
integer: The length of time in minutes which the rental will last once played for the first time. - rentalPeriod
integer: The length of time in minutes which the rental will last once purchased. - resolution required
string(values: SD, HD-720, HD-1080, HD-4K, External, Unknown) - scopes required
array- items
string
- items
- availability required
string(values: Available, ComingSoon) - customFields
object: A map of custom fields defined by a curator for an offer. - endDate
string - id
string - name
string - price required
number - startDate
string - subscriptionCode
string: The code of the subscription this offer is offered under, if any.
- deliveryType required
- OfferRights
object: The base type for both Offer and Entitlement.- deliveryType required
string(values: Stream, Download, StreamOrDownload, ProgressiveDownload, None) - exclusionRules
array: Any specific playback exclusion rules.- items ExclusionRule
- maxDownloads
integer: The maximum number of allowed downloads. - maxPlays
integer: The maximum number of allowed plays. - ownership required
string(values: Subscription, Free, Rent, Own, None) - playPeriod
integer: The length of time in minutes which the rental will last once played for the first time. - rentalPeriod
integer: The length of time in minutes which the rental will last once purchased. - resolution required
string(values: SD, HD-720, HD-1080, HD-4K, External, Unknown) - scopes required
array- items
string
- items
- deliveryType required
- Page
- id required
string: Unique identifier for the page. - isStatic required
boolean: True if this page is static and doesn't have any dynamic content to load. - isSystemPage required
boolean: True if this page is a system page type. - key
string: Key used to lookup a known page. - path required
string: Unique path for the page. - template required
string: Identifier for of the page template to render this page. - title required
string: Title of the page. - customFields
object: A map of custom fields defined by a curator for a page. - entries required
array: Entries of a page- items PageEntry
- item ItemDetail
- list ItemList
- metadata PageMetadata
- themes
array- items Theme
- id required
- PageEntry
object: Represents an entry of a Page.- customFields
object: A map of custom fields defined by a curator for a page entry. - id required
string: The unique identifier for a page entry. - images
object: The images for the page entry if any. - item ItemSummary
- list ItemList
- people
array: If 'type' is 'PeopleEntry' then this is the array of people to present.- items Person
- template required
string: Template type used to present the content of the PageEntry. - text
string: If 'type' is 'TextEntry' then this is the text to be represented. - title required
string: The name of the Page Entry. - type required
string(values: ItemEntry, ItemDetailEntry, ListEntry, ListDetailEntry, UserEntry, TextEntry, ImageEntry, CustomEntry, PeopleEntry): The type of PageEntry. Used to help identify what type of content will be presented.
- customFields
- PageMetadata
object: Metadata associated with a page. Primarily intended for SEO usage.- description
string - keywords
array- items
string
- items
- description
- PageSummary
object- id required
string: Unique identifier for the page. - isStatic required
boolean: True if this page is static and doesn't have any dynamic content to load. - isSystemPage required
boolean: True if this page is a system page type. - key
string: Key used to lookup a known page. - path required
string: Unique path for the page. - template required
string: Identifier for of the page template to render this page. - title required
string: Title of the page.
- id required
- Pagination
object- authorization PaginationAuth
- next
string: Path to load next page of data, or null if not available - options PaginationOptions
- page required
integer: The current page number. - previous
string: Path to load previous page of data, or null if not available. - size
integer: The current page size. - total required
integer: The total number of pages available given the current page size.
- PaginationAuth
object- scope required
string(values: Catalog, Commerce, Settings): The token scope required. - type required
string(values: UserAccount, UserProfile): The token type required to load the list.
- scope required
- PaginationOptions
object- completed
boolean: Items filtered by whether they've been fully watched or not. - itemType
string(values: movie, show, season, episode, program, link, trailer, channel, customAsset): Specific item type filter. - maxRating
string: The maximum rating (inclusive) of items returned, e.g. 'AUOFLC-PG'. - order
string(values: asc, desc): The applied sort order if any. - orderBy
string(values: a-z, release-year, date-added): The applied sort ordering property if any. - pageSize
integer: The number of items to return in a list page.
- completed
- PasswordResetEmailRequest
object- email required
string: The email address of the primary account profile to reset the password for.
- email required
- PasswordResetRequest
object- password required
string: The new password for the account. - resetToken required
string: The ITV reset token.
- password required
- PaymentMethod
object- balance
number: The balance of the wallet if the payment method is a wallet. - brand
string(values: Visa, MasterCard, AmericanExpress, Other): The brand of the card if the payment method is a card. - currency
string: The currency code of the wallet if the payment method is a wallet. - description required
string: A short description of a payment method. - expiryMonth
number: The expiry month of the card if the payment method is a card. - expiryYear
number: The expiry year of the card if the payment method is a card. - id required
string: The unique identifier of a payment method. - lastDigits
number: The last digits of the card if the payment method is a card. - type required
string(values: Card, Wallet): The type of payment method.
- balance
- Person
object- name required
string: The name of the person. - path required
string: The path to the person
- name required
- Plan
object- alias required
string: An alias for a plan. - benefits required
array: The list of benefits to display for a plan.- items
string
- items
- billingPeriodFrequency required
integer: Given thebillingPeriodTypethis is how frequently it will run. e.g. every 2 weeks. - billingPeriodType required
string(values: day, week, month, year, none): The type of billing period used. - currency required
string: The currency a plan is offered in. - customFields
object: A map of custom fields defined by a curator for a plan. - hasTrialPeriod required
boolean: True if a plan has a trial period, false if not. - id required
string: The identifier of a plan. - isActive required
boolean: True if a plan is active, false if its retired. - isFeatured required
boolean: True if a plan should be highlighted as featured, false if not. - isPrivate required
boolean: True if a plan should not be presented in the primary plan options, false if not. - price
number: The price of a plan. If a free plan then undefined. - revenueType required
string(values: TVOD, SVOD): The revenue type a plan targets. - subscriptionCode required
string: The subscription code a plan targets. - tagline required
string: The short tagline for a plan. - termsAndConditions required
string: The terms and conditions for a plan. - title required
string: The title of a plan. - trialPeriodDays required
integer: How many days a trial period runs for a plan. Only valid ifhasTrialPeriodis true. - type required
string(values: Free, Subscription): The type of plan.
- alias required
- PlanPurchase
object- id
string: The identifier of the purchased plan. - price
number: The price of the purchased plan. - subscriptionId
string: The identifier of the subscription membership to the plan. - title required
string: The title of the purchased plan. - type required
string(values: Free, Subscription): The type of plan purchased.
- id
- ProfileCreationRequest
object- languageCode
string: The code of the preferred language for the profile. - name required
string: The unique name of the profile. - pinEnabled
boolean: Whether an account pin is required to enter the profile. - purchaseEnabled
boolean: Whether the profile can make purchases with the account payment options. - segments
array: The segments a profile should be placed under- items
string
- items
- languageCode
- ProfileDetail
- color
string: Hex color value assigned to the profile. - id required
string: The id of the profile. - isActive required
boolean: Whether the profile is active or not. - languageCode
string: The code of the preferred language for the profile. - marketingEnabled required
boolean: Whether the profile has opted in or out of marketing material. - maxRatingContentFilter ClassificationSummary
- minRatingPlaybackGuard ClassificationSummary
- name required
string: The unique name of the profile. - pinEnabled required
boolean: Whether a pin is required to enter the profile. - purchaseEnabled required
boolean: Whether the profile can make purchases with the account payment options. - segments required
array: The segments a profile has been placed under- items
string
- items
- bookmarked required
object: A map of bookmarked itemIds => created date - rated required
object: A map of rated itemIds => rating out of 10 - watched required
object: A map of watched itemIds => last watched position
- color
- ProfileSummary
object- color
string: Hex color value assigned to the profile. - id required
string: The id of the profile. - isActive required
boolean: Whether the profile is active or not. - languageCode
string: The code of the preferred language for the profile. - marketingEnabled required
boolean: Whether the profile has opted in or out of marketing material. - maxRatingContentFilter ClassificationSummary
- minRatingPlaybackGuard ClassificationSummary
- name required
string: The unique name of the profile. - pinEnabled required
boolean: Whether a pin is required to enter the profile. - purchaseEnabled required
boolean: Whether the profile can make purchases with the account payment options. - segments required
array: The segments a profile has been placed under- items
string
- items
- color
- ProfileTokenRequest
object- cookieType
string(values: Session, Persistent): If you specify a cookie type then a content filter cookie will be returned - pin
string: The pin associated with this profile, if any. - profileId required
string: The id of the profile the token should grant access rights to. - scopes required
array: The scope(s) of the token(s) required.- items
string(values: Catalog, Commerce, Settings)
- items
- cookieType
- ProfileUpdateRequest
object- languageCode
string: The code of the preferred language for the profile. - name
string: The unique name of the profile. - pinEnabled
boolean: Whether an account pin is required to enter the profile. - purchaseEnabled
boolean: Whether the profile can make purchases with the account payment options. - segments
array: The segments a profile should be placed under- items
string
- items
- languageCode
- Purchase
object- authorizationDate
string: The date the purchase was authorized. - creationDate required
string: The date the purchase was created. - currency required
string: The currency code used to make the purchase. - id required
string: The identifier of the purchase. - item ItemPurchase
- paymentMethodId
string: The identifier of the payment method used to make the purchase. - plan PlanPurchase
- total required
number: The total cost of the purchase.
- authorizationDate
- PurchaseRequest
object- itemId
string: The identifier of the item to purchase. - offerId
string: The identifier of the item offer to purchase. - paymentMethodId
string: The identifier of the payment method to use. - planId
string: The identifier of the plan to purchase.
- itemId
- RegistrationRequest
object- email required
string - firstName
string - languageCode
string: The code of the preferred language for the primary profile. - lastName
string - marketing
boolean: Whether to receive marketing material or not. Default to true. - password required
string - pin
string: The primary account pin. - segments
array: The segments to apply to the primary profile.- items
string
- items
- email required
- SamsungPreview
object- expires
integer: For public preview only - expires_only
boolean: For public preview only - sections required
array: Preview sections- items
object- position
integer: Section position. If specified, sections are shown in ascending position order. - tiles required
array: Tiles within the section- items
object- action_data required
string: Data to send to the application when the tile is clicked - display_from
string: Time to begin showing the tile - display_until
string: Time to stop showing the tile - image_ratio required
string: Thumbnail image aspect ratio - image_url required
string: Thumbnail image URL - is_playable required
boolean: If "true", a "Play" icon is shown over the thumbnail image - position
integer: Section position. If specified, sections are shown in ascending position order - subtitle
string: Tile subtitle - title
string: Tile title
- action_data required
- items
- title
string: Section title
- position
- items
- expires
- SearchResults
object
- ServiceError
object- code
integer: An optional code classifying the error. Should be taken in the context of the http status code. - message required
string: A description of the error.
- code
- SingleSignOnRequest
object- cookieType
string(values: Session, Persistent): If you specify a cookie type then a content filter cookie will be returned - linkAccounts
boolean: When a user attempts to sign in using single-sign-on, we may find an account created - provider required
string(values: Facebook): The third party single-sign-on provider. - scopes
array: The scope(s) of the tokens required.- items
string(values: Catalog, Commerce, Settings, Playback)
- items
- token required
string: A token from the third party single-sign-on provider e.g. an identity token from Facebook.
- cookieType
- Subscription
object- code required
string: The unique subscription code. - endDate
string: The end date of a subscription. - id
string: Unique identifier for the subscription. - isTrialPeriod required
boolean: True if a subscription is in its trial period, false if not. - planId required
string: The plan a subscription belongs to. - startDate required
string: The start date of a subscription. - status required
string(values: Active, Cancelled, Lapsed, Expired, None): The status of a subscription.
- code required
- SubscriptionDetails
object- itvData_purchased required
object: The ITV purchased subscription data.
- itvData_purchased required
- Theme
object- colors required
array: The list of colors defined for the theme.- items ThemeColor
- type required
string(values: Background, Text, Custom): The type of theme.
- colors required
- ThemeColor
object- name required
string: The name of the theme color. - opacity
number: The opacity of the theme color from 0 to 1. - value required
string: The hex value of the theme color.
- name required
- TokenRefreshRequest
object- cookieType
string(values: Session, Persistent): If you specify a cookie type then a content filter cookie will be returned - token required
string: The token to refresh.
- cookieType
- UserRating
object- itemId required
string: The id of the item rated. - rating required
integer: The rating out of 10
- itemId required
- Watched
object- firstWatchedDate required
string - isFullyWatched
boolean: True - if the item is fully watched, False - otherwise. - itemId
string: The id of the item watched. - lastWatchedDate required
string - position required
integer: The last playhead position watched for the item.
- firstWatchedDate required