Go to full article


Overview

This API is used to determine whether a specific Cumulus username is available for use (or already occupied).

Usage

To check the availability of a specific Cumulus username:

  1. Create a "CheckUsernameAvailability" request
  2. Specify the "Username" to check
  3. Authorise the request with valid API credentials

WSDL

https://api.emersion.com.au/Accounts.wsdl

Operation name.

CheckUsernameAvailability



Business Rules

  • Username parameter must be provided
  • Caller must have a Cumulus username realm
  • Username must not include the realm in the call. 


The system will append the caller's realm to the username. If a realm is provided, the API will return an undesired result.


  • The username must not exceed 80 characters after the caller's realm is appended by the system.
  • Only usernames pertaining to the caller realm are matched.
  • Only Cumulus usernames pertaining to the End User Portal instance would be matched.




SOAP Example


Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:CheckUsernameAvailability>
       <urn:Username>user_name</urn:Username>  
      </urn:CheckUsernameAvailability>
   </soapenv:Body>
</soapenv:Envelope>


Field Descriptions

All field names are case sensitive. Check enumerated values in the descriptions to confirm capitalisation and spacing. See field types for additional information..

NameDescriptionRequired?Field Type

Character

limit

Value Examples
Username
A Cumulus username without the log in realm.YesStringUsername, after appending caller realm, should not exceed 80 characters

user_name



Error Handling

Error MessageDescription

Username must be provided

This is thrown when user does not provide Username parameter or the provided Username parameter is blank

Caller does not have a Cumulus User Realm assigned.

Cannot validate username.

This is thrown when caller does not have a Cumulus username realm

Username too long.

After appending realm, the length of the

username exceeds maximum allowed length.

This is thrown when provided username, after appending realm, exceeds 80 characters

Could not find a Product Rate Card for arguments provided