Page History

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 obtain details about a license order for a given Activation Keyactivation key using the End-user REST API version 1, use the following request:

Panel
`GET /license-orders`/*(activation_key)*

where:

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

and

the The request headers are used by default.

Example request:

Code Block

language	js
firstline	1
linenumbers	true

GET /rest/v1/license-orders/25N8D-NC35D-WD01P-8JI4K HTTP/1.1
Host: license.x-formation.com
Accept: application/hal+json

...

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

Status Code	Header Field	Description
200 OK	Allow Cache-Control Content-Encoding Content-Language Content-Length Content-Type Date

Details about the licenses

License order details.

403 Forbidden

The license

License order has been disabled.

404 Not Found

The license

License order was not found.

Example response

Code Block

language	text

responses

Code Block

language	js
firstline	1
linenumbers	true

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "activationKey": "25N8D-NC35D-WD01P-8JI4K",
    "customer": {
        "name": "customer1"
    },
    "product": {
        "name": "product 1",
        "version": "2",
        "template": "Default",
        "licenseGeneratorType": "lm_x"
    },
    "licenseType": "local",
    "creationTime": "2014-04-14T09:45:50+00:00",
    "activatedLicenses": 7,
    "bulkMax": 10,
    "hostid": {
        "types": [
            {
                "nameRaw": "CUSTOM",
                "name": "Custom",
                "min": 1,
                "max": 1
            }
        ],
        "min": 1
    },
    "_links": {
        "self": {
            "href": "https://license.x-formation.com/rest/v1/license-orders/25N8D-NC35D-WD01P-8JI4K"
        }
    }
}

Code Block

language	js
firstline	1
linenumbers	true

HTTP/1.1 403 Forbidden
Content-Type: application/hal+json
 
{
    "message": "License order has been disabled."
}

Code Block

language	js
firstline	1
linenumbers	true

HTTP/1.1 404 Not Found
Content-Type: application/hal+json
 
{
    "message": "Invalid activation key specified."
}

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

Page tree

Versions Compared

Old Version 1

New Version Current

Key