REST API Overview

API Overview

The LicenseSpot API allows you to interact with our system from your own programs and applications. Using the API you can access resources like:

• Customers
• Licenses
• Activations

The API works in general receiving XML responses and sending XML requests.

URL

The URL for the API includes three general parameters to invoke a request:

• method: The method you wish to execute from the API.
• data: Parameters to execute the method. This is a XML.
• apikey: The API key provided to you to access the system.

Below an example of the URL:

https://app.licensespot.com/Api/Api.ashx?method=licensespot.customer.get&data=<Params><CustomerId>0FFE4562-844A-4e18-A7B9-F3F4344C793A</CustomerId></Params>&apikey=296020E3-0458-4f6c-B90B-6D461BDD255D

Response

Below an example of a response:

              <?xml version='1.0' encoding='utf-8' ?>

              <rsp stat='ok'>

                      <Customer>

                              <CustomerId>23D10086-9D85-43d4-9318-1CA76DE9186F</CustomerId>

                              <Name>John Smith</Name>

                              <Email>john.smith@domain.com</Email>

                              <Company>SkyXoft</Company>

                              <Phone>888-759-9638</Phone>

                              <Street1>8260 NW 14th</Street1>

                              <Street2></Street2>

                              <City>Doral</City>

                              <PostalCode>33126</PostalCode>

                              <Country>US</Country>

                              <State>FL</State>

                      </Customer>

              </rsp>        

A response with a failure:

              <?xml version='1.0' encoding='utf-8' ?>

              <rsp stat='fail'>

              <err code='101' msg='the API key is invalid.'/>

              </rsp>        

Customer

Below the different methods you can execute regarding customers

Add a new Customer

licensespot.customer.add

Adds a customer to the database.

Customer Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Name (Required)
• Email (Required)
• Company Company or organization the customer belongs
• Phone Number String field, can be any format
• Street 1
• Street 2 Additional information about the address
• City
• Postal Code
• Province / State Must be the two digit letters identifying the state.
• Country Must be the two digit ISO code letters identifying the country.

Sample Response

The method returns the details about the customer and the customer ID.

              <Customer>

                      <CustomerId>23D10086-9D85-43d4-9318-1CA76DE9186F</CustomerId>

                      <Name>John Smith</Name>

                      <Email>john.smith@domain.com</Email>

                      <Company>SkyXoft</Company>

                      <Phone>888-759-9638</Phone>

                      <Street1>8260 NW 14th</Street1>

                      <Street2></Street2>

                      <City>Doral</City>

                      <PostalCode>33126</PostalCode>

                      <Country>US</Country>

                      <State>FL</State>

              </Customer>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 113: Customer already exists: The customer already exists in the database. Validation is made using the email address.
• 121: Customer limit exceeded: The license is invalid. Customers limit exceeded.
• 132: Customer email is required
• 121: Customer name is required

Get Customer

licensespot.customer.get

Gets a customer in the database. The customer ID field is used to locate the customer. Also the customer email can be used.

Customer Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Customer ID (Required)

Sample Response

The method returns the details about the customer and the customer ID.

              <Customer>

                      <CustomerId>23D10086-9D85-43d4-9318-1CA76DE9186F</CustomerId>

                      <Name>John Smith</Name>

                      <Email>john.smith@domain.com</Email>

                      <Company>SkyXoft</Company>

                      <Phone>888-759-9638</Phone>

                      <Street1>8260 NW 14th</Street1>

                      <Street2></Street2>

                      <City>Doral</City>

                      <PostalCode>33126</PostalCode>

                      <Country>US</Country>

                      <State>FL</State>

              </Customer>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 114: Customer not found: Customer not found in the system.
• 115: Invalid Customer ID: The field CustomerId is not a valid Guid.

Update a Customer

licensespot.customer.update

Updates a customer in the database. The customer ID field is used to locate the customer.

