Revision as of 17:01, 5 April 2017

Overview

Retrieve all child accounts for service provider based on the account's status.

One of the following statuses will apply:

• Preactive
• Active
• Inactive
• Cancelled
• Suspended
• Restricted by Parent
• System Suspended
• Suspended - Billing and Ordering.

The API call will validate the status supplied matches one of the possibilities

The API call will return a collection of accounts, with:

• ID
• Account Name (from v_account_name)
• Account Type (Individual / Organisation)
• Status ID
• Status Name
• Status Reason
• Account Start Date

Example

Inputs <soapenv:Header/>

  <soapenv:Body>
     <urn:GetAccounts>
        <urn:AccountStatus>Preactive</urn:AccountStatus>
     </urn:GetAccounts>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns2:GetAccountsResponse>
        <ns2:Accounts>
           <ns1:Account ID="1607460">
              <ns1:DisplayName>abc</ns1:DisplayName>
              <ns1:Type>End User</ns1:Type>
              <ns1:Status>Preactive</ns1:Status>
              <ns1:StatusID>6</ns1:StatusID>
              <ns1:StatusReason xsi:nil="true"/>
              <ns1:StartDate>2016-10-19</ns1:StartDate>
              <ns1:Contacts/>
              <ns1:Attributes/>
           </ns1:Account>
           <ns1:Account ID="1586541">
              <ns1:DisplayName></ns1:DisplayName>
              <ns1:Type>End User</ns1:Type>
              <ns1:Status>Preactive</ns1:Status>
              <ns1:StatusID>6</ns1:StatusID>
              <ns1:StatusReason xsi:nil="true"/>
              <ns1:StartDate>2016-07-27</ns1:StartDate>
              <ns1:Contacts/>
              <ns1:Attributes/>
           </ns1:Account>
           <ns1:Account ID="1582869">
              <ns1:DisplayName></ns1:DisplayName>
              <ns1:Type>End User</ns1:Type>
              <ns1:Status>Preactive</ns1:Status>
              <ns1:StatusID>6</ns1:StatusID>
              <ns1:StatusReason xsi:nil="true"/>
              <ns1:StartDate>2016-07-22</ns1:StartDate>
              <ns1:Contacts/>
              <ns1:Attributes/>
           </ns1:Account>
           <ns1:Account ID="1580425">
              <ns1:DisplayName></ns1:DisplayName>
              <ns1:Type>End User</ns1:Type>
              <ns1:Status>Preactive</ns1:Status>
              <ns1:StatusID>6</ns1:StatusID>
              <ns1:StatusReason xsi:nil="true"/>
              <ns1:StartDate>2016-07-19</ns1:StartDate>
              <ns1:Contacts/>
              <ns1:Attributes/>
           </ns1:Account>
           <ns1:Account ID="1580230">
              <ns1:DisplayName></ns1:DisplayName>
              <ns1:Type>End User</ns1:Type>
              <ns1:Status>Preactive</ns1:Status>
              <ns1:StatusID>6</ns1:StatusID>
              <ns1:StatusReason xsi:nil="true"/>
              <ns1:StartDate>2016-07-19</ns1:StartDate>
              <ns1:Contacts/>
              <ns1:Attributes/>
           </ns1:Account>
           <ns1:Account ID="1570664">
              <ns1:DisplayName></ns1:DisplayName>
              <ns1:Type>End User</ns1:Type>
              <ns1:Status>Preactive</ns1:Status>
              <ns1:StatusID>6</ns1:StatusID>
              <ns1:StatusReason xsi:nil="true"/>
              <ns1:StartDate>2016-07-06</ns1:StartDate>
              <ns1:Contacts/>
              <ns1:Attributes/>
           </ns1:Account>
           <ns1:Account ID="1568693">
              <ns1:DisplayName></ns1:DisplayName>
              <ns1:Type>End User</ns1:Type>
              <ns1:Status>Preactive</ns1:Status>
              <ns1:StatusID>6</ns1:StatusID>
              <ns1:StatusReason xsi:nil="true"/>
              <ns1:StartDate>2016-07-04</ns1:StartDate>
              <ns1:Contacts/>
              <ns1:Attributes/>
           </ns1:Account>
           <ns1:Account ID="1568663">
              <ns1:DisplayName></ns1:DisplayName>
              <ns1:Type>End User</ns1:Type>
              <ns1:Status>Preactive</ns1:Status>
              <ns1:StatusID>6</ns1:StatusID>
              <ns1:StatusReason xsi:nil="true"/>
              <ns1:StartDate>2016-07-04</ns1:StartDate>
              <ns1:Contacts/>
              <ns1:Attributes/>
           </ns1:Account>
           <ns1:Account ID="1566029">
              <ns1:DisplayName></ns1:DisplayName>
              <ns1:Type>End User</ns1:Type>
              <ns1:Status>Preactive</ns1:Status>
              <ns1:StatusID>6</ns1:StatusID>
              <ns1:StatusReason xsi:nil="true"/>
              <ns1:StartDate>2016-07-01</ns1:StartDate>
              <ns1:Contacts/>
              <ns1:Attributes/>
           </ns1:Account>
        </ns2:Accounts>
     </ns2:GetAccountsResponse>
  </SOAP-ENV:Body>