API Reference

GetCustomersInfo

Description

Retrieves information about a set of customers.

Note that to call this function, you must:

  • Set the AdminEncryptionKey
DataSet GetCustomersInfo (string webServiceUrl, string fieldName, 
                          string fieldOperator, string fieldValue, 
                          out string response)

Parameters

ParameterTypeDescription
webServiceUrlstringURL to the QLM License Server.
fieldNamestringfield from the Customers table. Typical fields are: Email, FullName, CustomerID
fieldOperatorstringa valid SQL operator such as: =, like, <>
fieldValuestringvalue of the field to match
responsestringXML fragment containing the result of the call.

Response XML format

<?xml version='1.0' encoding='UTF-8'?>
<QuickLicenseManager>
<result>Succesfully retrieved customers.</result>
</QuickLicenseManager>

Example error response

<?xml version='1.0' encoding='UTF-8'?>
<QuickLicenseManager>
<error>Details about the error</error>
</QuickLicenseManager>

Remarks

Use ParseResults to interpret the results of the call and load the returned data into an ILicenseInfo object.

Example

DataSet ds = license.GetCustomersInfo (webServiceUrl, 
                                       "email", "=", "'[email protected]'", 
                                       out response);
ILicenseInfo li = new LicenseInfo();
string message = string.Empty;
if (lv.QlmLicenseObject.ParseResults(response, ref li, ref message))
{
  // The operation  was successful	
}
else
{
  // The operation failed
}