Remuneration Package Keywords

Supported Formats: json
View

GET /hr_api/v1/remuneration_package_keywords

Returns a list of active Remuneration Package Keywords

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/remuneration_package_keywords
200
{
  "remuneration_package_keywords": [
    {
      "uuid": "a29e3f73-c030-4c53-b610-370c3c0a3254",
      "name": "remun kw"
    },
    {
      "uuid": "ca15baea-f433-413a-b549-0cb84fc50396",
      "name": "rem package keyword"
    },
    {
      "uuid": "4629df90-7ffe-44bf-a340-2a7e8ee82b37",
      "name": "final_test_rem_package"
    },
    {
      "uuid": "c42c6904-2b66-4998-8dd4-3247630fd30c",
      "name": "15 to 25 k"
    },
    {
      "uuid": "2b0e8072-2ac7-40e5-b3f4-bae230ae5023",
      "name": "0.9 Salary"
    },
    {
      "uuid": "92a8ae41-eecf-49b3-bad9-742a78000102",
      "name": "Rails 4.0 Test"
    },
    {
      "uuid": "2d7d436e-f3da-4c4e-86c9-e50bca0e7333",
      "name": "boots3_remu"
    }
  ]
}
View

GET /hr_api/v1/remuneration_package_keywords/:uuid

Return details of an existing Remuneration Package Keyword

Params

Property Required Details Location

uuid

Must be a String

 URL

Examples

GET /hr_api/v1/remuneration_package_keywords/:uuid
200
{
  "remuneration_package_keyword": {
    "uuid": "a29e3f73-c030-4c53-b610-370c3c0a3254",
    "name": "remun kw",
    "currency_code": null,
    "base_interval": "year",
    "base_pay_amount_min": 1234,
    "base_pay_amount_max": 123567,
    "other_interval": null,
    "other_pay_amount_min": null,
    "other_pay_amount_max": null,
    "other_pay_calculation": "",
    "other_pay_comments": "",
    "insurance": null,
    "insurance_type": "",
    "retirement_or_savings_plan": null,
    "company_vehicle": null,
    "company_vehicle_description": "",
    "relocation_assistance": null,
    "relocation_assistance_description": "",
    "visa_sponsorship": "",
    "time_off_allowance": "",
    "expatriate_benefits": "",
    "other_benefits": "",
    "comments": "",
    "is_keyword": true,
    "sort": 10,
    "category_status": "active",
    "salary_text": "test"
  }
}