RightsTokenDataGet()

This API is used to fetch a list of RightsTokens for a given Account and LogicalAsset mapping (ALID). The purpose of this request is to list the media profiles (SD, HD, UHD) allowed for this entitlement.

API URL:

[BaseURL]/Account/{AccountID}/RightsToken/ByMedia/{ALID}?FilterOffset={FilterOffset}&FilterCount={FilterCount}&OnOrAfter={OnOrAfter}]

Request Method:

GET

Request Parameters:

AccountID is the unique identifier for an Account
ALID is the identifier for a LogicalAsset mapping
FilterOffset is the offset position for pagination (default value is 0)
FilterCount is the maximum number of RightsTokens to return in the response list (default value is 1000)
OnOrAfter is the filter for RightsTokens created or modified on or after as specified ISO datetime

Request Format

Optional information:

FilterOffset

Any integer greater than 0. This parameter is used to exclude RightsTokens from the response list which have been returned in a previous request.
FilterCount

Any integer greater than 1. This parameter is used to specify the maximum number of RightsTokens to include in the response list.
OnOrAfter

Any ISO datetime string in the form yyyy-mm-ddThh:mm:ss

Headers:

Authorization: SAML2 assertion=[Assertion]

Response Format

XML type:

dece:RightsTokenList

Status Code:

HTTP 200

Example

Request a list of RightsTokens matching the given ALID

The following example requests a list of all known RightsTokens for an AccountID which match an ALID.

Sample Request:

GET /rest/2015/02/Account/urn:dece:accountid:org:dece:3F5AF92DB1064BA483490588E16AA327/RightsToken/ByMedia/urn:dece:alid:org:dece:test:alid_with_sd_hd_uhd HTTP/1.1
Host: api.uvvu.com
Accept: application/xml
Authorization: SAML2 assertion=[Assertion]

Sample Response:

HTTP/1.1 200
Date: [Date]
Content-Type: application/xml
X-transaction-info: [TransactionInfo]

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RightsTokenList xmlns="http://www.decellc.org/schema/2015/03/coordinator" AccountID="urn:dece:accountid:org:dece:3F5AF92DB1064BA483490588E16AA327" FilterClass="urn:dece:type:viewfilter:lastmodifieddate" FilterCount="1" FilterMoreAvailable="false" FilterOffset="0" RightsLockerID="urn:dece:rightslockerid:org:dece:1CFF7EACD996496E9330DA3C2DABE53E">
  <RightsToken RightsTokenID="urn:dece:rightstokenid:org:dece:2CF84DCD683B48F49E48B6ADE89933D0">
    <RightsTokenInfo ALID="urn:dece:alid:org:dece:test:alid_with_sd_hd_uhd" ContentID="urn:dece:cid:org:dece:test:cid_with_en_de">
      <SoldAs>
        <DisplayName Language="en">Test Title</DisplayName>
        <ContentID>urn:dece:cid:org:dece:test:cid_with_en_de</ContentID>
        <ContentID>urn:dece:cid:org:dece:test:cid_with_en_de</ContentID>
      </SoldAs>
      <RightsProfiles>
        <PurchaseProfile MediaProfile="urn:dece:type:mediaprofile:sd">
          <CanDownload>true</CanDownload>
          <CanStream>true</CanStream>
        </PurchaseProfile>
        <PurchaseProfile MediaProfile="urn:dece:type:mediaprofile:hd">
          <CanDownload>true</CanDownload>
          <CanStream>true</CanStream>
        </PurchaseProfile>
        <PurchaseProfile MediaProfile="urn:dece:type:mediaprofile:uhd">
          <CanDownload>true</CanDownload>
          <CanStream>true</CanStream>
        </PurchaseProfile>
      </RightsProfiles>
      <ResourceStatus xmlns="http://www.decellc.org/schema/2015/03/coordinator">
        <Current CreatedBy="urn:dece:org:org:dece:iot:falcon-a1:retailer" CreationDate="2017-06-22T17:21:59.617Z">
          <Value>urn:dece:type:status:active</Value>
        </Current>
      </ResourceStatus>
      <StreamWebLoc>
        <Location>https://example.com/p/streaminglin</Location>
      </StreamWebLoc>
    </RightsTokenInfo>
  </RightsToken>
</RightsTokenList>