API Reference

CreateOrder

Description

Creates an activation key on the License Server.

Note that to call this function, you must:

  • Enable the Server Property enableCreateActivationKey
  • Set the AdminEncryptionKey
  • Call DefineProduct
void CreateOrder(string webServiceUrl, string email, 
                 int features, int quantity, 
                 bool useMultipleActivationsKey, string qlmVersion, 
                 string vendor, string userData1, 
                 string affiliateID, DateTime expiryDate, 
                 int expiryDuration, string orderID, 
                 int orderStatus, out string response)

Parameters

ParameterTypeDescription
webServiceUrlstringURL to the QLM License Server.
emailstringemail address to associate with to the license key - can be empty
featuresintOR'ed value of the features to enable
quantityintthe number of licenses to create.
numSeatsintthe number of licenses to embed in the key. This controls how many activations are allowed per key.
useMultipleActivationsKeyboolif set to true and quantity > 1, one license key will be generated for all required licenses. The number of licenses will be embedded in the license key
qlmVersionstringversion of the QLM Engine
vendorstringeCommerce vendor to use when generating the key
userData1stringuser data to associate with the license key
affiliateIDstringID of affiliate
expiryDateDateTimeexpiry date of the key. Set this value to DateTime.MinValue to not set an expiry date.
expiryDurationintExpiry duration of the key. Set this value to -1 to not set an expiry duration.
orderIDstringID of the order
orderStatusEOrderStatusset the order status of the license to one of the allowed values: EInProgress | EComplete | EUpgraded | EReleased
responsestringXML fragment containing the result of the call.

Response XML format

<?xml version='1.0' encoding='UTF-8'?>
<QuickLicenseManager>
<keys>A062E-9D0CC-6DC80-0D6A0-E0701-000A0;A062E-9D0CC-6DC80-0D6A0-E0701-000A0</keys>
</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.

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
}