listLMChildCustomers

Lists the sub-customers of a given customer, or the top-level customers of the licensee.

Parameters:

Field
Type
Required Description
sessionid String yes The sessionid returned by loginLMLicensee()
licensee String yes The company code (not the company name) for the Licensee.
customer String no The company code (not the company name) for the parent Customer. If not given, then the return data will be for top-level customers.


Return values: A CustomerList structure:

Field
Type
Description
customers Array of CustomerInfo A list of customer information, one row per cutomer.
fault FaultData If an error has occurred on the server, this will contain information about the error. This field will be null if no error occurred.

CustomerInfo

Field
Type
Description
code String The company code for the customer
hasChildren Boolean Whether or not the given customer has child customers of its own.
name String The English name of the customer, for display purposes.
parentCode String The company code for the parent customer

Example:

NitroAdminAccessServiceLocator service = new NitroAdminAccessServiceLocator();
NitroAdminAccess server = service.getNitroAdminAccess();
CustomerList list = server.listLMChildCustomers(sessionid, "smith", "testcust");
if (list.getFault()!=null) {
	System.err.println("Error: " + list.getFault().getFaultString());
	return;
}
if (list!=null && list.getCustomers()!=null) {
        CustomerInfo rec;
        for (int i=0; i<list.getCustomers().length; i++) {
                rec = list.getCustomers(i);
                // report on contents of customer data
        }
}
Comments