Configuration Scopes

Supported Formats: json
View

GET /hr_api/v1/configuration_scopes

Returns a list of active Configuration Scopes

Params

Property Required Details Location

scope

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

Must be one of: active, agency, all.

 URL

page

Index returns 100 records per request. Defaults to 1.

Must be a Integer

 URL

Examples

GET /hr_api/v1/configuration_scopes
200
{
  "configuration_scopes": [
    {
      "uuid": "1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28",
      "name": "recruitment"
    },
    {
      "uuid": "f15a77e5-9827-4f75-979e-1bf403b01df3",
      "name": "agencies"
    },
    {
      "uuid": "855bbf60-6e3d-4d8a-993d-22649c0ecfed",
      "name": "employees"
    },
    {
      "uuid": null,
      "name": "distributed"
    },
    {
      "uuid": "4788c7f9-9904-4a71-9cdf-64b2fe7b14f4",
      "name": "head_office"
    },
    {
      "uuid": "082e1773-175e-4106-bcb1-6aaa8f052565",
      "name": "retail"
    }
  ]
}
View

GET /hr_api/v1/configuration_scopes/:uuid

Return details of an existing Configuration Scope

Params

Property Required Details Location

uuid

Must be a String

 URL

Examples

GET /hr_api/v1/configuration_scopes/:uuid
200
{
  "configuration_scope": {
    "uuid": "1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28",
    "scope_type": "recruitment",
    "sort": 10,
    "name": "recruitment",
    "category_status": "active",
    "title": "Recruitment"
  }
}