Licensing

The following section outlines the functionality that has been provided to create licensing requests from an iCM form submission.

Endpoints

The licensing connector contains 19 SOAP methods, while the whole API has been made available via iCM end points only the most relevant have been documented here.

The licensing end points can be found within the goss.idox.uniform.api.LicensingConnectorService.LicensingConnectorServiceSoap12 end point namespace.

Each end point has an input and return schema which details the parameters accepted by the endpoint and thus the Idox connector method.

GetCnCodeListByFieldName

This method can be called to retrieve "CNCODE" values by field name. The list of field names can be found at the end of the Idox technical documentation. This method can be used to retrieve license type codes and potentially provide drop down options for some form fields, for example payment types.

SubmittedNewLicensingApplication

Submits a new Licensing application to the Licensing module. This method accepts a large number of parameters which are detailed in the Idox technical documentation. This end point should be one of the final actions in a form submission and is used to create a new license within Idox uniform.

SubmittedLicensingApplicationForRenewal

Submits a Licensing application for renewal. This method accepts a large number of parameters which are detailed in the Idox technical documentation. This endpoint should be one of the final actions in a form submission and is used to renew an existing license within Idox uniform.