AccountDelete()

This API call is used to delete an Account for a unique AccountID.

It changes the Account status to urn:dece:type:status:deleted. This allows Account deletion to be reversed (by changing the Account status to urn:dece:type:status:active).

None of the statuses of any of the Account’s associated elements (for example, Users or Rights Tokens) SHALL be changed.

Account deletion may be initiated only by a full-access User belonging to that Account.

In order for any resource within an Account to be considered active (or any other non-deleted status), the Account SHALL be active.

When Account deletion has been completed, any outstanding Security Tokens issued to any and all Users belonging to the deleted Account are invalidated.

API URL:

[BaseURL]/Account/{AccountID}

Request Method:

DELETE

Request Parameters:

Request Format

Headers:

Response Format

Status Code:

Errors

Example

Delete an Account by AccountID

The following example deletes an Account by a known AccountID

Sample Request:

DELETE /rest/2015/02/Account/urn:dece:accountid:org:dece:D7ED9F8B69F24BB9920BFB05804850DC HTTP/1.1
Host: api.uvvu.com
Authorization: SAML2 assertion=[Assertion]

Sample Response:

HTTP/1.1 200 OK
Date: [Date]
X-transaction-info: [TransactionInfo]

Standard access User attempts to delete an Account by AccountID

The following AccountDelete() request is blocked due to requestor privileges.

Sample Request:

DELETE /rest/2015/02/Account/urn:dece:accountid:org:dece:D7ED9F8B69F24BB9920BFB05804850DC HTTP/1.1
Host: api.uvvu.com
Authorization: SAML2 assertion=[Assertion]

Sample Response:

HTTP/1.1 403 Forbidden
Date: [Date]
X-transaction-info: [TransactionInfo]

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ErrorList xmlns="http://www.decellc.org/schema/2015/03/coordinator">
    <Error ErrorID="urn:dece:errorid:org:dece:RequestorPrivilegeInsufficient">
        <Reason Language="en">Only a full-access user can perform this action.</Reason>
        <OriginalRequest>https://api.uvvu.com/rest/2015/02/Account/urn:dece:accountid:org:dece:D7ED9F8B69F24BB9920BFB05804850DC</OriginalRequest>
    </Error>
</ErrorList>

See Also