This page refers to End-user REST API version 2 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 key using the End-user REST API version 2, use the following request:

GET /license-orders/(activation_key)

where:

and

Example request

GET /rest/v2/license-orders/25N8D-NC35D-WD01P-8JI4K 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 FieldDescription
200 OKLicense order details.
403 ForbiddenLicense order has been disabled.
404 Not FoundLicense order was not found.

Example responses

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/v2/license-orders/25N8D-NC35D-WD01P-8JI4K"
        }
    }
}
HTTP/1.1 403 Forbidden
Content-Type: application/hal+json
 
{
	"code": 1703,
    "message": "License order disabled."
}
HTTP/1.1 404 Not Found
Content-Type: application/hal+json
 
{
	"code": 1712,
    "message": "Invalid activation key."
}

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

  • No labels