License Manager – Web Service

Owned by Richard Walker
Last updated: Jul 19, 2019 by Austin Logie (Unlicensed)
2 min read

The license manager web service is used to set up and manage licenses for associating form groups with users or groups of users with the QFE Sample Website ONLY.

PLEASE VISIT THE URL'S BELOW FOR THE LATEST XML FORMAT

Service URL: https://websvcs.quikforms.com/qfem/v5500/LicenseManager.asmx
Service WSDL: https://websvcs.quikforms.com/qfem/v5500/LicenseManager.asmx?WSDL

Methods:

The following methods are used to manage licenses with Quik!. A license is used to associate form groups with a particular user or set of users, and to control rights in the Sample Website project. Quik! does not require customers to manage LicenseIDs that are assigned by Quik!, rather customers will continue using their own unique ID and passing it to Quik! to retrieve a LicenseID using the GetLicenseID method. By passing the Customer User ID to Quik! to maintain the customer does not have to set up additional storage methods and manage multiple identities.

  • GetLicenseID
  • GetLicenseList
  • LoginAdmin
  • UpdateLicense

GetLicenseID

Returns the LicenseID associated to a customer's unique user ID (called the CUNID or CustomerUserID).

SOAP Request

XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<AuthenticationHeader xmlns="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<GetLicenseID xmlns="http://websvcs.quikforms.com/QFEM/">
<CUNID>string</CUNID>
</GetLicenseID>
</soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name

Data Type

Length

Required?

Description

CUNID

String

8000 chars

YES

The Customer's Unique UserID used to create a license in Quik! (CustomerUserID or CustUserID or CUNID).

SOAP Response

XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetLicenseIDResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<GetLicenseIDResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetLicenseIDResult>
</GetLicenseIDResponse>
</soap:Body>
</soap:Envelope>

Result Fields

This method returns the profile of a license with the following columns (NOTE: ProductLicenseID = LicenseID).

Field Name

Data Type

Length

Description

ProductLicenseID

Int


The Quik! LicenseID that matches the CUNID

CustomerUserID

String


The CUNID that was passed in

LicenseExpiry

Date


The date the license expires

FirstName

String


First name of the license

MiddleName

String


Middle name of the license

LastName

String


Last name of the license

Email

String


The email address for the license

LastUpdate

Date


Date the license record was last modified


GetLicenseList

Returns a list of licenses for the customer account.

SOAP Request

XML
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthenticationHeader xmlns="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap12:Header>
<soap12:Body>
<GetLicenseList xmlns="http://websvcs.quikforms.com/QFEM/" />
</soap12:Body>
</soap12:Envelope>

SOAP Body Request Parameters

There are no input parameters for this method other than account credentials.

SOAP Response

XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetLicenseListResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<GetLicenseListResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</GetLicenseListResult>
</GetLicenseListResponse>
</soap:Body>
</soap:Envelope>

Result Fields

This method returns a list of license profiles with the following columns: (NOTE: ProductLicenseID = LicenseID)

Field Name

Data Type

Length

Description

ProductLicenseID

Int


The Quik! LicenseID that matches the CUNID

CustomerUserID

String


The CUNID that was passed in

LicenseExpiry

Date


The date the license expires

FirstName

String


First name of the license

MiddleName

String


Middle name of the license

LastName

String


Last name of the license

Email

String


The email address for the license

LastUpdate

Date


Date the license record was last modified


LoginAdmin

Logs in the Administrator to the Sample Website in order to perform administrative functions (e.g. admin form groups, managing licenses, editing field mapping, etc.) and returns the license profile. This profile data may be used for subsequent web service calls.

SOAP Request

XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<AuthenticationHeader xmlns="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<LoginAdmin xmlns=http://websvcs.quikforms.com/QFEM/ />
</soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

There are no input parameters for this method other than account credentials.

SOAP Response

XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<LoginAdminResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<LoginAdminResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</LoginAdminResult>
</LoginAdminResponse>
</soap:Body>
</soap:Envelope>

Result Fields

This method returns the license profile data for the logged in Admin license.

Field Name

Data Type

Length

Description

LicenseID

Int


The LicenseID for the admin license

UpdateLicense

Updates an existing license to set the license status, change the name or customer unique ID.

SOAP Request

XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<AuthenticationHeader xmlns="http://websvcs.quikforms.com/QFEM/">
<CustomerID>string</CustomerID>
<UserName>string</UserName>
<Password>string</Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<UpdateLicense xmlns="http://websvcs.quikforms.com/QFEM/">
<LicenseID>string</LicenseID>
<CustomerUserID>string</CustomerUserID>
<Active>int</Active>
<LicenseName>string</LicenseName>
</UpdateLicense>
</soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

This method accepts the following parameters.

Field Name

Data Type

Length

Required?

Description

LicenseID

Int


YES

The license to change.

CustomerUserID

String

8000 chars

NO

The value to update for the CustomerUserID

Active

Int


NO

The new status1 = Active2 = Inactive3 = Delete

LicenseName

String

8000 chars

NO

The updated license name value

SOAP Response

XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<UpdateLicenseResponse xmlns="http://websvcs.quikforms.com/QFEM/">
<UpdateLicenseResult>
<ErrorCode>int</ErrorCode>
<Message>string</Message>
<ResultData>
<xsd:schema>schema</xsd:schema>xml</ResultData>
<File>base64Binary</File>
</UpdateLicenseResult>
</UpdateLicenseResponse>
</soap:Body>
</soap:Envelope>

Result Fields

This method only returns an error code (0 = Success) and a message that indicates the result.

For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK