To retrieve all license orders that match the specified criteria, use the following request:

GET /license-orders

Query Parameters

Query parameters include the following.

ParameterTypeRequiredDefinition
offsetintegerNoOffset.

activation_key

stringNoPartial activation key.

customer_ids 

stringNo

List of customer IDs (must be set together with customer_ids_exclude).

customer_ids_excludebooleanNo

Whether IDs from customer_ids should be excluded or included (must be set together with customer_ids).

product_template_ids stringNoList of product template IDs.
created_date_after stringNo

Filter license orders by created date after (inclusively given date).

created_date_beforestringNoFilter license orders by created date before (inclusively given date).
disabled booleanNoIf set, return only disabled license orders.


Example request

GET /license-orders?product_template_ids=1,2&customer_ids=4&customer_ids_exclude=true&created_date_after=2019-08-20 HTTP/1.1
Authorization: Bearer f794846b7c26621688e1e06164975b4eae8ce2f6

Response

The LAC REST API returns the standard HTTP response codes described in the following table.

Status CodeDescription
200 OKLicense orders list.

400 Bad Request

Invalid query parameters.
403 ForbiddenInvalid or expired token provided.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json
[
	{
		"customer": {
			"name": "Rivers Inc",
			"description": "desc",
			"phone_number": "779.790.4969x1425",
			"fax_number": "(536)600-8229",
			"street": "008 Santiago Groves Suite 651",
			"city": "Shortport",
			"country": "USA",
			"zip_code": "62448",
			"state": "South Carolina",
			"Contacts": [
				{
					"name": "James Taylor",
					"email": "nfisher@test.x-formation.com"
				},
				{
					"name": "Victor Martinez",
					"email": "ngallagher@test.x-formation.com"
				}
			],
			"CustomTags": [
				{
					"tag_name": "custom_tag_1",
					"value": "Gouldton"
				},
				{
					"tag_name": "custom_tag_2",
					"value": "Idaho"
				}
			]
		},
		"product_template": {
			"id": "1",
			"name": "Trial",
			"product_id": "1"
		},
		"activation_key": "TA4HI-CH4MT-3A861-67FDE",
		"creation_time": "2019-08-20 09:36:47",
		"license_type": "local",
		"licensee_type": "not_specified",
		"licensee": null,
		"hostid_match_rate": "100",
		"min_hostids": "1",
		"activations_allowed": "1",
		"activated_licenses_count": 0,
		"enabled": true,
		"description": "",
		"settings_description": "",
		"removal": false,
		"removal_request_time": null,
		"removal_confirmation_time": null,
		"deactivations_allowed": "0",
		"deactivations_left": 0,
		"Hostids": [
			{
				"name": "Username",
				"min_amount": "1",
				"max_amount": "1"
			}
		],
		"Features": [
			{
				"name": "Licstat",
				"version": "6.0",
				"expiration_type": "no_expiration",
				"expiration_date": null,
				"issued_type": "not_issued",
				"issued_date": null,
				"options": null,
				"additional_settings": null,
				"enabled": true,
				"days_from_activation": null,
				"count": null,
				"maintenance_type": "no_maintenance",
				"maintenance_date": null,
				"maintenance_days_from_activation": null,
				"comment": null
			}
		]
	}
]
  • No labels