AccountUserCreate()

This API call is used to create both an Account and its first User.

API URL:

[BaseURL]/Account

Request Method:

POST

Request Format

XML type:

dece:Account-type

Required information:

Account
- DisplayName
- Country
- UserList
  - User
    - @UserClass
      
      Must be set to urn:dece:role:user:class:full
    - Name
      - GivenName
      - SurName
    - ContactInfo
      - PrimaryEmail
        
        Value
    - Credentials
      - Username

Optional information:

/Account/UserList/User/Languages/Language

If not provided, language will be selected based on the Account’s country.
/Account/UserList/User/Credentials/Password

If not provided, a random password will be generated.

Response Format

Status Code:

HTTP 201 Created

Headers:

Location: [BaseURL]/Account/{AccountID}/User/{UserID}

A reference to the newly created User

Errors

ParserException
- Invalid XML
- /Account element is missing
- /Account/UserList/User element is missing
- /Account/UserList/User/Credentials is missing
- HTTP Status Code: 400 Bad Request
UserInformationRequired
- /Account/UserList/User information was not provided
- HTTP Status Code: 400 Bad Request
FirstUserMustBeCreatedWithFullAccessPrivilege
- /Account/UserList/User/@UserClass was not set to urn:dece:role:user:class:full
- HTTP Status Code: 400 Bad Request
AccountUsernameRegistered
- /Account/UserList/User/Credentials/Username is already registered
- HTTP Status Code: 400 Bad Request
AccountDisplayNameNotValid
- /Account/DisplayName was invalid
- HTTP Status Code: 400 Bad Request
AccountCountryCodeNotValid
- /Account/Country was invalid
- HTTP Status Code: 400 Bad Request
AccountUserGivenNotValid
- /Account/UserList/User/Name/GivenName is not valid
- HTTP Status Code: 400 Bad Request
AccountUserSurnameNotValid
- /Account/UserList/User/Name/Surname is not valid
- HTTP Status Code: 400 Bad Request
AccountUserPrimaryEmailNotValid
- /Account/UserList/User/ContactInfo/PrimaryEmail/Value is not valid
- HTTP Status Code: 400 Bad Request
AccountUsernameNotValid
- /Account/UserList/User/Credentials/Username is not valid
- HTTP Status Code: 400 Bad Request
UserListCannotHaveMoreThanOneUser
- /Account/UserList contained more than one user
- HTTP Status Code: 400 Bad Request

Example

Create a new Account and the first full access User

The following example creates a new Account and the first full access User. Here we also set the Users Password (/Account/UserList/User/Credentials/Password) and Language preference (/Account/UserList/User/Languages/Language).

Sample Request:

POST /rest/2015/02/Account HTTP/1.1
Host: api.uvvu.com
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Account xmlns="http://www.decellc.org/schema/2015/03/coordinator">
  <DisplayName>John's Account</DisplayName>
  <Country>US</Country>
  <UserList>
    <User UserClass="urn:dece:role:user:class:full">
      <Name>
        <GivenName>John</GivenName>
        <SurName>Smith</SurName>
      </Name>
      <ContactInfo>  
        <PrimaryEmail>
          <Value>JohnK@anymail.com</Value>  
        </PrimaryEmail>
      </ContactInfo>
      <Languages>
        <Language>en-US</Language>
      </Languages>
      <Credentials>
        <Username>john_the_user</Username>    
        <Password>Secret.123</Password>
      </Credentials>
    </User>
  </UserList>
</Account>

Sample Response:

HTTP/1.1 200
Date: [Date]
Location: https://api.uvvu.com/rest/2015/02/Account/urn:dece:accountid:org:dece:98C61D79D9644410751EAF34C13BADA8/User/urn:dece:userid:org:dece:A8C61D79D9644410751EAF34C13BADA8
X-transaction-info: [TransactionInfo]