RightsLockerDataGet()

This API is used to fetch a paginated list of RightsTokens for a given AccountID. The number of RightsTokens returned per page can be controlled using the FilterOffset and FilterCount query parameters. The maximum FilterCount value is 1000. Filtering RightsTokens by a datetime is also useful cache refreshing purposes. You can filter RightsLockerDataGet() with the OnOrAfter query parameter using a ISO 8601 formatted datetime without timezone information (e.g. yyyy-mm-ddThh:mm:ss).

API URL:

[BaseURL]/Account/{AccountID}/RightsToken/List[?FilterOffset={FilterOffset}&FilterCount={FilterCount}&response={ResponseType}&OnOrAfter={OnOrAfter}]

Request Method:

GET

Request Parameters:

AccountID is the unique identifier for an account
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
reference is the reference type to return (default value is reference)

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
reference

(reference|token|extreference) the extreference reference argument returns an extended reference including Status, ALID, ContentID and StreamWebLoc.

Headers:

Authorization: SAML2 assertion=[Assertion]

Response Format

XML type:

dece:RightsTokenList
- dece:RightsToken
- dece:RightsTokenReference

Status Code:

HTTP 200

Errors

OnOrAfterDateFormatIsInvalid
- The filter OnOrAfter is not valid
- HTTP 400

Example

Request a RightsToken list with response type extreference

The following example is a request for a paginated list of RightsTokens in an account returned in the extreference response format.

Sample Request:

POST /rest/2015/02/Account/urn:dece:accountid:org:dece:F9DCC1F0E56044918528A9235066A106/RightsToken/List?response=extreference 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:F9DCC1F0E56044918528A9235066A106" FilterClass="urn:dece:type:viewfilter:lastmodifieddate" FilterCount="3" FilterMoreAvailable="false" FilterOffset="0" RightsLockerID="urn:dece:rightslockerid:org:dece:705E63F92CD2462383E5C803F2B79B45">
  <RightsToken RightsTokenID="urn:dece:rightstokenid:org:dece:9EF5BE47578A4598A868BFED981CB325">
    <RightsTokenInfo ALID="urn:dece:alid:org:dece:test:alid_with_sd_hd_uhd" ContentID="urn:dece:cid:org:dece:test:cid_with_en_de">
      <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>
      </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-12T19:07:23.424Z">
          <Value>urn:dece:type:status:active</Value>
        </Current>
      </ResourceStatus>
      <StreamWebLoc>
        <Location>https://example.com/p/streaminglink</Location>
      </StreamWebLoc>
    </RightsTokenInfo>
  </RightsToken>
  <RightsToken RightsTokenID="urn:dece:rightstokenid:org:dece:D5FDFEFBA9EB44D8BD6BAB676D4EE8D0">
    <RightsTokenInfo ALID="urn:dece:alid:org:dece:test:alid_with_sd_hd_uhd" ContentID="urn:dece:cid:org:dece:test:cid_with_en_de">
      <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>
      </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-12T19:07:23.424Z">
          <Value>urn:dece:type:status:active</Value>
        </Current>
      </ResourceStatus>
      <StreamWebLoc>
        <Location>https://example.com/p/streaminglink</Location>
      </StreamWebLoc>
    </RightsTokenInfo>
  </RightsToken>
  <RightsToken RightsTokenID="urn:dece:rightstokenid:org:dece:FA46133ACF144BA19BEDFCB979317971">
    <RightsTokenInfo ALID="urn:dece:alid:org:dece:test:alid_with_sd_hd_uhd" ContentID="urn:dece:cid:org:dece:test:cid_with_en_de">
      <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>
      </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-12T19:07:23.424Z">
          <Value>urn:dece:type:status:active</Value>
        </Current>
      </ResourceStatus>
      <StreamWebLoc>
        <Location>https://example.com/p/streaminglink</Location>
      </StreamWebLoc>
    </RightsTokenInfo>
  </RightsToken>
</RightsTokenList>