Description

The Organizations call retrieves a list of organizations within the specified view and company the user has access to.

Parameters

• View – The numeric primary ID key of the view required (See Views)
• Company – The company number(s) which contain the list required. If passing multiple company numbers, they should be delimited with a carriage return.
• Client-Code – The primary key to return just 1 record
• Search – String to use to search for records. This is a compound & fuzzy (phonetic) search.

Return Values

Response – XML or JSON containing the list of organizations.

The structure of the response is:

<Organizations  TotalRows=nnn TotalPages=nnn MorePages=True/False>
  <Organization uuid=`{UUID of record}`}>
    <Client-Code>    Alpha Primary key e.g. 1/P9887 or 1/ACME
    <Client-Name>    Organization name
    <Street>      Address line 1
    <Address1>    Address line 2
    <Address2>    Town
    <County>      County
    <Postcode>    Postcode
    <Country>     Country
    <Phone>       Telephone number
    <Fax>         Fax number
    <WebURL>      WWW address
    <Client-Desc>   Notes
    <Category-Name>   “Lead”, “Prospect” or “Client”
    <Inactive>    True/False
    <Client-Type>   Client type
    <Market-Sector>  Market Sector
    <Lead-Rating>    Lead Rating
    <Employees>    Number of employees
    <OP-Status>    Status/Grade
    <Custom-Fields>
      <Custom-Label-1>  Actual Field Label will be an attribute
      <Custom-Label-2>        ...