RightsTokenUpdate()

This API is used to update an existing RightsToken.

API URL:

[BaseURL]/Account/{AccountID}/RightsToken/{RightsTokenID}

Request Method:

PUT

Request Parameters:

• AccountID is the unique identifier for an Account
• RightsTokenID is the unique identifier for a RightsToken

Request Format

XML type:

• dece:RightsTokenFull

Required information:

• RightsTokenFull
  • @ALID
  • @ContentID
  • RightsLockerID
  • RightsProfiles
    • PurchaseProfile

      • @MediaProfile

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

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

Optional information:

• /RightsTokenData/SoldAs

  Optional metadata for Retailer usage

• /RightsTokenData/PurchaseInfo/RetailerTransaction

  Optional metadata for Retailer usage

• /RightsTokenData/PurchaseInfo/TransactionType

  If not provided, the value is not updated

Headers:

• Authorization: SAML2 assertion=[Assertion]

Response Format

Status Code:

• HTTP 200

Errors

• RightsLockerIDInRequestDoNotMatchAccountRightsLockerID
  • The rights locker ID does not match.
  • HTTP Status Code: 400
• SDContentProfileForLogicalAssetNotAllowed
  • The standard-definition content profile is not allowed for the logical asset (ALID)
  • HTTP Status Code: 403
• HDContentProfileForLogicalAssetNotAllowed
  • The HD content profile is not allowed for the logical asset (ALID)
  • HTTP Status Code: 403
• UHDContentProfileForLogicalAssetNotAllowed
  • The UHD content profile is not allowed for the logical asset (ALID)
  • HTTP Status Code: 403
• AlidCidMappingNotFound
  • The logical asset (ALID) is not mapped to the provided ContentID
  • HTTP Status Code: 404
• ContentIDNotFound
  • The ContentID does not match any metadata known to the Coordinator
  • HTTP Status Code: 404

Example

Updating a RightsToken

The following example illustrates updating a RightsToken item with the minimal required elements.

Sample Request:

PUT /rest/2015/02/Account/urn:dece:accountid:org:dece:14CE562A88A848E4BBFF7F338093C643/RightsToken/urn:dece:rightstokenid:org:dece:D6A544EAEEF04BADAB811AFDD2C4F1A2 HTTP/1.1
Host: api.uvvu.com
Content-type: application/xml
Authorization: SAML2 assertion=[Assertion]

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RightsTokenFull xmlns="http://www.decellc.org/schema/2015/03/coordinator" 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>http://example.com</Location>
  </StreamWebLoc>
  <PurchaseInfo>
    <NodeID>urn:dece:org:org:dece:iot:falcon-a1:retailer</NodeID>
    <PurchaseAccount>urn:dece:accountid:org:dece:14CE562A88A848E4BBFF7F338093C643</PurchaseAccount>
    <PurchaseUser>urn:dece:userid:org:dece:BA919C10042E4BBA92840C2E715EAA67</PurchaseUser>
    <PurchaseTime>2017-06-22T15:12:03.000</PurchaseTime>
  </PurchaseInfo>
  <RightsLockerID>urn:dece:rightslockerid:org:dece:2F90F6574DC94DA386727970830B329A</RightsLockerID>
</RightsTokenFull>'

Sample Response:

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

See Also

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