Customer Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Customer ID (Required)
• Name
• Email
• Company Company or organization the customer belongs
• Phone Number String field, can be any format
• Street 1
• Street 2 Additional information about the address
• City
• Postal Code
• Province / State Must be the two digit letters identifying the state.
• Country Must be the two digit ISO code letters identifying the country.

Sample Response

The method returns the details about the customer and the customer ID.

              <Customer>

                      <CustomerId>23D10086-9D85-43d4-9318-1CA76DE9186F</CustomerId>

                      <Name>John Smith</Name>

                      <Email>john.smith@domain.com</Email>

                      <Company>SkyXoft</Company>

                      <Phone>888-759-9638</Phone>

                      <Street1>8260 NW 14th</Street1>

                      <Street2></Street2>

                      <City>Doral</City>

                      <PostalCode>33126</PostalCode>

                      <Country>US</Country>

                      <State>FL</State>

              </Customer>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 126: Customer does not exists: The customer doesn't exists in the database.

Get all Customers

licensespot.customer.getall

Gets all customers in the database.

Sample Response

The method returns the details about the customer and the customer ID.

          <Customers>

              <Customer>

                      <CustomerId>23D10086-9D85-43d4-9318-1CA76DE9186F</CustomerId>

                      <Name>John Smith</Name>

                      <Email>john.smith@domain.com</Email>

                      <Company>SkyXoft</Company>

                      <Phone>888-759-9638</Phone>

                      <Street1>8260 NW 14th</Street1>

                      <Street2></Street2>

                      <City>Doral</City>

                      <PostalCode>33126</PostalCode>

                      <Country>US</Country>

                      <State>FL</State>

              </Customer>        

           </Customers>

Error Codes

• 101: Invalid API key: The API key is invalid or not active.

Get Customer Licenses

licensespot.customer.getlicenses

Get licenses from a customer in the database. The customer ID field is used to locate the customer. Also the customer email can be used.

Customer Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Customer ID (Required)

Sample Response

The method returns the licenses the customer has.

            <Licenses>

                <License>

                      <LicenseId>23D10086-9D85-43d4-9318-1CA76DE9186F</LicenseId>

                      <CustomerId>F749B40A-EA9E-4392-9519-D334D8FB99A3</CustomerId>

                      <ProductId>8FC1DA7A-96EB-450f-A7E1-223EE6AA9BAB</ProductId>

                      <ProductVersionId>065F1F66-B0C3-4712-9920-3135561A7E1A</ProductVersionId>

                      <LicenseTemplateId>FA23A829-78E6-40c8-B398-89198CAA0A16</LicenseTemplateId>

                      <LicenseStatus>Active</LicenseStatus>

                      <CreatedDate>2011-02-08</CreatedDate>

                      <Comments>Important Customer</Comments>

                      <Properties>

                              <company>SkyXoft</company>

                              <customer>Jose Leon</customer>

                      </Properties>

              </License>      

            </Licenses>

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 114: Customer not found: Customer not found in the system.
• 115: Invalid Customer ID: The field CustomerId is not a valid Guid.

Licenses

Below you can find all the methods that can be used for licenses.

Activate a License

licensespot.license.activate

Activates a license provided the serial number and hardware ID of the calling machine. Returns the license content in XML format.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Hardware ID (Required)
• Serial Number (Required)

Sample Response

The method returns the details about the license.

              <License>

                      <SerialNumber>AOF4-DR34-4REW-EW@0-SFT2-4313-DSR3</SerialNumber>

                      <CreatedDate>2011-01-25</CreatedDate>

                      <company>SkyXoft</company>

                      <customer>Jose Leon</customer>

                      <Limits>

                              <Limit type="Activation" gracePeriod="30" useHardwareLock="True" hardwareId="npG1VxCx5+snErGzA7xBB5Dd9DE=" />

                              <Limit type="Trial" startDate="2011-03-01" endDate="2011-03-30" />

                      </Limits>

              </License>

Error Codes

