GET List/UserGroup/Items

• 2 minutes to read
 • 2 minutes to read 
GET /api/v1/List/UserGroup/Items

Gets a list of all UserGroup list items.

Calls the User agent service GetAllUserGroup.

Query String Parameters

Parameter Name Type Description
includeDeleted bool 
GET /api/v1/List/UserGroup/Items?includeDeleted=True

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
Value string UserGroup name
Tooltip string Tooltip or other description
Id int32 Primary key
Rank int32 Rank order
Deleted bool Deleted equal to true means that this is a user group that no longer can be selected by the user. It is not permitted to delete a UserGroup.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

GET /api/v1/List/UserGroup/Items
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

[
  {
    "Value": "ut",
    "Tooltip": "hic",
    "Id": 938,
    "Rank": 710,
    "Deleted": false,
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 768
      }
    }
  }
]