createLMPool

Creates a new pool for an existing customer.

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 yes The company code (not the company name) for the Customer.
poolData PoolSetupInfo yes A structure defining the customer's new pool.

PoolSetupInfo

Field
Type
Description
name String The name of the new pool.
noMoves Boolean Whether admins will be blocked from moving licenses into or out of this pool.
queueData QueueInfo Information about a license queue to be created for the pool (optional).
restrictions RestrictionInfo A list of email addresses and domains allowed or blocked from using the pool.

QueueInfo

Field
Type
Description
queueReserveHours Integer After a license slot becomes available, the number of hours for which to reserve that slot for the next person in the queue. Defaults to 1.
queueSize Integer The maximum size the queue can become. Set to 0 for no restriction. Defaults to 0.
queueType QueueType The queue type.

RestrictionInfo

Field
Type
Description
domainData Array of AccessRestriction Domain-level access restrictions
emailData Array of AccessRestriction Email-level access restrictions

AccessRestriction

Field
Type
Description
accessName String The email address or domain for which the restriction applies.
accessType AccessRestrictionType The type of restriction (include or exclude).


Return values: A StatusData structure:

Field
Type
Description
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.
status Integer 0

Example:

NitroAdminAccessServiceLocator service = new NitroAdminAccessServiceLocator();
NitroAdminAccess server = service.getNitroAdminAccess();

PoolSetupInfo pi = new PoolSetupInfo();
pi.setName("my second pool");
pi.setNoMoves(Boolean.FALSE);
pi.setQueueData(new QueueInfo(1, 10, QueueType.fromString(NLMConstants.QUEUE_REQUEST)));
pi.setProducts(ppi);

pi.setRestrictions(
        new RestrictionInfo(
                new AccessRestriction[] {new AccessRestriction("able.com", AccessRestrictionType.fromString("I"))},
                new AccessRestriction[] {new AccessRestriction("frank@able.com", AccessRestrictionType.fromString("E")), new AccessRestriction("ethel@able.com", AccessRestrictionType.fromString("E"))}
                ));

StatusData ret = server.createLMPool(sessionid, "smith", "testcust", pi);
if (ret.getFault()!=null) {
	System.err.println("Error: " + ret.getFault().getFaultString());
	return;
}
Comments