AccountUpdate()

The AccountUpdate API is used to update an Account entry.

The AccountUpdate API can be used to modify the Account’s DisplayName and Country properties when the Web Portal role is composed with a full-access user access level.

Account data can be also be updated by Nodes on behalf of a properly authenticated full-access User.

The Coordinator SHALL generate an e-mail notice to all full-access Users indicating that the Account has been updated.

API URL:

[BaseURL]/Account/{AccountID}

Request Method:

PUT

Request Parameters:

• AccountID is the unique identifier for an Account

Request Format

XML type:

• dece:Account-type

Required information:

• Account
  • DisplayName
  • Country

Headers:

• Authorization: SAML2 assertion=[Assertion]

Response Format

Status Code:

• HTTP 200 OK

Errors

• SecurityContextForbidden
  • The request is not authorized
  • HTTP Status Code: 403
• CountryCannotBeChangedOnceSet
  • Requesting Node cannot change the /Account/Country
  • HTTP Status Code: 400
• NotFound
  • The account with the specified AccountId was not found
  • HTTP Status Code: 404

Example

Update Account DisplayName

The following example updates an Account DisplayName.

Sample Request:

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

<?xml version="1.0" encoding="UTF-8"?>
<Account xmlns="http://www.decellc.org/schema/2015/03/coordinator" xmlns:ns2="http://www.movielabs.com/schema/md/v2.3/md" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#" xmlns:ns4="http://www.w3.org/2001/04/xmlenc#">
    <DisplayName>test_-_cl-660b5189-5a45-48b3-845f-b537bd57e319</DisplayName>
    <Country>US</Country>
</Account>

Sample Response:

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

See Also

• AccountUserCreate()
• AccountMerge()
• AccountGet()
• AccountDelete()