• 105: License Revoked: The serial number has been revoked and is no longer active.
• 110: No Activations Left: The maximum number of activations has been reached.
• 112: Activation Not Supported: The license activation limit is not present in the template.
• 119: License Invalid: The license is invalid.

Add a new License

licensespot.license.add

Creates a new license in the system from a license template and a customer.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Customer Id (Required)
• License Template Id (Required)
• MaxActivations
• PropertyNames A comma separated list with the property names to fill. Ex. (company,customer)
• PropertyValues A comma separated list with the property values to fill. Ex. (SkyXoft,Jose Leon)

Sample Response

The method returns the details about the license.

              <License>

                      <SerialNumber>AOF4-DR34-4REW-EW@0-SFT2-4313-DSR3</SerialNumber>

                      <CreatedDate>2011-01-25</CreatedDate>

                      <company>SkyXoft</company>

                      <customer>Jose Leon</customer>

                      <Limits>

                              <Limit type="Activation" gracePeriod="30" useHardwareLock="True" hardwareId="npG1VxCx5+snErGzA7xBB5Dd9DE=" />

                              <Limit type="Trial" startDate="2011-03-01" endDate="2011-03-30" />

                      </Limits>

              </License>

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 115: Invalid Customer ID: The customer Id is not a valid GUID.
• 116: Invalid LicenseTemplate Id: The license template Id is not a valid GUID.
• 128: Invalid License Template: The license template does not exists.
• 129: Invalid Customer: The customer does not exists.

Get License

licensespot.license.get

Gets information about a license.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Serial Number (Required)

Sample Response

The method returns the details about the license.

              <License>

                      <LicenseId>23D10086-9D85-43d4-9318-1CA76DE9186F</LicenseId>

                      <CustomerId>F749B40A-EA9E-4392-9519-D334D8FB99A3</CustomerId>

                      <ProductId>8FC1DA7A-96EB-450f-A7E1-223EE6AA9BAB</ProductId>

                      <ProductVersionId>065F1F66-B0C3-4712-9920-3135561A7E1A</ProductVersionId>

                      <LicenseTemplateId>FA23A829-78E6-40c8-B398-89198CAA0A16</LicenseTemplateId>

                      <LicenseStatus>Active</LicenseStatus>

                      <CreatedDate>2011-02-08</CreatedDate>

                      <Comments>Important Customer</Comments>

                      <Properties>

                              <company>SkyXoft</company>

                              <customer>Jose Leon</customer>

                      </Properties>

              </License>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 119: License Invalid: The license is invalid.

Is Genuine

licensespot.license.isgenuine

