XML License File Service

The XML License File Service provides methods for obtaining XML-formatted license files. More specifically, this is the web service used by the Protection PLUS 5 SDK libraries to obtain encrypted and digitally signed xml license files. Any new or existing Protection PLUS customers that are creating a new application may want to consider evaluating this new system. Contact us for more information.

For Instant SOLO Server Shared URL, this can be reached at https://secure.softwarekey.com/solo/webservices/XmlLicenseFileService.asmx. If you are using Instant SOLO Server Custom Shared URL or Instant SOLO Server Dedicated URL, replace secure.softwarekey.com with your sub-domain/domain. If you are running a standalone version of SOLO Server, replace secure.softwarekey.com/solo in the URL with the path to your SOLO Server instance. Please contact us if you need assistance determining the correct URL.

Each web method in this web service is documented by a series of documentation files named after the web method as follows:

MethodNameInput.xml - Uncommented xml file with input xml structure.

MethodNameInputDetails.xml - Commented xml file with input xml structure and comments on each input element.

MethodNameInput.xsd - XSD schema file defining the input xml structure.

MethodNameOutput.xml - Uncommented xml file with output xml structure.

MethodNameOutputDetails.xml - Commented xml file with output xml structure and comments on each output element.

MethodNameOutput.xsd - XSD schema file defining the input xml structure.

Important

The SoftwareKey System offers an assortment of libraries which provide APIs that simplify the invocation of these Web services from your application. This collection of API libraries includes:

The Protection PLUS 5 SDK libraries, including the PLUSManaged library (for .NET applications), and the PLUSNative library (for native applications).
The Automation Client library, which is included with Protection PLUS 4 SDK for native/unmanaged applications.
The SwkClientServices2005 library, which is included with Protection PLUS 4 SDK for .NET/managed applications.

Please refer to the applicable product manuals and sample projects for more information on each library/API.

GetLicenseFile

This web method is used to get a license file for a given Installation (issued at the time of activation).

Parameter	Data Type	Required/Optional	Description
EncryptionKeyID	string	Required	The Encryption Key ID used for encrypting, decrypting, digitally signing, and verifying requests and responses. This is included in the Encryption Envelope, which may be retrieved by clicking the Configure/Products menu and clicking Actions/View Encryption Key Data.
InstallationID	string	Required	Installation ID for which the License File is needed.

Parameter

Data Type

Required/Optional

Description

EncryptionKeyID

string

Required

The Encryption Key ID used for encrypting, decrypting, digitally signing, and verifying requests and responses. This is included in the Encryption Envelope, which may be retrieved by clicking the Configure/Products menu and clicking Actions/View Encryption Key Data.

InstallationID

string

Required

Installation ID for which the License File is needed.

Parameter	Data Type	Description
ResultCode	int	Can take the following values 0 - Success 5000 - Invalid EncryptionKeyID 5001 - Encryption Required 5002 - Signature Required 5003 - Decryption Failure 5004 - Verification Failure 5005 - Invalid Parameters 5015 - Invalid InstallationID 5016 - Deactivated Installation 5017 - Invalid License Status 5018 - No Remaining Deactivations 5019 - License Expired 5022 - Invalid System Time 5023 - Protection PLUS 5 SDK Access Not Enabled 5030 - Protection PLUS 5 SDK evaluation has expired 5031 - SOLO Server evaluation has expired
ErrorMessage	string	Detailed error message for the ResultCode. Only returned in error conditions (ResultCode non zero).
License	string	The contents of the XML License File. When encryption is being used for this file, it will be in its encrypted form here.

Parameter

Data Type

Description

ResultCode

int

Can take the following values

0 - Success
5000 - Invalid EncryptionKeyID
5001 - Encryption Required
5002 - Signature Required
5003 - Decryption Failure
5004 - Verification Failure
5005 - Invalid Parameters
5015 - Invalid InstallationID
5016 - Deactivated Installation
5017 - Invalid License Status
5018 - No Remaining Deactivations
5019 - License Expired
5022 - Invalid System Time
5023 - Protection PLUS 5 SDK Access Not Enabled
5030 - Protection PLUS 5 SDK evaluation has expired
5031 - SOLO Server evaluation has expired

ErrorMessage

string

Detailed error message for the ResultCode. Only returned in error conditions (ResultCode non zero).

License

string

The contents of the XML License File. When encryption is being used for this file, it will be in its encrypted form here.