RightsTokenListCreate()

This API is used to create many RightsTokens in one call. The maximum number of c:RightsTokenList/c:RightsToken allowed in this call is 60.

API URL:

[BaseURL]/rest/2015/02/Account/{AccountID}/RightsToken/List

Request Method:

POST

Request Parameters:

• AccountID is the unique identifier for an account

Request Format

XML type:

• dece:RightsTokenList
  • dece:RightsToken

Required information:

• RighstTokenList
  • @AccountID
  • RightsToken
    • RightsTokenData
      • @ALID
      • @ContentID
      • RightsProfiles
        • PurchaseProfile

          • @MediaProfile

            At least urn:dece:type:mediaprofile:sd is required

      • StreamWebLoc
        • Location
      • PurchaseInfo
        • NodeID
        • PurchaseAccount
        • PurchaseUser
        • PurchaseTime

Optional information:

• /RightsTokenList/RightsToken/RightsTokenData/SoldAs

  Optional metadata for Retailer usage

• /RightsTokenList/RightsToken/RightsTokenData/PurchaseInfo/RetailerTransaction

  Optional metadata for Retailer usage

• /RightsTokenList/RightsToken/RightsTokenData/PurchaseInfo/TransactionType

  If not provided, the value is set to urn:dece:type:transaction:category1:e

Headers:

• Authorization: SAML2 assertion=[Assertion]

Response Format

Status Code:

• HTTP 201

Headers:

• Location: /Account/{AccountID}/RightsToken/List?OnOrAfter={OnOrAfter}&response=reference

Errors

• RightsTokenListWithEmptyData
  • RightsTokenListCreate does not have RightsTokens
  • HTTP Status Code: 400
• ExceededTheMaximumNoOfRightsToken
  • RightsTokenListCreate exceeds the maximum number of RightsTokens
  • HTTP Status Code: 400

Example

Create 3 RightsTokens

The following example creates 3 RightsTokens in a single RightsTokenListCreate() call.

Sample Request:

POST /rest/2015/02/Account/urn:dece:accountid:org:dece:8A52C7E849574BD199365A71AC1C29E2/RightsToken/List HTTP/1.1
Host: api.uvvu.com
Accept: application/xml
Authorization: SAML2 assertion=[Assertion]

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RightsTokenList xmlns:md="http://www.movielabs.com/md" xmlns="http://www.decellc.org/schema/2015/03/coordinator" AccountID="urn:dece:accountid:org:dece:8A52C7E849574BD199365A71AC1C29E2" RightsLockerID="urn:dece:rightslockerid:org:dece:A8EB74771AFE45DD853E407767265831">
  <RightsToken>
    <RightsTokenData 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>
      </RightsProfiles>
      <StreamWebLoc>
        <Location>https://example.com/p/streaminglink</Location>
      </StreamWebLoc>
      <PurchaseInfo>
        <NodeID>urn:dece:org:org:dece:iot:falcon-a1:retailer</NodeID>
        <PurchaseAccount>urn:dece:accountid:org:dece:8A52C7E849574BD199365A71AC1C29E2</PurchaseAccount>
        <PurchaseUser>urn:dece:userid:org:dece:CD514DB2715048A29DCB735B0BBA31EC</PurchaseUser>
        <PurchaseTime>2017-06-22T15:12:03.000</PurchaseTime>
      </PurchaseInfo>
    </RightsTokenData>
  </RightsToken>
  <RightsToken>
    <RightsTokenData 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>
      </RightsProfiles>
      <StreamWebLoc>
        <Location>https://example.com/p/streaminglink</Location>
      </StreamWebLoc>
      <PurchaseInfo>
        <NodeID>urn:dece:org:org:dece:iot:falcon-a1:retailer</NodeID>
        <PurchaseAccount>urn:dece:accountid:org:dece:8A52C7E849574BD199365A71AC1C29E2</PurchaseAccount>
        <PurchaseUser>urn:dece:userid:org:dece:CD514DB2715048A29DCB735B0BBA31EC</PurchaseUser>
        <PurchaseTime>2017-06-22T15:12:03.000</PurchaseTime>
      </PurchaseInfo>
    </RightsTokenData>
  </RightsToken>
  <RightsToken>
    <RightsTokenData 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>
      </RightsProfiles>
      <StreamWebLoc>
        <Location>https://example.com/p/streaminglink</Location>
      </StreamWebLoc>
      <PurchaseInfo>
        <NodeID>urn:dece:org:org:dece:iot:falcon-a1:retailer</NodeID>
        <PurchaseAccount>urn:dece:accountid:org:dece:8A52C7E849574BD199365A71AC1C29E2</PurchaseAccount>
        <PurchaseUser>urn:dece:userid:org:dece:CD514DB2715048A29DCB735B0BBA31EC</PurchaseUser>
        <PurchaseTime>2017-06-22T15:12:03.000</PurchaseTime>
      </PurchaseInfo>
    </RightsTokenData>
  </RightsToken>
</RightsTokenList>

Sample Response:

HTTP/1.1 200
Date: [Date]
Content-Type: application/xml
Location: https://api.uvvu.com/rest/2015/02/Account/urn:dece:accountid:org:dece:8A52C7E849574BD199365A71AC1C29E2/RightsToken/List?OnOrAfter=2017-06-22T17:22:14&response=reference
X-transaction-info: [TransactionInfo]

See Also

• RightsLockerDataGet()
• RightsTokenCreate()
• RightsTokenDataGet()
• RightsTokenDelete()
• RightsTokenGet()
• RightsTokenUpdate()