Verifies a license is genuine (if it hasn't been revoked in any way and all limits are still valid).

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Hardware ID (Required)
• Serial Number (Required)

Sample Response

The method returns the details about the genuine method.

              <result>

                      <IsGenuine>true</IsGenuine>

                      <TimeStamp>2011-2-7 21:44:32</TimeStamp>

              </result>        

Error Codes

• 119: License Invalid: The license is invalid.

Is Subscription Active

licensespot.license.issubscriptionactive

Verifies a license subscription is active. The license must have the subscription limit for this method to work.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Serial Number (Required)

Sample Response

The method returns the details about the is subscription active method.

              <result>

                      <IsActive>true</IsActive>

                      <TimeStamp>2011-2-7 21:44:32</TimeStamp>

              </result>        

Error Codes

• 119: License Invalid: The license is invalid.
• 127: Subscription Not Supported: The license doesn't have the subscription limit.

Get Activations

licensespot.license.getactivations

Get activations for a specific license.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Serial Number (Required)

Sample Response

The method returns the details about activations.

              <Activations>

                      <Activation>

                              <ActivationDate>6/21/2012</ActivationDate>

                              <ActivationSatus>Unactive</ActivationSatus>

                              <HardwareId>YRtW4IuufGSxszxRQqFcJkodP+4=</HardwareId>

                              <IPAddress>127.0.0.1</IPAddress>

                      </Activation>

                      <Activation>

                              <ActivationDate>6/17/2012</ActivationDate>

                              <ActivationSatus>Unactive</ActivationSatus>

                              <HardwareId>YRtW4IuufGSxszxRQqFcJkodP+4=</HardwareId>

                              <IPAddress>127.0.0.1</IPAddress>

                      </Activation>

              </Activations>

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 119: License Invalid: The license is invalid.
• 130: No activations found.

Deactivate License

licensespot.license.deactivate

Deactivates a license that was previouly activated. The license must have the activation limit for this method to work.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Serial Number (Required)
• HardwareId (Required)

Sample Response

The method returns the details about the is subscription active method.

                <License>

                      <SerialNumber>AOF4-DR34-4REW-EWY0-SFT2-4313-DSR3</SerialNumber>

                      <CreatedDate>2011-01-25</CreatedDate>

                      <company>SkyXoft</company>

                      <customer>Jose Leon</customer>

                      <Limits>

                              <Limit type="Activation" gracePeriod="30" useHardwareLock="True" hardwareId="npG1VxCx5+snErGzA7xBB5Dd9DE=" />

                              <Limit type="Trial" startDate="2011-03-01" endDate="2011-03-30" />

                      </Limits>

              </License>    

Error Codes

• 119: License Invalid: The license is invalid.

Cancel Subscription

licensespot.license.cancelsubscription

Cancels a subscription. The license must have the subscription limit for this method to work.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Serial Number (Required)

Sample Response

The method returns the details about the is subscription active method.

               <result>

                      <IsActive>false</IsActive>

                      <TimeStamp>2011-2-7 21:44:32</TimeStamp>

              </result>        

Error Codes

• 119: License Invalid: The license is invalid.
• 127: Subscription Not Supported: The license doesn't have the subscription limit.

Activate Subscription

licensespot.license.activatesubscription

Activates a subscription. The license must have the subscription limit for this method to work.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Serial Number (Required)

Sample Response

The method returns the details about the is subscription active method.

               <result>

                      <IsActive>false</IsActive>

                      <TimeStamp>2011-2-7 21:44:32</TimeStamp>

              </result>        

Error Codes

• 119: License Invalid: The license is invalid.
• 127: Subscription Not Supported: The license doesn't have the subscription limit.

Get Licenses By Customer

licensespot.license.getcustomer

Get licenses based on a customer ID.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• CustomerId (Required)

Sample Response

The method returns the details about the license.

              <License>

                      <LicenseId>23D10086-9D85-43d4-9318-1CA76DE9186F</LicenseId>

                      <CustomerId>F749B40A-EA9E-4392-9519-D334D8FB99A3</CustomerId>

                      <ProductId>8FC1DA7A-96EB-450f-A7E1-223EE6AA9BAB</ProductId>

                      <ProductVersionId>065F1F66-B0C3-4712-9920-3135561A7E1A</ProductVersionId>

                      <LicenseTemplateId>FA23A829-78E6-40c8-B398-89198CAA0A16</LicenseTemplateId>

                      <LicenseStatus>Active</LicenseStatus>

                      <CreatedDate>2011-02-08</CreatedDate>

                      <Comments>Important Customer</Comments>

                      <Properties>

                              <company>SkyXoft</company>

                              <customer>Jose Leon</customer>

                      </Properties>

              </License>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 115: Invalid Customer ID: The field CustomerId is not a valid Guid.
• 117: There are no licenses with the specified property value.

Get Licenses By Property

licensespot.license.getproperyvalue

Get licenses based on a property value.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Name (Required)
• Value (Required)

Sample Response

The method returns the details about the license.

              <License>

                      <LicenseId>23D10086-9D85-43d4-9318-1CA76DE9186F</LicenseId>

                      <CustomerId>F749B40A-EA9E-4392-9519-D334D8FB99A3</CustomerId>

                      <ProductId>8FC1DA7A-96EB-450f-A7E1-223EE6AA9BAB</ProductId>

                      <ProductVersionId>065F1F66-B0C3-4712-9920-3135561A7E1A</ProductVersionId>

                      <LicenseTemplateId>FA23A829-78E6-40c8-B398-89198CAA0A16</LicenseTemplateId>

                      <LicenseStatus>Active</LicenseStatus>

                      <CreatedDate>2011-02-08</CreatedDate>

                      <Comments>Important Customer</Comments>

                      <Properties>

                              <company>SkyXoft</company>

                              <customer>Jose Leon</customer>

                      </Properties>

              </License>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 117: There are no licenses with the specified property value.

Set License Property

licensespot.license.setproperty

Set value to a license property.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Serial Number (Required)
• Name (Required)
• Value (Required)

Sample Response

The method returns the details about the license.

              <License>

                      <LicenseId>23D10086-9D85-43d4-9318-1CA76DE9186F</LicenseId>

                      <CustomerId>F749B40A-EA9E-4392-9519-D334D8FB99A3</CustomerId>

                      <ProductId>8FC1DA7A-96EB-450f-A7E1-223EE6AA9BAB</ProductId>

                      <ProductVersionId>065F1F66-B0C3-4712-9920-3135561A7E1A</ProductVersionId>

                      <LicenseTemplateId>FA23A829-78E6-40c8-B398-89198CAA0A16</LicenseTemplateId>

                      <LicenseStatus>Active</LicenseStatus>

                      <CreatedDate>2011-02-08</CreatedDate>

                      <Comments>Important Customer</Comments>

                      <Properties>

                              <company>SkyXoft</company>

                              <customer>Jose Leon</customer>

                      </Properties>

              </License>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 119: License Invalid: The license is invalid.

Enable License

licensespot.license.active

Enables a license after it has been revoked.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Serial Number (Required)

Sample Response

The method returns the details about the license.

              <License>

                      <LicenseId>23D10086-9D85-43d4-9318-1CA76DE9186F</LicenseId>

                      <CustomerId>F749B40A-EA9E-4392-9519-D334D8FB99A3</CustomerId>

                      <ProductId>8FC1DA7A-96EB-450f-A7E1-223EE6AA9BAB</ProductId>

                      <ProductVersionId>065F1F66-B0C3-4712-9920-3135561A7E1A</ProductVersionId>

                      <LicenseTemplateId>FA23A829-78E6-40c8-B398-89198CAA0A16</LicenseTemplateId>

                      <LicenseStatus>Active</LicenseStatus>

                      <CreatedDate>2011-02-08</CreatedDate>

                      <Comments>Important Customer</Comments>

                      <Properties>

                              <company>SkyXoft</company>

                              <customer>Jose Leon</customer>

                      </Properties>

              </License>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 119: License Invalid: The license is invalid.

Revoke a License

licensespot.license.revoke

Revokes a license.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Serial Number (Required)

Sample Response

The method returns the details about the license.

              <License>

                      <LicenseId>23D10086-9D85-43d4-9318-1CA76DE9186F</LicenseId>

                      <CustomerId>F749B40A-EA9E-4392-9519-D334D8FB99A3</CustomerId>

                      <ProductId>8FC1DA7A-96EB-450f-A7E1-223EE6AA9BAB</ProductId>

                      <ProductVersionId>065F1F66-B0C3-4712-9920-3135561A7E1A</ProductVersionId>

                      <LicenseTemplateId>FA23A829-78E6-40c8-B398-89198CAA0A16</LicenseTemplateId>

                      <LicenseStatus>Active</LicenseStatus>

                      <CreatedDate>2011-02-08</CreatedDate>

                      <Comments>Important Customer</Comments>

                      <Properties>

                              <company>SkyXoft</company>

                              <customer>Jose Leon</customer>

                      </Properties>

              </License>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 119: License Invalid: The license is invalid.

Get License Content

licensespot.license.getcontent

Gets the license content provided the serial number and hardware ID of the calling machine. Returns the license content in XML format.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• Hardware ID (Optional)
• Serial Number (Required)

Sample Response

The method returns the details about the license.

              <License>

                      <SerialNumber>AOF4-DR34-4REW-EW@0-SFT2-4313-DSR3</SerialNumber>

                      <CreatedDate>2011-01-25</CreatedDate>

                      <company>SkyXoft</company>

                      <customer>Jose Leon</customer>

                      <Limits>

                              <Limit type="Activation" gracePeriod="30" useHardwareLock="True" hardwareId="npG1VxCx5+snErGzA7xBB5Dd9DE=" />

                              <Limit type="Trial" startDate="2011-03-01" endDate="2011-03-30" />

                      </Limits>

              </License>

Error Codes

• 105: License Revoked: The serial number has been revoked and is no longer active.
• 110: No Activations Left: The maximum number of activations has been reached.
• 112: Activation Not Supported: The license activation limit is not present in the template.
• 119: License Invalid: The license is invalid.

Set End Date

licensespot.license.setenddate

Sets the end date for a time limit in a license provided the serial number and the endate in YYYY-MM-DD format. Returns the license content in XML format.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• endate (Required)
• Serial Number (Required)

Sample Response

The method returns the details about the license.

              <License>

                      <SerialNumber>AOF4-DR34-4REW-EW@0-SFT2-4313-DSR3</SerialNumber>

                      <CreatedDate>2011-01-25</CreatedDate>

                      <company>SkyXoft</company>

                      <customer>Jose Leon</customer>

                      <Limits>

                              <Limit type="Activation" gracePeriod="30" useHardwareLock="True" hardwareId="npG1VxCx5+snErGzA7xBB5Dd9DE=" />

                              <Limit type="Trial" startDate="2011-03-01" endDate="2011-03-30" />

                      </Limits>

              </License>

Error Codes

• 105: License Revoked: The serial number has been revoked and is no longer active.
• 110: No Activations Left: The maximum number of activations has been reached.
• 112: Activation Not Supported: The license activation limit is not present in the template.
• 119: License Invalid: The license is invalid.

License Templates

Get a License Template

licensespot.licensetemplate.get

Gets information about a license template.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

• LicenseTemplateId (Required)

Sample Response

The method returns the details about the license template.

              <LicenseTemplate>

                      <LicenseTemplateId>23D10086-9D85-43d4-9318-1CA76DE9186F</LicenseId>

                      <Name>Trial</Name>

                      <Product>

                      <Name>Widget App</Name>

                      </Product>

                      <ProductVersion>

                      <Name>Widget App 1.0</Name>

                      </ProductVersion>

                      <Properties>

                      <Name>CustomerName</Name>

                      </Properties>

                      <Limits>

                      <Name>Trial</Name>

                      <Type>TrialEx</Type>

                      </Limits>

              </LicenseTemplate>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active.
• 128: The license template does not exists.

Get All License Template

licensespot.licensetemplate.getall

Gets information about all license templates.

License Attributes

The attributes form the XML schema to be sent via the querystring parameter, specifically the data parameter. Fields marked as required should be sent the URL or the function execution will failed.

Sample Response

The method returns the details about all license template.

              <LicenseTemplates>

              <LicenseTemplate>

                      <LicenseTemplateId>23D10086-9D85-43d4-9318-1CA76DE9186F</LicenseId>

                      <Name>Trial</Name>

                      <Product>

                      <Name>Widget App</Name>

                      </Product>

                      <ProductVersion>

                      <Name>Widget App 1.0</Name>

                      </ProductVersion>

                      <Properties>

                      <Name>CustomerName</Name>

                      </Properties>

                      <Limits>

                      <Name>Trial</Name>

                      <Type>TrialEx</Type>

                      </Limits>

              </LicenseTemplate>        

              </LicenseTemplates>        

Error Codes

• 101: Invalid API key: The API key is invalid or not active