Organizational Sub Units

Supported Formats: json
View

GET /hr_api/v1/organizational_sub_units

Returns a list of active Organizational Sub Units

Params

Property Required Details Location

scope

Optionally override the default scope. Will be ignored if invalid.

Must be one of: active, all.

 URL

page

Index returns 100 records per request. Defaults to 1.

Must be a Integer

 URL

Examples

GET /hr_api/v1/organizational_sub_units
200
{
  "organizational_sub_units": [
    {
      "uuid": "ef2c42dc-e154-4ddc-b3eb-6a3e7253337f",
      "organizational_unit_id_string": "development"
    },
    {
      "uuid": "d432bba1-a76b-4254-888f-764df6d062f9",
      "organizational_unit_id_string": "support"
    },
    {
      "uuid": "daf7b6f2-1f62-4bae-aeeb-8a6ab8be2c2b",
      "organizational_unit_id_string": "recruitment"
    },
    {
      "uuid": "36b0145a-f3a7-4180-9c1c-30976163f314",
      "organizational_unit_id_string": "accountant"
    },
    {
      "uuid": "439612f4-909c-43b8-b550-30bf56f4e04a",
      "organizational_unit_id_string": "megastore"
    },
    {
      "uuid": "0ce4298e-a34b-4584-8ee0-744968f98f75",
      "organizational_unit_id_string": "superstore"
    },
    {
      "uuid": "157c21ef-a0ea-46dc-912a-16ec12b9898d",
      "organizational_unit_id_string": "store"
    },
    {
      "uuid": "c6cf4903-0eed-4fd1-85f9-f3e8f59e38fd",
      "organizational_unit_id_string": "gas_station"
    },
    {
      "uuid": "8be04c0e-66b7-4758-9c3b-16680c82b68e",
      "organizational_unit_id_string": "central_north"
    },
    {
      "uuid": "05d41325-e08c-4242-aaf3-11a8c940957d",
      "organizational_unit_id_string": "east_midlands_and_jersey"
    },
    {
      "uuid": "c9234f37-9043-425f-95ea-f13209cb1e78",
      "organizational_unit_id_string": "exceptions"
    },
    {
      "uuid": "75878428-9f37-4fcf-81c1-55911a5e4206",
      "organizational_unit_id_string": "a"
    },
    {
      "uuid": "878d618a-7a7d-43e6-8638-a20095a57dbd",
      "organizational_unit_id_string": "ben_vms_copy_su"
    },
    {
      "uuid": "d2e5e2b1-de51-4683-9c45-0b87d13a6966",
      "organizational_unit_id_string": "ben_vms_copy_su_2"
    },
    {
      "uuid": "483649b1-f623-4253-8f4d-f83e9e092b9a",
      "organizational_unit_id_string": "department_1"
    },
    {
      "uuid": "56147845-ed41-40c4-a7fd-012795213b25",
      "organizational_unit_id_string": "department_2"
    },
    {
      "uuid": "826720b1-1ec0-43c2-9301-0d8056c4cd62",
      "organizational_unit_id_string": "department_3"
    },
    {
      "uuid": "8754af0e-761e-43a5-a4bd-5083879c840e",
      "organizational_unit_id_string": "0_7_org_sub_unit"
    },
    {
      "uuid": "683073d3-f463-4e84-af9d-bcc9f0410358",
      "organizational_unit_id_string": "0_8_test_org_sub_unit"
    },
    {
      "uuid": "e648f9e7-9b7d-44fa-b63a-e0470ade1e5d",
      "organizational_unit_id_string": "0_8_5_organisational_sub_unit"
    },
    {
      "uuid": "379ee99d-953b-4d6a-939f-f28a4e3f4a81",
      "organizational_unit_id_string": "0_8_5_organisational_sub_unit2"
    },
    {
      "uuid": "4790e950-d468-4646-a7bb-ce5937f963d1",
      "organizational_unit_id_string": "0_9_osu"
    },
    {
      "uuid": "9609adce-6f75-499c-969d-3017131ec6ee",
      "organizational_unit_id_string": "r4_test_osu"
    },
    {
      "uuid": "cde4fdff-d4d9-4293-a5f6-60b22fd0cfe5",
      "organizational_unit_id_string": "boots3"
    }
  ]
}
View

GET /hr_api/v1/organizational_sub_units/:uuid

Return details of an existing Organizational Sub Unit

Params

Property Required Details Location

uuid

Must be a String

 URL

Examples

GET /hr_api/v1/organizational_sub_units/:uuid
200
{
  "organizational_sub_unit": {
    "uuid": "ef2c42dc-e154-4ddc-b3eb-6a3e7253337f",
    "organizational_unit_id_string": "development",
    "description": null,
    "category_status": "active",
    "organizational_unit_name": "Development"
  }
}