SearchOrganisations()

The SearchOrganisations() command returns a list of organisations in Field View.

  • Quota: 5
Table 1. Parameters
ParameterTypeMax LengthRequiredDescription
apiTokenstring20YYour API security token configured in Field View.
searchstring100Y The search string to search the organisations for. Must be greater than, or equal to, 3 charactersApplies the search string to the name and alias column, and returns potential matches.
Table 2. Returns
FieldTypeDescription
OrganisationInformationOrganisationInformationOrganisation information structure.
<OrganisationResponse>
       <Status>
           SUCCESS
           <Message>Success.</Message>
       </Status>
       <OrganisationInformation>
           <ID></ID>
           <Name></Name>
           <Alias></Alias>
           <RegistrationNo></RegistrationNo>
           <Active></Active>
       </OrganisationInformation>
   </OrganisationResponse>