POST Agents/License/GetLicenseForAllOwnersFromDB

• 2 minutes to read
 • 2 minutes to read 
POST /api/v1/Agents/License/GetLicenseForAllOwnersFromDB

Get all licenses, with usage, from all module owners as they are stored in the database

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. 
POST /api/v1/Agents/License/GetLicenseForAllOwnersFromDB?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
Reason string
CanBeActivated bool
New TimeZoneData
Current TimeZoneData
ExtendedModuleLicenses array
AccumulatedNextCheckDate date-time

Sample request

POST /api/v1/Agents/License/GetLicenseForAllOwnersFromDB
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "Reason": "",
    "CanBeActivated": true,
    "New": null,
    "Current": null,
    "ExtendedModuleLicenses": [
      {
        "New": null,
        "Current": null,
        "NumberOfLicensesInUse": 703,
        "NumberOfLicensesFree": 752,
        "NumberOfLicensesAdded": 503,
        "NumberOfLicensesNewTotal": 137,
        "NumberOfLicensesNewFree": 285,
        "NumberOfLicensesTotal": 839
      }
    ],
    "AccumulatedNextCheckDate": "2021-02-06T16:32:39.180141+01:00"
  },
  {
    "Reason": "",
    "CanBeActivated": true,
    "New": null,
    "Current": null,
    "ExtendedModuleLicenses": [
      {
        "New": null,
        "Current": null,
        "NumberOfLicensesInUse": 703,
        "NumberOfLicensesFree": 752,
        "NumberOfLicensesAdded": 503,
        "NumberOfLicensesNewTotal": 137,
        "NumberOfLicensesNewFree": 285,
        "NumberOfLicensesTotal": 839
      }
    ],
    "AccumulatedNextCheckDate": "2021-02-06T16:32:39.180141+01:00"
  }
]