POST Agents/License/GetUserAndInstallationLicenceStatus
Some tooltip text!
• 2 minutes to read
• 2 minutes to read
POST /api/v1/Agents/License/GetUserAndInstallationLicenceStatus
Get status values for user licenses and installation license that can be used for feedback to the user.
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/GetUserAndInstallationLicenceStatus?$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 |
| Content-Type | Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json |
| 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. |
Request Body: request
AssociateId
| Property Name | Type | Description |
|---|---|---|
| AssociateId | Integer |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: UserAndInstallationLicenceStatus
| Property Name | Type | Description |
|---|---|---|
| AdminWarningDate | date-time | Installations license admin warning date |
| ExpiryDate | date-time | Installations license expiry date |
| GraceDate | date-time | Installations license grace date |
| CompanyName | string | Database company name |
| SerialNr | string | Database serial number |
| UserLicenses | array | The users module licenses names |
Sample request
POST /api/v1/Agents/License/GetUserAndInstallationLicenceStatus
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8
{
"AssociateId": 860
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"AdminWarningDate": "1999-09-18T17:54:03.1795788+02:00",
"ExpiryDate": "2017-12-04T17:54:03.1795788+01:00",
"GraceDate": "2018-09-09T17:54:03.1795788+02:00",
"CompanyName": "Mann Inc and Sons",
"SerialNr": "1010000006",
"UserLicenses": [
"consectetur",
"quia"
]
}