Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This page refers to End-user REST API version 1 only. See End-user REST API for links to other versions of the End-user REST API.


To see details about errors that may have occurred in the proces process of activating a license for a given, unique combination of an activation key and a HostID using the End-user REST API version 1, use the following request:

Panel

GET /license-errors/(activation_key)/(hostids)

where:

  • The activation_key (string) is your product activation key.
    your license order activation key

and

  • hostids (string) are Base64 encoded values. The format of HostID(s) that you can specify is a comma-separated list of types and values; for example, ETHERNET=AABBCCDDEEFF,IPADDRESS=192.168.0.5   The values of hostids are encoded in Base64 format.

Note that request headers are used by default.

...

Code Block
languagejs
firstline1
linenumberstrue
GET /rest/v1/license-errors/4CT1V-4T10N-K3Y1S-C000L/dHlwZTE9dmFsdWUxLHR5cGUyPXZhbHVlPTI= HTTP/1.1
Host: license.x-formation.com
Accept: application/hal+json

Response

The following table lists the Internet status codes that can be returned in a response by a server.

Status CodeHeader Field Description
200 OK  Errors that occurred during activation are listed in the response body.
403 Forbidden
The license
License order has been disabled.
404 Not FoundNo activation errors occurred for a given pair of
the
activation_key and
HostID
hostids.

Example response

Code Block
languagejs
firstline1
linenumberstrue
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
   "errors": [
      {
         "message": "LM-X XML License Generator v4.5.3
                     Copyright (C) 2002-2013 X-Formation. All rights reserved.

                     LM-X Error: Unable to parse and load xml file /tmp/lgtmp_id_2/1400064446_139933.in!
                     LM-X Error: /tmp/lgtmp_id_2/1400064446_139933.in(7): not well-formed (invalid token)!",
         "creationTime": "2014-05-14T10:47:26+00:00"
      }
   ],
   "_links": {
      "self": {
          "href": "https://license.x-formation.com/rest/v1/license-errors/4CT1V-4T10N-K3Y1S-C000L/dHlwZTE9dmFsdWUxLHR5cGUyPXZhbHVlPTI="
      }
   }
}
Code Block
languagejs
firstline1
linenumberstrue
HTTP/1.1 403 Forbidden
Content-Type: application/hal+json
 
{
    "message": "License order has been disabled."
}
Code Block
languagejs
firstline1
linenumberstrue
HTTP/1.1 404 Not Found
Content-Type: application/hal+json
 
{
    "message": "License has no errors."
}

For more information about HTTP methods, see Supported HTTP methods.