getPaidToReport

Generates a report that shows the expiration dates for the licenses at one or more customers.

Each record will reflect a group of licenses. The licenses are grouped by customer and paid-to date; they are additionally grouped by product when the valid-until date is set.

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 all customers of the licensee.
outputType OutputTypeType no Output type for the report. Defaults to "CSV"


Return values: A StringData structure:

Field
Type
Description
data String The report data.
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.


The data returned by the call will contain the following fields on each record:

Field
Type
Description
customer String The company code for the customer.
name String The name of the customer.
product String The product code for the licenses (will only be filled in if the validUntil date is filled in).
description String The product name for the licenses (will only be filled in if the validUntil date is filled in).
validUntilTime long The valid-until date as a standard Java timestamp (the number of milliseconds since Jan 1, 1970).
validUntil String The valid-until date as a formatted string.
paidToTime long The paid-to date as a standard Java timestamp (the number of milliseconds since Jan 1, 1970).
paidTo String The paid-to date as a formatted string.
licenses int The number of licenses in the group.


Example:

NitroAdminAccessServiceLocator service = new NitroAdminAccessServiceLocator();
NitroAdminAccess server = service.getNitroAdminAccess();
StringData ret = server.getPaidToReport(sessionid, "smith", "testcust", OutputTypeType.XML);
if (ret.getFault()!=null) {
	System.err.println("Error: " + ret.getFault().getFaultString());
	return;
}
if (ret!=null && ret.getData()!=null) {
        System.out.println(ret.getData());
}
Sample CSV output:
"customer","name","product","description","validUntilTime","validUntil","paidToTime","paidTo","licenses"
"smith","Smith Company","myProduct","My First Product",1204088400000,"2008-02-27",1268625600000,"2010-03-15",34
...
Sample XML output (with newlines and indentation added):
<getPaidToReport>
    <row>
        <customer>smith</customer>
        <name>Smith Company</name>
        <product>myProduct</product>
        <description>My First Product</description>
        <validUntilTime>1204088400000</validUntilTime>
        <validUntil>2008-02-27</validUntil>
        <paidToTime>1268625600000</paidToTime>
        <paidTo>2010-03-15</paidTo>
        <licenses>34</licenses>
    </row>
    ....
Comments