Version 7.9.2

Back | 

GetClientList

URL

www.vibebyvista.com/services/index.php?
Use "request" param as post variable for submitting json/xml request payload for all POST requests.

Parameters

  • limit
  • filter

Request

Request a list of clients for the current user. Includes the total immediate child clients for the client. Usage: see limit.

Request format

<?xml version="1.0" encoding="utf-8"?>
<get_client_list>
  <limit></limit>
  <filter></filter>
</get_client_list>

Test Example

<?xml version="1.0" encoding="utf-8"?> <request> <authentication> <user_token></user_token> <client_token></client_token> <app_name></app_name> <app_token></app_token> </authentication> <header> <header_version></header_version> <api_version>4.0</api_version> <no_cache></no_cache> </header> <get_client_list> <limit></limit> <filter></filter> </get_client_list> </request>

Response

Response format

<?xml version="1.0" encoding="utf-8"?>
<get_client_list_response>
  <[--choice--]>
    <success>
      <code></code>
      <message></message>
      <dtstamp></dtstamp>
    </success>
    <failure>
      <code></code>
      <reason></reason>
      <severity></severity>
      <dtstamp></dtstamp>
    </failure>
  </[--choice--]>
  <client>
    <client_id></client_id>
    <uuid></uuid>
    <company_name></company_name>
    <address>
      <address_one></address_one>
      <address_two></address_two>
      <city></city>
      <state></state>
      <state_abbrev></state_abbrev>
      <zip></zip>
    </address>
    <cp_code></cp_code>
    <work_phone></work_phone>
    <cell_phone></cell_phone>
    <domain></domain>
    <ftp>
      <host></host>
      <user></user>
      <password></password>
      <upload_url></upload_url>
    </ftp>
    <children count="">
      <client></client>
    </children>
  </client>
</get_client_list_response>