license handling

License/Read

Read licensed licenses + useful addons.

Request

empty

Response

• Licenses - array of object- list of licenses
  • LicenseProductName - string - the product name
  • KeyCustomer - string - the user-specified company name
  • KeyUser - string - the user-specified user name
  • LicenseRequestcode - string - the request code
  • LicenseFreecode - string - optional; the free code
  • LicenseOrderNo - string - the order number
  • LicenseAuthorcode - string - the authorisation code
  • UserReference - string - the optional user reference
  • LicenseSection - string - the license group
  • LicenseProdukt - number - the product version
  • LicStatusFreewareAvail - boolean - optional; true if this license can be used as freeware
  • LicStatusFloating - boolean - optional; true if this is a valid floating license
  • LicStatusFloatingInvalid - boolean - optional; true if this is a broken floating license
  • LicStatusDongle - boolean - optional; true if this is a valid dongle license
  • LicStatusDongleMissing - boolean - optional; true if this is a dongle license where the dongle was removed recently; the 72 hour demo period runs
  • LicStatusDongleMissingExpired - boolean - optional; true if this is a dongle license where the dongle was removed some time ago; the 72 hour demo period is expired
  • LicStatusDongleInvalid - boolean - optional; true if this is a broken dongle license
  • LicStatusNoLicense - boolean - optional; true if this is not licensed
  • LicStatusFreecodeOK - boolean - optional; true if this is a valid software license
  • LicStatusFreecodeDemoExpired - boolean - optional; true if this is an expired demo license
  • LicStatusFreecodeInvalid - boolean - optional; true if this is a broken software license
  • LicStatusDemo - boolean - optional; true if this is a valid demo license
  • LicStatusDemoExpired - boolean - optional; true if this is an expired demo license
  • LicStatusFreeware - boolean - optional; true if this license is used as freeware
  • LicStatusInternal - boolean - optional; true if this is an internal license
  • LicenseSupportEnd - string - optional; the support end date
  • LicenseDemoEnd - string - optional; the license end date

Example

in:
{
 "function": "License/Read",
 "id": "some-text-or-number",
 "data": {}
}
out:
{
 "function": "License/Read",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "Licenses": [
   {
    TODO
   }
  ]
 }
}

License/ReadEx

Read all available licenses.

Request

empty

Response

See also

License/Read

Example

in:
{
 "function": "License/ReadEx",
 "id": "some-text-or-number",
 "data": {}
}
out:
{
 "function": "License/ReadEx",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "Licenses": [
   {
    TODO
   }
  ]
 }
}

License/ReadRent

Read licenses marked for software renting.

Request

empty

Response

See also

License/Read

Example

in:
{
 "function": "License/ReadRent",
 "id": "some-text-or-number",
 "data": {}
}
out:
{
 "function": "License/ReadRent",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "Licenses": [
   {
    TODO
   }
  ]
 }
}

License/ReadAddons

Read the available addons for a base license.

Request

empty

Response

See also

License/Read

Example

in:
{
 "function": "License/ReadAddons",
 "id": "some-text-or-number",
 "data": {
  "LicenseOrderNo": "123-45-678"
 }
}
out:
{
 "function": "License/ReadAddons",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "Licenses": [
   {
    TODO
   }
  ]
 }
}

License/Write

Write license information.

Request

• Licenses - array of object - the licenses to write, as array
  • KeyCustomer - string - optional; the user-specified company name
  • KeyUser - string - optional; the user-specified user name
  • LicenseRequestcode - string - the request code
  • LicenseFreecode - string - the free code
  • LicenseAuthorcode - string - the authorisation code
  • UserReference - string - optional; the optional user reference
  • LicenseOrderNo - string - the order number
  • LicenseProdukt - number - the product version
• LicensesText - string - the licenses to write, as string

note: exactly one of Licenses and LicensesText is required

Response

empty

Example

in:
{
 "function": "License/Write",
 "id": "some-text-or-number",
 "data": {
  TODO
 }
}
out:
{
 "function": "License/Write",
 "id": "some-text-or-number",
 "status": 0,
 "data": {}
}

License/SwitchDemo

Change the demo license.

Request

• LicenseOrderNo - string - the order number to be set as demo license

Response

empty

Example

in:
{
 "function": "License/SwitchDemo",
 "id": "some-text-or-number",
 "data": {
  "LicenseOrderNo": "123-4567-89"
 }
}
out:
{
 "function": "License/SwitchDemo",
 "id": "some-text-or-number",
 "status": 0,
 "data": {}
}

License/ReadHardwareReference

Read list of possible hardware reference values.

Request

empty

Response

• References - array of object- list of hardware references
  • Method - string - the licensing method; currently always "MAC"
  • Index - number - The numeric index of this reference
  • Data - string - the hardware reference data (e.g. the MAC address)
  • Name - string - optional; a user-readable name of this reference

Example

in:
{
 "function": "License/ReadHardwareReference",
 "id": "some-text-or-number",
 "data": {}
}
out:
{
 "function": "License/ReadHardwareReference",
 "id": "some-text-or-number",
 "status": 0,
 "data": {
  "References": [
   {
    "Method": "MAC",
    "Index": 0,
    "Data": "001122334455",
    "Name": "eth0"
   }
  ]
 }
}

License/SetHardwareReference

Sets the hardware reference value to use for future license requests.

Request

• Method - string - the licensing method; currently always "MAC"
• Index - number - The numeric index of the reference to use

Response

empty

Example

in:
{
 "function": "License/SetHardwareReference",
 "id": "some-text-or-number",
 "data": {
  "Method": "MAC",
  "Index": 0,
 }
}
out:
{
 "function": "License/SetHardwareReference",
 "id": "some-text-or-number",
 "status": 0,
 "data": {}
}