findCustomers

• 2 minutes to read

Description

This method will search for customers and return information about the customers which match the search criteria. If you specify an illegal search criterion (an invalid field or matching operator) an error message will be returned.

If you specify an illegal search field, the field will be dropped in the output.

All fields that are reachable by the SuperOffice dot syntax can be used. Refer to CRMScript documentation for an explanation of this format.

Examples of valid fields for search criteria and search fields:

person.person_id
person.firstname
person.lastname
person.contact_id.contact_id (id of the company)
person.contact_id.name (name of the company)
person.(Email->person_id).email_address

Valid operators for search criteria:

OperatorContains
OperatorBeginsWith
OperatorEquals
OperatorNotEquals
OperatorLt (only for numerics)
OperatorGt (only for numerics)
OperatorLte (less than equal)
OperatorGte (greater than equal)

In parameters

Parameter	Description
sessionKey	A valid session key
searchCriteria	A list of criteria (field, operator, value)
searchFields	A list of fields that you want to have returned.
maxRows	Maximum number of rows returned.
orderBy	(not in use)
ascending	(not in use)

Out parameters

Parameter	Description
errorCode	See list of codes
searchResult	A two-dimensional array of field/value/type structs.

Example

ticket.ticketService ticketService = new ticket.ticketService();
string sessionKey;
string errorCode = ticketService.login("tommy", "myPwd", out sessionKey);

if (errorCode.Equals("0"))
{
  ticket.CriteriaStruct[] searchCriteria = new ticket.CriteriaStruct[1];

  searchCriteria[0] = new ticketService.CriteriaStruct();
  searchCriteria[0].field = "customer.email";
  searchCriteria[0].op    = "OperatorEquals";
  searchCriteria[0].value = "hjelms@ejournal.no";

  string[] fields = new string[2];
  fields[0] = "customer.id";
  fields[1] = "customer.email";

  ticket.ResultStruct[][] result;

  if(ticketService.findCustomers(sessionKey, searchCriteria, fields, "100", "customer.id", true, out result)== "0");
  {
    foreach(ticketService.ResultStruct[] i1 in result)
    {
      cout << "Row\\n";
      foreach(ticketService.ResultStruct[] i2 in i1)
      {
        cout << "Field:" << i2.field << endl;
        cout << "Value:" << i2.value << endl;
      }
    }
  }
}