Follow

ListAccounts

Last updated 2016-08-11 12:38:56 UTC

The ListAccounts operation may be used to return a list of child accounts for a given account. The returned list will return a number of useful attributes for account management and child account API usage. This operation requires an AuthenticationToken returned from AuthenticateUser, which in turn requires passing of an active AssureSign username and password.

The ListAccounts operation requires knowledge of the following:

  • the AssureSign account ContextIdentifier for the parent account whose child accounts should be listed (this is exposed in the AssureSign administrative application account settings). The ContextIdentifier is in the form of a global unique identifier (GUID).
  • an AuthenticationToken, returned from a successful call to AuthenticateUser

Sample XML

<?xml version="1.0" encoding="utf-8"?> 
<ListAccounts xmlns="https://www.assuresign.net/Services/DocumentNOW/Accounts">
  <Request ContextIdentifier="6c17c44a-458d-455b-b240-fc6dba5cf1da" AuthenticationToken="[authentication token]" />
</ListAccounts>

The SOAP Action header is

https://www.assuresign.net/Services/DocumentNOW/Accounts/IAccountService/ListAccounts

The returned result will include:

  • Account items in an Accounts list, each containing
    • the account ContextIdentifier
    • the account Name
    • the account DisplayName
    • the AccountGroup the account belongs to
    • an Inactive flag

The ListAccountsResult should be checked for the presence of an Exceptions element, which may contain multiple AccountException items.

Sample XML response is presented here:

<?xml version="1.0" encoding="utf-8"?> 
<ListAccountsResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/Accounts">
  <ListAccountsResult Success="true">
    <Accounts>
      <Account ContextIdentifier="8d17c44a-458d-455b-b240-fc6dba5cf1db" Name="Acme" DisplayName="Acme, Inc." AccountGroup="Account Group 1" Inactive="false" />
    </Accounts>
    <Exceptions />
  </ListAccountsResult>
</ListAccountsResponse>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.