Licenses

Accessing License Details in Orders

The Order Licenses relation provides a clear and comprehensive view of how licenses are distributed and managed within the scope of each customer order. By effectively mapping orders to their respective licenses, this relation serves as an essential tool for maintaining accuracy and consistency in the licensing process.

Get

Roles: Administrator, LicenseManager, Sales

The GET method in the Order Licenses relation is specifically designed to retrieve detailed information about the licenses associated with a particular order. This functionality enables users to view and understand the specifics of licenses that are part of an order, including license types, validity periods, and any specific terms or conditions attached to them.

Retrieves a list of licenses for a specific order.

GET/v1/orders/{orderId}/licenses

Path parameters

orderId*integer (int32)

order_id is the ID of the order.

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

licensesarray of License (object)

licenses is the list of licenses.

totalLicensesCountinteger (int32)

total_licenses_count is the total number of licenses.

Request

JavaScriptCurl

const response = await fetch('/v1/orders/{orderId}/licenses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "licenses": [
    {
      "licenseId": "text",
      "licenseType": "text",
      "format": "Xml",
      "description": "text",
      "issueDate": "text",
      "expireDate": "text",
      "supportExpireDate": "text",
      "revoked": false,
      "licenseKey": "text",
      "userKey": "text",
      "licensingMode": "File",
      "hash": "text",
      "product": {
        "id": "text",
        "name": "text",
        "version": "text",
        "copyright": "text",
        "url": "text",
        "description": "text"
      },
      "licensee": {
        "name": "text",
        "company": "text",
        "contactInfo": "text",
        "url": "text"
      },
      "components": [
        "text"
      ],
      "assemblies": [
        {
          "name": "text",
          "version": "text",
          "culture": "text",
          "publicKeyToken": "text",
          "debugSymbolsKey": "text"
        }
      ],
      "fields": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "features": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "expireDate": "text",
          "key": "text",
          "data": "text"
        }
      ],
      "restrictions": [
        {
          "id": "text",
          "name": "text",
          "expireDate": "text"
        }
      ]
    }
  ]
}