Sign in
clients

get local groups for the selected client

Changed on
<h3>Administrator views the local groups for the client.</h3>
get/clients/{id}/local-groups

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/clients/{id}/local-groups
  • Auth: API key in header Authorization

Path parameters

idstring text required

id of the client

Response

list of local groups

idstring text

unique identifier

codestring text required

group code

descriptionstring text required

group description

client_idstring text

<instance_id>:<member_class>:<member_code>:<subsystem>(optional)

member_countinteger

member count

updated_atstring date-time

last time updated

Example response

[
  {
    "code": "groupcode",
    "description": "description",
    "client_id": "FI:GOV:123:ABC",
    "member_count": 10,
    "updated_at": "2018-12-15T00:00:00.001Z",
    "members": [
      {
        "id": "FI:GOV:123",
        "member_name": "Member123",
        "subsystem_name": "Subsystem123",
        "created_at": "2018-12-15T00:00:00.001Z"
      }
    ]
  }
]

Changes