Department group members

Department group member represents a department in a department group.

List department group members

get/objects/company-config/department-group-member

Returns a collection with a key, ID, and link for each department group member.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/company-config/department-group-member/1"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/company-config/department-group-member/3"
      },
    • {
      • "key": "13",
      • "id": "13",
      • "href": "/objects/company-config/department-group-member/13"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get a department group member

get/objects/company-config/department-group-member/{key}

Returns detailed information for a specified department group member.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for a department group member.

Example: 42
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "departmentGroup": {
      • "key": "1",
      • "href": "/objects/company-config/department-group/1"
      },
    • "department": {
      • "id": "8",
      • "key": "8",
      • "name": "Finance",
      • "href": "/objects/company-config/department/8"
      },
    • "sortOrder": 0,
    • "audit": {
      • "createdDateTime": "2016-10-26T17:28:33Z",
      • "modifiedDateTime": "2016-10-26T17:28:33Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/company-config/department-group-member/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}