GET License/User/{id}

Some tooltip text!

• 4 minutes to read

 • 4 minutes to read

GET /api/v1/License/User/{associateId}

Obtain information about associate module licenses

Path Part	Type	Description
associateId	int32	Associate id to check for associate module licenses Required

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
Name	string	The name of the license owner
Description	string
RestrictedModuleLicenses	array
UnrestrictedModuleLicenses	array	The unrestricted module licenses that this license owner
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.

Sample request

GET /api/v1/License/User/{associateId}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh

Sample response

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

[
  {
    "Name": "Herzog-Halvorson",
    "Description": "Secured background synergy",
    "RestrictedModuleLicenses": [
      {
        "Unrestricted": false,
        "Total": 844,
        "Tooltip": "sit",
        "CanAssign": true,
        "Free": 98,
        "InUse": 490,
        "IsHidden": false,
        "Assigned": true,
        "ModuleLicenseId": 900,
        "Name": "Klocko-Boehm",
        "Description": "Up-sized static attitude",
        "PrerequisiteModuleName": "Jakubowski-Becker",
        "SortOrder": 532,
        "ExtraFlags": 555,
        "TableRight": null,
        "FieldProperties": {
          "fieldName": {
            "FieldRight": null,
            "FieldType": "System.Int32",
            "FieldLength": 423
          }
        }
      }
    ],
    "UnrestrictedModuleLicenses": [
      {
        "Unrestricted": true,
        "Total": 651,
        "Tooltip": "ex",
        "CanAssign": true,
        "Free": 609,
        "InUse": 904,
        "IsHidden": false,
        "Assigned": false,
        "ModuleLicenseId": 113,
        "Name": "Rowe LLC",
        "Description": "Ameliorated well-modulated methodology",
        "PrerequisiteModuleName": "Abernathy, Herzog and Schmitt",
        "SortOrder": 318,
        "ExtraFlags": 339,
        "TableRight": null,
        "FieldProperties": {
          "fieldName": {
            "FieldRight": null,
            "FieldType": "System.Int32",
            "FieldLength": 815
          }
        }
      }
    ],
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 460
      }
    }
  },
  {
    "Name": "Herzog-Halvorson",
    "Description": "Secured background synergy",
    "RestrictedModuleLicenses": [
      {
        "Unrestricted": false,
        "Total": 844,
        "Tooltip": "sit",
        "CanAssign": true,
        "Free": 98,
        "InUse": 490,
        "IsHidden": false,
        "Assigned": true,
        "ModuleLicenseId": 900,
        "Name": "Klocko-Boehm",
        "Description": "Up-sized static attitude",
        "PrerequisiteModuleName": "Jakubowski-Becker",
        "SortOrder": 532,
        "ExtraFlags": 555,
        "TableRight": null,
        "FieldProperties": {
          "fieldName": {
            "FieldRight": null,
            "FieldType": "System.Int32",
            "FieldLength": 423
          }
        }
      }
    ],
    "UnrestrictedModuleLicenses": [
      {
        "Unrestricted": true,
        "Total": 651,
        "Tooltip": "ex",
        "CanAssign": true,
        "Free": 609,
        "InUse": 904,
        "IsHidden": false,
        "Assigned": false,
        "ModuleLicenseId": 113,
        "Name": "Rowe LLC",
        "Description": "Ameliorated well-modulated methodology",
        "PrerequisiteModuleName": "Abernathy, Herzog and Schmitt",
        "SortOrder": 318,
        "ExtraFlags": 339,
        "TableRight": null,
        "FieldProperties": {
          "fieldName": {
            "FieldRight": null,
            "FieldType": "System.Int32",
            "FieldLength": 815
          }
        }
      }
    ],
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 460
      }
    }
  }
]