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

Authorizations

Path parameters

orderIdinteger · int32Required

order_id is the ID of the order.

Query parameters

selectstringOptional

filterstringOptional

sortstringOptional

takeinteger · int32Optional

skipinteger · int32Optional

Responses

application/json

objectOptional

GetOrderLicensesResponse is the response message for the GetOrderLicensesRequest.

application/json

get

HTTPcURLJavaScriptPython

GET /v1/orders/{orderId}/licenses HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "licenses": [
    {
      "id": 1,
      "licenseId": "text",
      "licenseType": "text",
      "format": "Xml",
      "description": "text",
      "issueDate": "text",
      "expireDate": "text",
      "supportExpireDate": "text",
      "revoked": true,
      "licenseKey": "text",
      "maxAllowedSites": 1,
      "userKey": "text",
      "licensingMode": "File",
      "hash": "text",
      "templateId": 1,
      "signatureKeysId": 1,
      "customerId": 1,
      "orderId": 1,
      "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": [
        {
          "id": 1,
          "name": "text",
          "version": "text",
          "culture": "text",
          "publicKeyToken": "text",
          "mappingFileId": 1,
          "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",
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    }
  ],
  "totalLicensesCount": 1
}