POST Agents/License/GetModuleLicenseFromDB
Some tooltip text!
• 2 minutes to read
• 2 minutes to read
POST /api/v1/Agents/License/GetModuleLicenseFromDB
Get license information for one particular license module.
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/GetModuleLicenseFromDB?$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
OwnerName, ModuleName
| Property Name | Type | Description |
|---|---|---|
| OwnerName | String | |
| ModuleName | String |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: TimeZoneData
| Property Name | Type | Description |
|---|---|---|
| OwnerName | string | |
| ModuleName | string | |
| ModuleDescription | string | |
| ModuleTooltip | string | |
| ModuleVersion | string | |
| LicenseType | string | |
| Unrestricted | bool | |
| AllowedUserType | string | |
| NumberOfLicenses | int32 | |
| ExtraFlags | int32 | |
| ExtraInfo | string | |
| SortOrder | int32 | |
| IsHidden | bool | |
| PrerequisiteModuleName | string | |
| Signature | string |
Sample request
POST /api/v1/Agents/License/GetModuleLicenseFromDB
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8
{
"OwnerName": "Sauer, Gislason and Oberbrunner",
"ModuleName": "Gibson-Hansen"
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"OwnerName": "Pfannerstill, Robel and Walker",
"ModuleName": "Gibson LLC",
"ModuleDescription": "Innovative hybrid migration",
"ModuleTooltip": "ipsum",
"ModuleVersion": "qui",
"LicenseType": "SatelliteLicense",
"Unrestricted": true,
"AllowedUserType": "AnonymousAssociate",
"NumberOfLicenses": 732,
"ExtraFlags": 792,
"ExtraInfo": "illo",
"SortOrder": 288,
"IsHidden": false,
"PrerequisiteModuleName": "Oberbrunner Group",
"Signature": "et"
}