AccountGet()

This API call is used to retrieve Account descriptive information for a unique AccountID.

API URL:

[BaseURL]/Account/{AccountID}

Request Method:

GET

Request Parameters:

• AccountID is the unique identifier for an account

Request Format

Headers:

• Authorization: SAML2 assertion=[Assertion]

Response Format

XML type:

• dece:Account-type

Status Code:

• HTTP 200 OK

Errors

• SecurityContextForbidden
  • The request is not authorized
  • HTTP Status Code: 403
• AccountIdUnmatched
  • The specified AccountId did not match the AccountId in the assertion
  • HTTP Status Code: 403
• NotFound
  • The account with the specified AccountId was not found
  • HTTP Status Code: 404

Example

Get an Account by AccountID

The following example retrieves an Accounts descriptive information by a unique AccountID.

Sample Request:

GET /rest/2015/02/Account/urn:dece:accountid:org:dece:98C61D79D9644410751EAF34C13BADA8 HTTP/1.1
Host: api.uvvu.com
Accept: application/xml
Authorization: SAML2 assertion=[Assertion]

Sample Response:

HTTP/1.1 200 OK
Content-type: application/xml; charset=UTF-8
Etag: [Etag]
Last-modified: [LastModified]
Vary: Authorization,Accept-Encoding

<?xml version="1.0" encoding="UTF-8"?>
<Account xmlns="http://www.decellc.org/schema/2015/03/coordinator" AccountID="urn:dece:accountid:org:dece:98C61D79D9644410751EAF34C13BADA8">
    <DisplayName>John's Account</DisplayName>
    <Country>US</Country>
    <RightsLockerID>urn:dece:rightslockerid:org:dece:20BD4835693046C6A158C11E9AF954F9</RightsLockerID>
    <UserList>
        <UserReference>urn:dece:userid:org:dece:A8C61D79D9644410751EAF34C13BADA8</UserReference>
    </UserList>
    <ResourceStatus>
        <Current CreatedBy="urn:dece:org:org:dece:falcon:retailer" CreationDate="2017-05-21T19:24:38.351Z">
            <Value>urn:dece:type:status:active</Value>
        </Current>
    </ResourceStatus>
</Account>

See Also

• AccountUserCreate()
• AccountMerge()
• AccountUpdate()
• AccountDelete()