{"docs":{"name":"HR API","info":"\n\u003cp\u003eHR API\u003c/p\u003e\n","copyright":"\u0026copy; 2026 Changeworknow","doc_url":"/hr_api/v1/1.0","api_url":"","resources":{"datahub_messages":{"doc_url":"/hr_api/v1/1.0/datahub_messages","id":"datahub_messages","api_url":"","name":"Datahub messages","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/datahub_messages/index","name":"index","apis":[{"api_url":"/api/datahub/v1/publisher/queues/:queue_uuid/messages","http_method":"GET","short_description":"Returns a list of unprocessed Datahub Messages","deprecated":null},{"api_url":"/hr_api/v1/datahub/publisher/queues/:queue_uuid/messages","http_method":"GET","short_description":"Returns a list of unprocessed Datahub Messages","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"queue_uuid","full_name":"queue_uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"count","full_name":"count","description":"\n\u003cp\u003eResults to return per #index request. Defaults to 1. Maximum 10.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/datahub/publisher/queues/:queue_uuid/messages\n200\n{\n \"messages\": [\n {\n \"id\": \"be10e18f-f92b-4354-a6d9-8cd7f599efb3\",\n \"entity\": {\n \"name\": \"Access.aCloud.Recruitment.Candidate\",\n \"version\": 1\n },\n \"content\": \"{\\\"employee_number\\\":\\\"1234568\\\",\\\"title\\\":null,\\\"first_name\\\":\\\"first_name\\\",\\\"middle_name\\\":null,\\\"surname\\\":\\\"surname\\\",\\\"preferred_name\\\":null,\\\"gender\\\":null,\\\"marital_status\\\":null,\\\"address_1\\\":null,\\\"address_2\\\":null,\\\"address_3\\\":null,\\\"town\\\":null,\\\"county\\\":null,\\\"post_code\\\":null,\\\"home_tel\\\":null,\\\"mobile_tel\\\":null,\\\"application_owner_email\\\":null,\\\"personal_email\\\":\\\"email\\\",\\\"ni_number\\\":null,\\\"location\\\":null,\\\"division\\\":null,\\\"ethnic_origin\\\":null,\\\"nationality\\\":null,\\\"appointment_type\\\":null,\\\"pay_method\\\":null,\\\"job_title\\\":null,\\\"job_category\\\":null,\\\"unit\\\":null,\\\"religion\\\":null,\\\"sexual_orientation\\\":null,\\\"disability\\\":null,\\\"recruitment_information\\\":null,\\\"post_information\\\":null,\\\"application_owner\\\":null,\\\"hiring_manager\\\":null,\\\"hiring_manager_email\\\":null,\\\"base_interval\\\":null,\\\"currency\\\":null,\\\"employment_history_current_title\\\":null,\\\"employment_history_current_org_name\\\":null,\\\"employment_history_current_location\\\":null,\\\"employment_history_minus_one_title\\\":null,\\\"employment_history_minus_one_org_name\\\":null,\\\"employment_history_minus_one_location\\\":null,\\\"employment_history_minus_two_title\\\":null,\\\"employment_history_minus_two_org_name\\\":null,\\\"employment_history_minus_two_location\\\":null,\\\"employment_history_minus_three_title\\\":null,\\\"employment_history_minus_three_org_name\\\":null,\\\"employment_history_minus_three_location\\\":null,\\\"employment_history_minus_four_title\\\":null,\\\"employment_history_minus_four_org_name\\\":null,\\\"employment_history_minus_four_location\\\":null,\\\"employment_history_minus_five_title\\\":null,\\\"employment_history_minus_five_org_name\\\":null,\\\"employment_history_minus_five_location\\\":null,\\\"education_history_minus_one_school_name\\\":null,\\\"education_history_minus_one_degree\\\":null,\\\"education_history_minus_one_level\\\":null,\\\"education_history_minus_one_grade\\\":null,\\\"bank_sort_code\\\":null,\\\"bank_account_number\\\":null,\\\"bank_account_name\\\":null,\\\"bank_name\\\":null,\\\"bank_branch\\\":null,\\\"date_of_birth\\\":null,\\\"starting_date\\\":null,\\\"probation_review_date\\\":null,\\\"job_effective_date\\\":null,\\\"employment_history_current_start_date\\\":null,\\\"employment_history_current_end_date\\\":null,\\\"hours_per_week\\\":null,\\\"weeks_per_year\\\":null,\\\"fte\\\":null,\\\"base_pay_amount\\\":null,\\\"disabled\\\":null,\\\"education_history_minus_one_location\\\":null,\\\"education_history_minus_two_school_name\\\":null,\\\"education_history_minus_two_degree\\\":null,\\\"education_history_minus_two_level\\\":null,\\\"education_history_minus_two_grade\\\":null,\\\"education_history_minus_two_location\\\":null,\\\"education_history_minus_three_school_name\\\":null,\\\"education_history_minus_three_degree\\\":null,\\\"education_history_minus_three_level\\\":null,\\\"education_history_minus_three_grade\\\":null,\\\"education_history_minus_three_location\\\":null,\\\"education_history_minus_four_school_name\\\":null,\\\"education_history_minus_four_degree\\\":null,\\\"education_history_minus_four_level\\\":null,\\\"education_history_minus_four_grade\\\":null,\\\"education_history_minus_four_location\\\":null,\\\"education_history_minus_five_school_name\\\":null,\\\"education_history_minus_five_degree\\\":null,\\\"education_history_minus_five_level\\\":null,\\\"education_history_minus_five_grade\\\":null,\\\"education_history_minus_five_location\\\":null,\\\"employment_history_minus_one_start_date\\\":null,\\\"employment_history_minus_one_end_date\\\":null,\\\"employment_history_minus_two_start_date\\\":null,\\\"employment_history_minus_two_end_date\\\":null,\\\"employment_history_minus_three_start_date\\\":null,\\\"employment_history_minus_three_end_date\\\":null,\\\"employment_history_minus_four_start_date\\\":null,\\\"employment_history_minus_four_end_date\\\":null,\\\"employment_history_minus_five_start_date\\\":null,\\\"employment_history_minus_five_end_date\\\":null,\\\"education_history_minus_one_start_date\\\":null,\\\"education_history_minus_one_end_date\\\":null,\\\"education_history_minus_two_start_date\\\":null,\\\"education_history_minus_two_end_date\\\":null,\\\"education_history_minus_three_start_date\\\":null,\\\"education_history_minus_three_end_date\\\":null,\\\"education_history_minus_four_start_date\\\":null,\\\"education_history_minus_four_end_date\\\":null,\\\"education_history_minus_five_start_date\\\":null,\\\"education_history_minus_five_end_date\\\":null,\\\"application\\\":{\\\"uuid\\\":\\\"04df3743-8cd5-4228-af0d-60c4f1203c8e\\\",\\\"status\\\":\\\"complete\\\",\\\"submitted_at\\\":\\\"2012-09-14T17:51:14.000Z\\\",\\\"application_reference\\\":\\\"MFC-B-EIEC-1UZ\\\",\\\"successful\\\":true,\\\"successful_at\\\":\\\"2017-05-03T13:34:10.000Z\\\",\\\"completed_at\\\":\\\"2014-05-02T07:22:01.000Z\\\",\\\"created_at\\\":\\\"2012-09-14T17:51:17.000Z\\\",\\\"candidate\\\":{\\\"uuid\\\":\\\"2cb60c3e-2628-40f5-95b5-4f7d6f323b26\\\",\\\"status\\\":\\\"inactive\\\",\\\"entered_by_type\\\":\\\"applicant\\\",\\\"person\\\":{\\\"uuid\\\":\\\"f0f81ff3-5ce3-4a6e-aa61-962c3b7fb1e0\\\",\\\"status\\\":\\\"inactive\\\",\\\"formatted_name\\\":\\\"Dave Colin Roberts\\\",\\\"given_name\\\":\\\"Dave\\\",\\\"family_name\\\":\\\"Roberts\\\",\\\"form_of_address\\\":\\\"Mr\\\",\\\"middle_name\\\":\\\"Colin\\\",\\\"preferred_name\\\":null}},\\\"position_profile\\\":{\\\"uuid\\\":\\\"af3fcf0c-caa1-45f1-9e03-7d6bd6fc2d9a\\\",\\\"position_opening\\\":{\\\"uuid\\\":\\\"ebf404c1-b8ed-48a0-a6d6-47e1477d8771\\\"}}}}\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/datahub_messages/acknowledgement","name":"acknowledgement","apis":[{"api_url":"/api/datahub/v1/publisher/queues/:queue_uuid/messages/:message_uuid/acknowledgement","http_method":"POST","short_description":"Sets the status of a Message to acknowledged","deprecated":null},{"api_url":"/hr_api/v1/datahub/publisher/queues/:queue_uuid/messages/:message_uuid/acknowledgement","http_method":"POST","short_description":"Sets the status of a Message to acknowledged","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"queue_uuid","full_name":"queue_uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message_uuid","full_name":"message_uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reason","full_name":"reason","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /hr_api/v1/datahub/publisher/queues/:queue_uuid/messages/:message_uuid/acknowledgement\n{}\n201\n{}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/datahub_messages/rejection","name":"rejection","apis":[{"api_url":"/api/datahub/v1/publisher/queues/:queue_uuid/messages/:message_uuid/rejection","http_method":"POST","short_description":"Sets the status of a Message to rejected","deprecated":null},{"api_url":"/hr_api/v1/datahub/publisher/queues/:queue_uuid/messages/:message_uuid/rejection","http_method":"POST","short_description":"Sets the status of a Message to rejected","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"queue_uuid","full_name":"queue_uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message_uuid","full_name":"message_uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reason","full_name":"reason","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /hr_api/v1/datahub/publisher/queues/:queue_uuid/messages/:message_uuid/rejection\n{}\n201\n{}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"screening_messages":{"doc_url":"/hr_api/v1/1.0/screening_messages","id":"screening_messages","api_url":"","name":"Screening messages","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/screening_messages/index","name":"index","apis":[{"api_url":"/api/datahub/v1/publisher/queues/:queue_uuid/messages","http_method":"GET","short_description":"Returns a list of Screening Messages","deprecated":null},{"api_url":"/hr_api/v1/datahub/screening_messages","http_method":"GET","short_description":"Returns a list of Screening Messages","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/screening_messages/acknowledgement","name":"acknowledgement","apis":[{"api_url":"/api/datahub/v1/publisher/queues/:queue_uuid/messages/:message_uuid/acknowledgement","http_method":"POST","short_description":"Sets the status of a Message to acknowledged","deprecated":null},{"api_url":"/hr_api/v1/datahub/screening_messages/:screening_message_message_uuid/acknowledgement","http_method":"POST","short_description":"Sets the status of a Message to acknowledged","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"Content","full_name":"Content","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/screening_messages/rejection","name":"rejection","apis":[{"api_url":"/api/datahub/v1/publisher/queues/:queue_uuid/messages/:message_uuid/rejection","http_method":"POST","short_description":"Sets the status of a Message to rejected","deprecated":null},{"api_url":"/hr_api/v1/datahub/screening_messages/:screening_message_message_uuid/rejection","http_method":"POST","short_description":"Sets the status of a Message to rejected","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"Content","full_name":"Content","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"datahub_queues":{"doc_url":"/hr_api/v1/1.0/datahub_queues","id":"datahub_queues","api_url":"","name":"Datahub queues","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/datahub_queues/index","name":"index","apis":[{"api_url":"/hr_api/v1/datahub/publisher/queues","http_method":"GET","short_description":"Returns a list of Datahub Queues","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[],"returns":[],"examples":["GET /hr_api/v1/datahub/publisher/queues?queue_uuid=%3Aqueue_uuid\n200\n{\n \"messages\": [\n {\n \"id\": \"be10e18f-f92b-4354-a6d9-8cd7f599efb3\",\n \"entity\": {\n \"name\": \"Access.aCloud.Recruitment.Candidate\",\n \"version\": 1\n },\n \"content\": \"{\\\"employee_number\\\":\\\"1234568\\\",\\\"title\\\":null,\\\"first_name\\\":\\\"first_name\\\",\\\"middle_name\\\":null,\\\"surname\\\":\\\"surname\\\",\\\"preferred_name\\\":null,\\\"gender\\\":null,\\\"marital_status\\\":null,\\\"address_1\\\":null,\\\"address_2\\\":null,\\\"address_3\\\":null,\\\"town\\\":null,\\\"county\\\":null,\\\"post_code\\\":null,\\\"home_tel\\\":null,\\\"mobile_tel\\\":null,\\\"application_owner_email\\\":null,\\\"personal_email\\\":\\\"email\\\",\\\"ni_number\\\":null,\\\"location\\\":null,\\\"division\\\":null,\\\"ethnic_origin\\\":null,\\\"nationality\\\":null,\\\"appointment_type\\\":null,\\\"pay_method\\\":null,\\\"job_title\\\":null,\\\"job_category\\\":null,\\\"unit\\\":null,\\\"religion\\\":null,\\\"sexual_orientation\\\":null,\\\"disability\\\":null,\\\"recruitment_information\\\":null,\\\"post_information\\\":null,\\\"application_owner\\\":null,\\\"hiring_manager\\\":null,\\\"hiring_manager_email\\\":null,\\\"base_interval\\\":null,\\\"currency\\\":null,\\\"employment_history_current_title\\\":null,\\\"employment_history_current_org_name\\\":null,\\\"employment_history_current_location\\\":null,\\\"employment_history_minus_one_title\\\":null,\\\"employment_history_minus_one_org_name\\\":null,\\\"employment_history_minus_one_location\\\":null,\\\"employment_history_minus_two_title\\\":null,\\\"employment_history_minus_two_org_name\\\":null,\\\"employment_history_minus_two_location\\\":null,\\\"employment_history_minus_three_title\\\":null,\\\"employment_history_minus_three_org_name\\\":null,\\\"employment_history_minus_three_location\\\":null,\\\"employment_history_minus_four_title\\\":null,\\\"employment_history_minus_four_org_name\\\":null,\\\"employment_history_minus_four_location\\\":null,\\\"employment_history_minus_five_title\\\":null,\\\"employment_history_minus_five_org_name\\\":null,\\\"employment_history_minus_five_location\\\":null,\\\"education_history_minus_one_school_name\\\":null,\\\"education_history_minus_one_degree\\\":null,\\\"education_history_minus_one_level\\\":null,\\\"education_history_minus_one_grade\\\":null,\\\"bank_sort_code\\\":null,\\\"bank_account_number\\\":null,\\\"bank_account_name\\\":null,\\\"bank_name\\\":null,\\\"bank_branch\\\":null,\\\"date_of_birth\\\":null,\\\"starting_date\\\":null,\\\"probation_review_date\\\":null,\\\"job_effective_date\\\":null,\\\"employment_history_current_start_date\\\":null,\\\"employment_history_current_end_date\\\":null,\\\"hours_per_week\\\":null,\\\"weeks_per_year\\\":null,\\\"fte\\\":null,\\\"base_pay_amount\\\":null,\\\"disabled\\\":null,\\\"education_history_minus_one_location\\\":null,\\\"education_history_minus_two_school_name\\\":null,\\\"education_history_minus_two_degree\\\":null,\\\"education_history_minus_two_level\\\":null,\\\"education_history_minus_two_grade\\\":null,\\\"education_history_minus_two_location\\\":null,\\\"education_history_minus_three_school_name\\\":null,\\\"education_history_minus_three_degree\\\":null,\\\"education_history_minus_three_level\\\":null,\\\"education_history_minus_three_grade\\\":null,\\\"education_history_minus_three_location\\\":null,\\\"education_history_minus_four_school_name\\\":null,\\\"education_history_minus_four_degree\\\":null,\\\"education_history_minus_four_level\\\":null,\\\"education_history_minus_four_grade\\\":null,\\\"education_history_minus_four_location\\\":null,\\\"education_history_minus_five_school_name\\\":null,\\\"education_history_minus_five_degree\\\":null,\\\"education_history_minus_five_level\\\":null,\\\"education_history_minus_five_grade\\\":null,\\\"education_history_minus_five_location\\\":null,\\\"employment_history_minus_one_start_date\\\":null,\\\"employment_history_minus_one_end_date\\\":null,\\\"employment_history_minus_two_start_date\\\":null,\\\"employment_history_minus_two_end_date\\\":null,\\\"employment_history_minus_three_start_date\\\":null,\\\"employment_history_minus_three_end_date\\\":null,\\\"employment_history_minus_four_start_date\\\":null,\\\"employment_history_minus_four_end_date\\\":null,\\\"employment_history_minus_five_start_date\\\":null,\\\"employment_history_minus_five_end_date\\\":null,\\\"education_history_minus_one_start_date\\\":null,\\\"education_history_minus_one_end_date\\\":null,\\\"education_history_minus_two_start_date\\\":null,\\\"education_history_minus_two_end_date\\\":null,\\\"education_history_minus_three_start_date\\\":null,\\\"education_history_minus_three_end_date\\\":null,\\\"education_history_minus_four_start_date\\\":null,\\\"education_history_minus_four_end_date\\\":null,\\\"education_history_minus_five_start_date\\\":null,\\\"education_history_minus_five_end_date\\\":null,\\\"application\\\":{\\\"uuid\\\":\\\"04df3743-8cd5-4228-af0d-60c4f1203c8e\\\",\\\"status\\\":\\\"complete\\\",\\\"submitted_at\\\":\\\"2012-09-14T17:51:14.000Z\\\",\\\"application_reference\\\":\\\"MFC-B-EIEC-1UZ\\\",\\\"successful\\\":true,\\\"successful_at\\\":\\\"2017-05-03T13:34:10.000Z\\\",\\\"completed_at\\\":\\\"2014-05-02T07:22:01.000Z\\\",\\\"created_at\\\":\\\"2012-09-14T17:51:17.000Z\\\",\\\"candidate\\\":{\\\"uuid\\\":\\\"2cb60c3e-2628-40f5-95b5-4f7d6f323b26\\\",\\\"status\\\":\\\"inactive\\\",\\\"entered_by_type\\\":\\\"applicant\\\",\\\"person\\\":{\\\"uuid\\\":\\\"f0f81ff3-5ce3-4a6e-aa61-962c3b7fb1e0\\\",\\\"status\\\":\\\"inactive\\\",\\\"formatted_name\\\":\\\"Dave Colin Roberts\\\",\\\"given_name\\\":\\\"Dave\\\",\\\"family_name\\\":\\\"Roberts\\\",\\\"form_of_address\\\":\\\"Mr\\\",\\\"middle_name\\\":\\\"Colin\\\",\\\"preferred_name\\\":null}},\\\"position_profile\\\":{\\\"uuid\\\":\\\"af3fcf0c-caa1-45f1-9e03-7d6bd6fc2d9a\\\",\\\"position_opening\\\":{\\\"uuid\\\":\\\"ebf404c1-b8ed-48a0-a6d6-47e1477d8771\\\"}}}}\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"configuration_scopes":{"doc_url":"/hr_api/v1/1.0/configuration_scopes","id":"configuration_scopes","api_url":"","name":"Configuration scopes","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/configuration_scopes/index","name":"index","apis":[{"api_url":"/hr_api/v1/configuration_scopes","http_method":"GET","short_description":"Returns a list of active Configuration Scopes","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003eagency\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/configuration_scopes\n200\n{\n \"configuration_scopes\": [\n {\n \"uuid\": \"1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28\",\n \"name\": \"recruitment\"\n },\n {\n \"uuid\": \"f15a77e5-9827-4f75-979e-1bf403b01df3\",\n \"name\": \"agencies\"\n },\n {\n \"uuid\": \"855bbf60-6e3d-4d8a-993d-22649c0ecfed\",\n \"name\": \"employees\"\n },\n {\n \"uuid\": null,\n \"name\": \"distributed\"\n },\n {\n \"uuid\": \"4788c7f9-9904-4a71-9cdf-64b2fe7b14f4\",\n \"name\": \"head_office\"\n },\n {\n \"uuid\": \"082e1773-175e-4106-bcb1-6aaa8f052565\",\n \"name\": \"retail\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/configuration_scopes/show","name":"show","apis":[{"api_url":"/hr_api/v1/configuration_scopes/:uuid","http_method":"GET","short_description":"Return details of an existing Configuration Scope","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/configuration_scopes/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"configuration_scope\": {\n \"uuid\": \"1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28\",\n \"scope_type\": \"recruitment\",\n \"sort\": 10,\n \"name\": \"recruitment\",\n \"category_status\": \"active\",\n \"title\": \"Recruitment\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"termination_reasons":{"doc_url":"/hr_api/v1/1.0/termination_reasons","id":"termination_reasons","api_url":"","name":"Termination reasons","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/termination_reasons/index","name":"index","apis":[{"api_url":"/hr_api/v1/termination_reasons","http_method":"GET","short_description":"Returns a list of active Termination Reasons","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/termination_reasons\n200\n{\n \"termination_reasons\": [\n {\n \"uuid\": \"5e4405f6-532c-46be-a72a-8b372803525b\",\n \"category_description\": \"test reason for leaving keyword\"\n },\n {\n \"uuid\": \"98267ea0-7026-4044-8804-7e6eb914bda8\",\n \"category_description\": \"test reason for leaving keyword 2\"\n },\n {\n \"uuid\": \"a8ff68c1-9ce5-42b9-9587-db719cb3e982\",\n \"category_description\": \"0.8.5 ReasonForLeaving\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/termination_reasons/show","name":"show","apis":[{"api_url":"/hr_api/v1/termination_reasons/:uuid","http_method":"GET","short_description":"Return details of an existing Termination Reason","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/termination_reasons/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"termination_reason\": {\n \"keyword_type\": \"ReasonForLeaving\",\n \"keyword_id\": null,\n \"uuid\": \"5e4405f6-532c-46be-a72a-8b372803525b\",\n \"category_code\": \"reaon_for_leaving\",\n \"comments\": \"\u003cp\u003ecomment for test reason for leaving\u003c/p\u003e\",\n \"sort\": 100,\n \"category_status\": \"active\",\n \"category_description\": \"test reason for leaving keyword\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/termination_reasons/create","name":"create","apis":[],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"id","full_name":"id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/termination_reasons/update","name":"update","apis":[],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"id","full_name":"id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/termination_reasons/destroy","name":"destroy","apis":[],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"employments":{"doc_url":"/hr_api/v1/1.0/employments","id":"employments","api_url":"","name":"Employments","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/employments/index","name":"index","apis":[{"api_url":"/hr_api/v1/employments","http_method":"GET","short_description":"Returns a list of Employments","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/employments\n200\n{\n \"employments\": [\n {\n \"uuid\": \"853d0df6-971a-4551-a834-b61583a935b3\"\n },\n {\n \"uuid\": \"aa8792e3-f9fd-428e-82af-117f34aed8de\"\n },\n {\n \"uuid\": \"d724cd8d-afb2-403f-bea4-cccab7207f5f\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/employments/show","name":"show","apis":[{"api_url":"/hr_api/v1/employments/:uuid","http_method":"GET","short_description":"Return details of an existing Employment","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/employments/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"employment\": {\n \"uuid\": \"853d0df6-971a-4551-a834-b61583a935b3\",\n \"hire_date\": \"2016-11-03T00:00:00.000+00:00\",\n \"original_hire_date\": null,\n \"adjusted_hire_date\": null,\n \"is_on_leave\": null,\n \"is_terminated\": null,\n \"termination_is_voluntary\": null,\n \"termination_reason_comments\": null,\n \"termination_date\": null,\n \"last_date_worked\": null,\n \"last_date_paid\": null,\n \"employee\": {\n \"employee_id_string\": \"123\",\n \"former_employee_id_string\": null,\n \"uuid\": \"2cd9b201-9f7c-4f3e-8de8-94d9d7ac2804\",\n \"is_employed\": null,\n \"start_date\": null,\n \"end_date\": null\n }\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/employments/create","name":"create","apis":[{"api_url":"/hr_api/v1/employments","http_method":"POST","short_description":"Creates a new Employment","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"employee_uuid","full_name":"employee_uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hire_date","full_name":"hire_date","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_hire_date","full_name":"original_hire_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"adjusted_hire_date","full_name":"adjusted_hire_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"termination_date","full_name":"termination_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_date_worked","full_name":"last_date_worked","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_date_paid","full_name":"last_date_paid","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_on_leave","full_name":"is_on_leave","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"Not on leave","1":"On leave"},"show":true,"validations":[]},{"name":"is_terminated","full_name":"is_terminated","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"Not terminated","1":"Terminated"},"show":true,"validations":[]},{"name":"termination_is_voluntary","full_name":"termination_is_voluntary","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"Not voluntary","1":"Voluntary"},"show":true,"validations":[]},{"name":"termination_reason_uuid","full_name":"termination_reason_uuid","description":"\n\u003cp\u003eObtained from a separate TerminationReason request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"termination_reason_comments","full_name":"termination_reason_comments","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /hr_api/v1/employments\n{\n \"employee_uuid\": \"2cd9b201-9f7c-4f3e-8de8-94d9d7ac2804\",\n \"hire_date\": \"2016-11-03T00:00:00.000+00:00\"\n}\n201\n{\n \"employment\": {\n \"uuid\": \"19f726a7-2365-41b0-9552-ebc1bab5de48\",\n \"hire_date\": \"2016-01-01T00:00:00.000+00:00\",\n \"original_hire_date\": \"2016-01-01T00:00:00.000+00:00\",\n \"adjusted_hire_date\": \"2016-01-01T00:00:00.000+00:00\",\n \"is_on_leave\": false,\n \"is_terminated\": true,\n \"termination_is_voluntary\": true,\n \"termination_reason_comments\": null,\n \"termination_date\": \"2016-02-02T00:00:00.000+00:00\",\n \"last_date_worked\": \"2016-02-02T00:00:00.000+00:00\",\n \"last_date_paid\": null,\n \"employee_id_string\": \"123456\",\n \"employee\": {\n \"uuid\": \"737c1dd0-4134-4743-849d-8e38d0e11644\"\n },\n \"keyword_type\": \"ReasonForLeaving\",\n \"keyword_id\": null,\n \"termination_reason\": {\n \"uuid\": \"5e4405f6-532c-46be-a72a-8b372803525b\"\n },\n \"category_code\": \"reaon_for_leaving\",\n \"comments\": \"\u003cp\u003ecomment for test reason for leaving\u003c/p\u003e\",\n \"sort\": 100,\n \"category_status\": \"active\",\n \"category_description\": \"test reason for leaving keyword\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/employments/update","name":"update","apis":[{"api_url":"/hr_api/v1/employments/:uuid","http_method":"PATCH","short_description":"Updates an existing Employment","deprecated":null},{"api_url":"/hr_api/v1/employments/:uuid","http_method":"PUT","short_description":"Updates an existing Employment","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"employee_uuid","full_name":"employee_uuid","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hire_date","full_name":"hire_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_hire_date","full_name":"original_hire_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"adjusted_hire_date","full_name":"adjusted_hire_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"termination_date","full_name":"termination_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_date_worked","full_name":"last_date_worked","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_date_paid","full_name":"last_date_paid","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_on_leave","full_name":"is_on_leave","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"Not on leave","1":"On leave"},"show":true,"validations":[]},{"name":"is_terminated","full_name":"is_terminated","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"Not terminated","1":"Terminated"},"show":true,"validations":[]},{"name":"termination_is_voluntary","full_name":"termination_is_voluntary","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"Not voluntary","1":"Voluntary"},"show":true,"validations":[]},{"name":"termination_reason_uuid","full_name":"termination_reason_uuid","description":"\n\u003cp\u003eObtained from a separate TerminationReason request\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"termination_reason_comments","full_name":"termination_reason_comments","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PUT /hr_api/v1/employments/(%3F-mix:.%7B10,50%7D)\n{\n \"termination_reason_comments\": null\n}\n200\n{\n \"message\": \"Employment updated successfully\",\n \"employment\": {\n \"uuid\": \"d724cd8d-afb2-403f-bea4-cccab7207f5f\",\n \"hire_date\": \"2016-01-01T00:00:00.000+00:00\",\n \"original_hire_date\": \"2016-01-01T00:00:00.000+00:00\",\n \"adjusted_hire_date\": \"2016-01-01T00:00:00.000+00:00\",\n \"is_on_leave\": false,\n \"is_terminated\": true,\n \"termination_is_voluntary\": true,\n \"termination_reason_comments\": \"TEST\",\n \"termination_date\": \"2016-02-02T00:00:00.000+00:00\",\n \"last_date_worked\": \"2016-02-02T00:00:00.000+00:00\",\n \"last_date_paid\": null,\n \"employee_id_string\": \"123456\",\n \"employee\": {\n \"uuid\": \"737c1dd0-4134-4743-849d-8e38d0e11644\"\n },\n \"keyword_type\": \"ReasonForLeaving\",\n \"keyword_id\": null,\n \"termination_reason\": {\n \"uuid\": \"5e4405f6-532c-46be-a72a-8b372803525b\"\n },\n \"category_code\": \"reaon_for_leaving\",\n \"comments\": \"\u003cp\u003ecomment for test reason for leaving\u003c/p\u003e\",\n \"sort\": 100,\n \"category_status\": \"active\",\n \"category_description\": \"test reason for leaving keyword\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/employments/destroy","name":"destroy","apis":[{"api_url":"/hr_api/v1/employments/:uuid","http_method":"DELETE","short_description":"Deletes an existing Employment","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /hr_api/v1/employments/(%3F-mix:.%7B10,50%7D)\n{}\n200\n{\n \"message\": \"Employment deleted\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"position_reasons":{"doc_url":"/hr_api/v1/1.0/position_reasons","id":"position_reasons","api_url":"","name":"Position reasons","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/position_reasons/index","name":"index","apis":[{"api_url":"/hr_api/v1/position_reasons","http_method":"GET","short_description":"Returns a list of active Position Reasons","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/position_reasons\n200\n{\n \"position_reasons\": [\n {\n \"uuid\": \"7efc3807-4931-498f-9bfd-25a6743cb5e2\",\n \"category_description\": \"Perm - New Position`\"\n },\n {\n \"uuid\": \"467ac832-a2d9-4319-bddf-fd27e1a94625\",\n \"category_description\": \"Perm - Replacement\"\n },\n {\n \"uuid\": \"56613aaa-24f8-4217-b0b6-5fe9286e52d5\",\n \"category_description\": \"Fixed term contract (payroll)\"\n },\n {\n \"uuid\": \"165f332c-a3df-4cfc-b0e7-e006f7b2fdfe\",\n \"category_description\": \"Limited - remain in current country\"\n },\n {\n \"uuid\": \"3529501c-bb5b-4bc8-a58d-beda470b0988\",\n \"category_description\": \"Test 0.8 PositionReason\"\n },\n {\n \"uuid\": \"0ef3281c-d770-4d08-a1cd-c3a6c5f6c198\",\n \"category_description\": \"0.8.5 PositionReason\"\n },\n {\n \"uuid\": \"89d6aa7e-139b-4541-84a7-088ce695ce14\",\n \"category_description\": \"Rails-4-test\"\n },\n {\n \"uuid\": \"9451d699-e8a3-4ecd-8954-572f5877dfa0\",\n \"category_description\": \"BootS3Edit\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/position_reasons/show","name":"show","apis":[{"api_url":"/hr_api/v1/position_reasons/:uuid","http_method":"GET","short_description":"Return details of an existing Position Reason","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/position_reasons/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"position_reason\": {\n \"keyword_type\": \"PositionReason\",\n \"keyword_id\": null,\n \"uuid\": \"7efc3807-4931-498f-9bfd-25a6743cb5e2\",\n \"category_code\": \"perm_new_position\",\n \"comments\": \"\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"category_description\": \"Perm - New Position`\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"applications":{"doc_url":"/hr_api/v1/1.0/applications","id":"applications","api_url":"","name":"Applications","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/applications/index","name":"index","apis":[{"api_url":"/hr_api/v1/applications","http_method":"GET","short_description":"Returns a list of complete Applications","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003ecomplete\u003c/code\u003e, \u003ccode\u003einactive\u003c/code\u003e, \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003etalent\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/applications\n200\n{\n \"applications\": [\n {\n \"uuid\": \"78b9534f-8331-47a7-8ec1-499756604984\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"47327e00-ea67-478a-a06c-7132f066ef99\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"403d613e-084e-4138-a759-6ced55b8868a\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"136a5e2f-2018-4e3c-a43e-22d52fb6b404\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"a947afc1-3870-4d3d-9148-33ccc7569b97\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"ec79be52-6261-4141-983d-17c0818324e6\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"d9e96d09-e831-492c-bd2b-8714fd276af6\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"a22cab7f-fb17-4a11-9657-48ed3c59a5a3\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"0ef476f6-dfd1-4064-8bc3-afc00488d95c\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"31635e95-def3-42f7-9948-94747d30ae64\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"555b2278-c152-4e27-b941-45df94cf8166\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"6e67f9e4-c6c2-446f-ad49-460db2cd139a\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"20a8f760-d260-4053-b0eb-d92d1c1ae042\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"37f1e2d0-24c1-41e2-a2b2-ec24a1d3c68b\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"66f9c483-a598-48ca-a840-7479dbbb6f8c\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"c403e892-00c1-42a9-9984-e8360b4d41f5\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"b8a32624-e38f-410d-953e-3f8c60cf4d44\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"57569aa6-9a77-4945-82c0-02401cf22720\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"3152fdf9-0957-4d4c-a7f8-3f5ee7344f3b\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"d1381729-5977-41c9-b70a-bdea8da7fd7f\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"bd6d23de-1917-40f6-bbc7-e8d09a22ee69\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"a4522580-dbbd-4141-b61c-6700d44df03b\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"e00a6255-f30b-4535-9ed1-4966657001b4\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"66d136e3-cdcc-406c-8a55-ec741d889930\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"a6fa11c6-516f-471b-9f92-b6c3f1026d18\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"8f46fb93-2e32-4e6d-9f9a-9e6c40baa96a\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"b8ff856a-56f2-46f6-a8d4-e82e73e12208\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"ed3d93f4-ab11-4b7d-b958-512934d84d9d\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"9c9071d9-ee7e-4365-a318-36e9026bf75a\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"eed2d644-09f1-4634-9791-270c685f21bd\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"0d7547ee-2c83-4137-aabe-cef37436d33d\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"70d92124-8fd5-4fdd-b6d2-4fc958ec8189\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"98283f2f-547c-457a-9bbc-17da48a975e8\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"e0b26d95-625a-45e5-b4d0-f33dab8d84c2\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"ed32e5c7-520d-416a-ae66-e5929c524c6c\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"7043fe73-ebbf-4628-9c4b-66b845240d86\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"ed046979-7f2f-4f50-86a8-5243f9809002\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"a8eb2b35-d0bc-41c3-8f22-0c1804e7af1c\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"2d01cd96-b310-41db-b0cc-8dccec3084d4\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"4fe3221e-bfde-4bf1-9404-eab89d2cacae\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"c370b4ee-fa87-4174-91ba-c9161c4e8736\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"cea15299-ae9a-4486-9a68-a841acba71d1\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"7f25ea7e-7200-45a5-9279-d139d629d56a\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"02cf44cb-297e-441c-bcad-cf880ea982bb\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"c34c81eb-3c01-44f7-8d7a-60b45619c836\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"6d3e33e6-dadc-46d8-9ce8-80250a2eae5e\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"9e8661e9-682d-4034-a1ee-80e6d079ddf9\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"a7f1d765-02a5-4616-adeb-0133d72e3292\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"6e206d0b-53dd-4914-bad8-ab69e31c309d\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"05bf5357-1b14-40a0-b329-cd4daa5502a0\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"adc3f786-5024-448a-8c88-ac25ca3d0487\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"e42aff0d-1ef0-4bd5-bb16-f9a8507fc812\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"020c5349-6d79-4c8e-afa8-e0716581ff60\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"d8d4af39-a238-4c18-8d25-70ed6e11dfe2\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"3e90f8b6-f67e-4610-bcab-16530d883f71\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"e2e82942-5c5f-4422-bd99-c06ba3ad29a4\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"5a76cf40-e33b-4c54-b907-878559c6c2da\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"4f0143ab-b98b-4c10-a74f-aad16b5c7e43\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"f20ffc8a-ea52-4562-b456-78db4908982b\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"6c3ac85d-caa1-4ff7-8a3b-8434113bd11e\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"cd3c5870-6120-4afe-a4bd-5c170248ba84\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"02e11e99-ac9f-4347-80ab-c8a4ecb17135\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"2ea84c70-f77a-407c-b346-267a3fb62702\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"04df3743-8cd5-4228-af0d-60c4f1203c8e\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"74d7701b-67db-4bcb-bd2e-94948f61db00\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"0aefe98c-7aa3-47f6-a063-a472fcf0b79e\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"64df404c-b495-4884-a5f3-bda402be1c44\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"9e42cc1c-813c-4e9d-a8b0-3341ac1f328c\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"33ee612d-d3b4-4f78-9a2f-5ceddc5788bb\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"5b2a5b47-756f-4669-82d5-cf018aa67c82\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"aa8f31db-032c-4598-8a6e-616bc48df3ff\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"01e67ded-76d5-4599-9717-14936804500c\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"f7a37893-adcc-4b34-8a1b-8bd72355ab84\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"da5abc49-59b3-4315-a1be-f25157b0d9ad\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"5173d74f-641b-44de-a222-a84765148470\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"6c06edc3-624e-48ec-a005-8dd4a88419c9\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"6e0330cb-6294-4dc0-a121-75041a5c7f33\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"d625a07b-81a0-4e1a-aad1-f0a54fc04533\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"821b59f3-85bd-4ab3-aa10-547c5e69ee1c\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"4e3fef6c-ec2c-4f89-9902-04b37713d008\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"7f393890-24b3-48df-b0da-66d05198a517\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"7147a048-47c2-49c9-a544-d49a50b319f8\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"a07bc64b-c326-48fc-8914-9187e1b8dd07\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"f9e360e4-9670-4f3f-a9cf-2e2bed284f7c\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"f9f73810-c327-4bdd-bb24-84387696cb30\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"cecc99a9-7425-40e5-8376-d9f9ad0a681c\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"011e0319-f459-4c16-acb7-679b3904bacb\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"3a22b8fa-7d63-4289-9c4d-23d0900a32e6\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"d7fd515e-b322-413e-9319-60621b137b1b\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"26cfcaac-e061-431e-b88c-44ff66804dbd\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"08e9f9c2-6714-4b28-a8e7-7dbbd31bd9a9\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"b30d507c-7769-4e1a-adbd-3b80aa1bb9ea\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"a31fa9dc-9c8b-4c54-a641-1948b4306df4\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"e21ffcb6-007c-410e-b994-ca7977876fe2\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"32199589-6447-4878-9cd9-c2f3b957b155\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"8e97e610-5147-40ff-8eac-9911458be7ee\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"02dcacc5-3061-42a9-8397-1889feb08158\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"4cef7a1b-a014-4d06-af63-9db6edc2ce20\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"c742ec61-1ee2-48b1-910a-9cb45e07166d\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"3c19baa3-57a6-49be-987a-afe65ec7f442\",\n \"status\": \"complete\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/applications/show","name":"show","apis":[{"api_url":"/hr_api/v1/applications/:uuid","http_method":"GET","short_description":"Return details of an existing Application","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/applications/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"application\": {\n \"uuid\": \"b5c798bc-4023-4ce9-87b9-eb999accda11\",\n \"status\": \"pending_archive\",\n \"submitted_at\": \"2010-03-29T21:18:54.000+01:00\",\n \"application_reference\": \"APP-GFD4-9J\",\n \"successful\": false,\n \"successful_at\": null,\n \"completed_at\": \"2010-04-21T10:20:46.000+01:00\",\n \"ni_flag\": null,\n \"created_at\": \"2010-03-29T21:18:55.000+01:00\",\n \"application_process_attachments\": [\n {\n \"filename\": \"DummyCV.doc\",\n \"data\": \"\u003cbase64-encoded data will be returned here\u003e\",\n \"content_type\": \"application/msword\",\n \"source\": \"upload\",\n \"size\": 9216\n }\n ],\n \"candidate\": {\n \"uuid\": \"a7f1d9dc-c5bb-4a14-ae49-48c746a13d3b\",\n \"status\": \"inactive\",\n \"entered_by_type\": \"applicant\",\n \"transferred_to_vms_at\": null,\n \"vms_transfer_status\": null,\n \"control_data\": {\n \"manual_candidate\": {\n \"publication_scope_name\": null,\n \"create_portal_login\": null,\n \"candidate_supplier_id\": null,\n \"supplier_name\": null,\n \"consultant_name\": null,\n \"position_reference\": null\n }\n },\n \"vms_account_status\": \"deleted-by-user\",\n \"person\": {\n \"uuid\": \"2bbf7ecf-90f9-4c5a-80ec-67d377d2c457\",\n \"status\": \"inactive\",\n \"formatted_name\": \"Peter Nash\",\n \"given_name\": \"Peter\",\n \"family_name\": \"Nash\",\n \"form_of_address\": \"Mr\",\n \"middle_name\": null,\n \"preferred_name\": null\n }\n },\n \"configuration_scope\": {\n \"uuid\": \"1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28\",\n \"scope_type\": \"recruitment\",\n \"sort\": 10,\n \"name\": \"recruitment\",\n \"category_status\": \"active\",\n \"title\": \"Recruitment\"\n },\n \"position_profile\": {\n \"uuid\": \"b91637e6-39a9-4dad-b904-8aacc3a88260\",\n \"language\": null,\n \"profile_id\": null,\n \"profile_name\": \"PCN SA Reading\",\n \"start_as_soon_as_possible\": null,\n \"start_date\": null,\n \"expected_end_date\": null,\n \"maximum_start_date\": null,\n \"maximum_end_date\": null,\n \"distribution_types\": [\n \"external\"\n ],\n \"hot_job\": true,\n \"hot_job_from\": \"2010-03-29T00:00:00.000+01:00\",\n \"hot_job_to\": \"2010-04-16T00:00:00.000+01:00\",\n \"position_opening\": {\n \"uuid\": \"5a5508fd-b299-44cf-91ec-27ee5e6bb4c5\",\n \"position_reference\": \"bAvqJ9SPLeZ5hSj-5EA7tf\",\n \"language\": null,\n \"number_to_fill\": 1,\n \"status\": \"open\",\n \"valid_from\": \"2010-03-29T00:00:00.000+01:00\",\n \"valid_to\": null,\n \"vms_transfer_status\": \"complete\",\n \"quota\": 20,\n \"approval_status\": \"approved\",\n \"description\": \"\",\n \"applications_owner_type\": \"position_opening_owner\",\n \"transferred_to_vms_at\": \"2010-03-30T14:25:09.000+01:00\",\n \"quota_publication_flag\": \"quota_not_reached\",\n \"publication_status\": \"published\",\n \"quota_auto_republish\": true,\n \"ni_flag\": null,\n \"ni_exported\": null,\n \"ni_salary\": null,\n \"ni_location\": null,\n \"ni_advertising_method\": null,\n \"ni_status\": null,\n \"ni_department\": null,\n \"ni_advertisment_type\": null,\n \"ni_apprentice_flag\": null,\n \"auto_fill\": null,\n \"enable_alerts\": false,\n \"position_opening_template\": {\n \"uuid\": \"ba86b865-6246-49ca-983d-c61a7946e5b6\",\n \"title\": \"Sales Advisor\",\n \"language\": null,\n \"number_to_fill\": null,\n \"quota\": null,\n \"distribution_types\": [\n \"internal\",\n \"external\",\n \"agency\"\n ],\n \"body\": \"\u003cp\u003eTemplate Text\u003c/p\u003e\",\n \"data\": null,\n \"description\": null,\n \"applications_owner_type\": \"position_opening_owner\",\n \"status\": \"active\",\n \"quota_auto_republish\": \"\",\n \"default_position_detail_title\": \"\",\n \"default_remuneration_package_title\": \"\",\n \"position_form_options\": {\n \"choose_specific_worksites_flag\": \"\",\n \"require_requisition\": \"0\",\n \"show_min_max_salary\": \"0\",\n \"show_other_pay\": \"1\",\n \"show_position_location\": \"0\",\n \"show_shift\": \"0\",\n \"use_hiring_manager\": \"0\"\n },\n \"auto_fill_type\": \"never_auto_fill\",\n \"use_remuneration_package_keyword\": false,\n \"use_shift_keyword\": false,\n \"restricted_access\": false,\n \"use_job_category_one\": true,\n \"use_job_category_two\": true,\n \"use_job_category_three\": true,\n \"use_contract_type\": true,\n \"position_openings_owner_type\": \"any_named_user\",\n \"system_flags\": 0,\n \"encoded_body\": \"\u0026lt;p\u0026gt;Template Text\u0026lt;/p\u0026gt;\",\n \"user_group_names\": null,\n \"publication_scope_templates\": [\n {\n \"name\": \"external\",\n \"system_flags\": 0\n },\n {\n \"name\": \"internal\",\n \"system_flags\": 0\n },\n {\n \"name\": \"agency\",\n \"system_flags\": 0\n }\n ],\n \"custom_fieldset_template\": {\n \"custom_fieldset_templateable_type\": \"PositionOpeningTemplate\",\n \"available_field_options\": [\n \"text_1\",\n \"text_2\",\n \"text_3\"\n ],\n \"text_1\": \"1111\",\n \"text_2\": \"2222\",\n \"text_3\": \"3333\",\n \"text_4\": null,\n \"text_5\": null,\n \"text_6\": null,\n \"text_7\": null,\n \"text_8\": null,\n \"text_9\": null,\n \"text_10\": null,\n \"text_11\": null,\n \"text_12\": null,\n \"text_13\": null,\n \"text_14\": null,\n \"datetime_1\": null,\n \"datetime_2\": null,\n \"text_1_editable\": true,\n \"text_1_required\": false,\n \"text_2_editable\": true,\n \"text_2_required\": false,\n \"text_3_editable\": true,\n \"text_3_required\": false,\n \"text_4_editable\": null,\n \"text_4_required\": null,\n \"text_5_editable\": null,\n \"text_5_required\": null,\n \"text_6_editable\": null,\n \"text_6_required\": null,\n \"text_7_editable\": null,\n \"text_7_required\": null,\n \"text_8_editable\": null,\n \"text_8_required\": null,\n \"text_9_editable\": null,\n \"text_9_required\": null,\n \"text_10_editable\": null,\n \"text_10_required\": null,\n \"text_11_editable\": null,\n \"text_11_required\": null,\n \"text_12_editable\": null,\n \"text_12_required\": null,\n \"text_13_editable\": null,\n \"text_13_required\": null,\n \"text_14_editable\": null,\n \"text_14_required\": null,\n \"datetime_1_required\": null,\n \"datetime_2_required\": null,\n \"keyword_1_required\": null,\n \"keyword_2_required\": null,\n \"text_area_1\": null,\n \"text_area_1_editable\": null,\n \"text_area_1_required\": null,\n \"text_15\": null,\n \"text_16\": null,\n \"text_17\": null,\n \"text_18\": null,\n \"text_19\": null,\n \"text_20\": null,\n \"text_15_editable\": null,\n \"text_15_required\": null,\n \"text_16_editable\": null,\n \"text_16_required\": null,\n \"text_17_editable\": null,\n \"text_17_required\": null,\n \"text_18_editable\": null,\n \"text_18_required\": null,\n \"text_19_editable\": null,\n \"text_19_required\": null,\n \"text_20_editable\": null,\n \"text_20_required\": null,\n \"keyword_3_required\": null,\n \"keyword_4_required\": null,\n \"keyword_5_required\": null\n }\n }\n }\n }\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"shift_keywords":{"doc_url":"/hr_api/v1/1.0/shift_keywords","id":"shift_keywords","api_url":"","name":"Shift keywords","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/shift_keywords/index","name":"index","apis":[{"api_url":"/hr_api/v1/shift_keywords","http_method":"GET","short_description":"Returns a list of active Shift Keywords","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/shift_keywords\n200\n{\n \"shift_keywords\": [\n {\n \"uuid\": \"08460745-2387-4135-850a-b4d557043066\",\n \"name\": \"shift keyword\"\n },\n {\n \"uuid\": \"1802d48b-e309-4672-9387-9e47c52ef530\",\n \"name\": \"shift keyword #2\"\n },\n {\n \"uuid\": \"bda2d47b-3532-4f1c-93bc-690dd841f8d4\",\n \"name\": \"unassoc_shift_keyword\"\n },\n {\n \"uuid\": \"d48d3926-5d2c-4381-8ed5-9f673e99db47\",\n \"name\": \"unassoc_shift_keyword 2\"\n },\n {\n \"uuid\": \"155155fd-986c-4903-9dd4-9a2471b30f06\",\n \"name\": \"shift1\"\n },\n {\n \"uuid\": \"f33826aa-ee33-4c43-ae18-767fd9bcd36e\",\n \"name\": \"shift11 amended\"\n },\n {\n \"uuid\": \"a9c706e9-f6f8-4142-b3af-347a76f1c197\",\n \"name\": \"0.9 Shift\"\n },\n {\n \"uuid\": \"10e5651b-1b0c-45a5-9afd-e553c59c553e\",\n \"name\": \"Rails 4.0 Test\"\n },\n {\n \"uuid\": \"5298744a-4bef-4fd8-9ee4-32c4d9492f13\",\n \"name\": \"Boot S3 Shift\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/shift_keywords/show","name":"show","apis":[{"api_url":"/hr_api/v1/shift_keywords/:uuid","http_method":"GET","short_description":"Return details of an existing Shift Keyword","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/shift_keywords/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"shift_keyword\": {\n \"uuid\": \"08460745-2387-4135-850a-b4d557043066\",\n \"name\": \"shift keyword\",\n \"hours\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"pay_type_hours\": \"shift keyword\",\n \"comments\": null,\n \"title\": \"shift keyword\",\n \"is_keyword\": true,\n \"sort\": null,\n \"category_status\": \"active\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"remuneration_package_keywords":{"doc_url":"/hr_api/v1/1.0/remuneration_package_keywords","id":"remuneration_package_keywords","api_url":"","name":"Remuneration package keywords","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/remuneration_package_keywords/index","name":"index","apis":[{"api_url":"/hr_api/v1/remuneration_package_keywords","http_method":"GET","short_description":"Returns a list of active Remuneration Package Keywords","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/remuneration_package_keywords\n200\n{\n \"remuneration_package_keywords\": [\n {\n \"uuid\": \"a29e3f73-c030-4c53-b610-370c3c0a3254\",\n \"name\": \"remun kw\"\n },\n {\n \"uuid\": \"ca15baea-f433-413a-b549-0cb84fc50396\",\n \"name\": \"rem package keyword\"\n },\n {\n \"uuid\": \"4629df90-7ffe-44bf-a340-2a7e8ee82b37\",\n \"name\": \"final_test_rem_package\"\n },\n {\n \"uuid\": \"c42c6904-2b66-4998-8dd4-3247630fd30c\",\n \"name\": \"15 to 25 k\"\n },\n {\n \"uuid\": \"2b0e8072-2ac7-40e5-b3f4-bae230ae5023\",\n \"name\": \"0.9 Salary\"\n },\n {\n \"uuid\": \"92a8ae41-eecf-49b3-bad9-742a78000102\",\n \"name\": \"Rails 4.0 Test\"\n },\n {\n \"uuid\": \"2d7d436e-f3da-4c4e-86c9-e50bca0e7333\",\n \"name\": \"boots3_remu\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/remuneration_package_keywords/show","name":"show","apis":[{"api_url":"/hr_api/v1/remuneration_package_keywords/:uuid","http_method":"GET","short_description":"Return details of an existing Remuneration Package Keyword","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/remuneration_package_keywords/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"remuneration_package_keyword\": {\n \"uuid\": \"a29e3f73-c030-4c53-b610-370c3c0a3254\",\n \"name\": \"remun kw\",\n \"currency_code\": null,\n \"base_interval\": \"year\",\n \"base_pay_amount_min\": 1234,\n \"base_pay_amount_max\": 123567,\n \"other_interval\": null,\n \"other_pay_amount_min\": null,\n \"other_pay_amount_max\": null,\n \"other_pay_calculation\": \"\",\n \"other_pay_comments\": \"\",\n \"insurance\": null,\n \"insurance_type\": \"\",\n \"retirement_or_savings_plan\": null,\n \"company_vehicle\": null,\n \"company_vehicle_description\": \"\",\n \"relocation_assistance\": null,\n \"relocation_assistance_description\": \"\",\n \"visa_sponsorship\": \"\",\n \"time_off_allowance\": \"\",\n \"expatriate_benefits\": \"\",\n \"other_benefits\": \"\",\n \"comments\": \"\",\n \"is_keyword\": true,\n \"sort\": 10,\n \"category_status\": \"active\",\n \"salary_text\": \"test\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"user_groups":{"doc_url":"/hr_api/v1/1.0/user_groups","id":"user_groups","api_url":"","name":"User groups","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/user_groups/index","name":"index","apis":[{"api_url":"/hr_api/v1/user_groups","http_method":"GET","short_description":"Returns a list of User Groups","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/user_groups\n200\n{\n \"user_groups\": [\n {\n \"uuid\": \"a63a9159-ef32-4ee5-a399-f76e0e61ffd7\",\n \"name\": \"Super Users\"\n },\n {\n \"uuid\": \"4a6ebe97-ed77-4f06-982c-b1bf05732cbc\",\n \"name\": \"Recruiters\"\n },\n {\n \"uuid\": \"bb53e888-3b2b-4966-be46-0605b1008a19\",\n \"name\": \"Interviewers\"\n },\n {\n \"uuid\": \"c4123ab5-736e-462e-adec-5bcd23bd3d93\",\n \"name\": \"Mike Interviewer Delegation\"\n },\n {\n \"uuid\": \"bdffce8f-6384-4578-8680-88b7078e919f\",\n \"name\": \"Mike Peter Mutual Delegation\"\n },\n {\n \"uuid\": \"cbcb97d6-8035-4e3e-a448-1a72d190490e\",\n \"name\": \"Peter delegate to Mike\"\n },\n {\n \"uuid\": \"f1403ea2-16ea-46a5-879d-37963c22becc\",\n \"name\": \"Delegate all\"\n },\n {\n \"uuid\": \"d35de876-a1fb-4cb2-96b1-6aa490c5b324\",\n \"name\": \"DB Admin\"\n },\n {\n \"uuid\": \"fb8b42ca-d5f6-4152-b81e-779361664fd3\",\n \"name\": \"Northern Ireland Users\"\n },\n {\n \"uuid\": \"f0dbe85f-8942-41c2-b94b-21f6f08a0495\",\n \"name\": \"Superuser Mike delegation\"\n },\n {\n \"uuid\": \"ef2fa724-a71b-4b9c-8eef-d99a73338dd7\",\n \"name\": \"Hiring Managers\"\n },\n {\n \"uuid\": \"890e21dd-47a4-4183-b7c4-99071aa9a71e\",\n \"name\": \"Mike Hiring Manager Delegation\"\n },\n {\n \"uuid\": \"d66416a4-c27b-4b2a-aaa4-cca34f57102c\",\n \"name\": \"Recruiter Delegation\"\n },\n {\n \"uuid\": \"b67ff521-517c-4ed8-a70c-4561a89e728e\",\n \"name\": \"Recruitment Guests\"\n },\n {\n \"uuid\": \"7da10d7a-e1ba-423f-bbb4-dc5bb94285d4\",\n \"name\": \"Recruitment Guest Delegation\"\n },\n {\n \"uuid\": \"b16f33bc-6208-4375-80c7-3d78136dd95f\",\n \"name\": \"Test DG\"\n },\n {\n \"uuid\": \"3f0c6dab-10cf-4284-9aa3-9f35f89ba669\",\n \"name\": \"Employee Users\"\n },\n {\n \"uuid\": \"785f565c-6996-4bd2-9720-d325a56d3fd5\",\n \"name\": \"Employee Dlegation\"\n },\n {\n \"uuid\": \"27fe81cf-9aee-400e-9117-e7f9e0a64a5b\",\n \"name\": \"Employee Admin Users\"\n },\n {\n \"uuid\": \"56da41c4-63d1-4ebb-8843-4be8ce831131\",\n \"name\": \"Employee Admin Delegation\"\n },\n {\n \"uuid\": \"8c4a5af2-262c-4eed-baa6-cdfb0b55300c\",\n \"name\": \"Test user group\"\n },\n {\n \"uuid\": \"83de7560-82d2-4fae-b764-9d1ed23c176a\",\n \"name\": \"Test DG 2\"\n },\n {\n \"uuid\": \"65b22618-7f31-4383-953f-ae654efecd8c\",\n \"name\": \"Agencies\"\n },\n {\n \"uuid\": \"a23f82a7-df4f-45df-a72d-b2122fc02577\",\n \"name\": \"DB Admin to Agency Delegation\"\n },\n {\n \"uuid\": \"eae1ec61-932e-4cea-87e3-795f6f65b6af\",\n \"name\": \"Agency DB Admins\"\n },\n {\n \"uuid\": \"438c2700-67e4-45e2-85b3-fbab9efdd73b\",\n \"name\": \"CO Recruiters\"\n },\n {\n \"uuid\": \"fc1157c7-90c0-4608-9393-2db564478e09\",\n \"name\": \"CO Superusers\"\n },\n {\n \"uuid\": \"2b093d75-1e3b-4077-a490-0f22775998ae\",\n \"name\": \"CO Hiring Manager\"\n },\n {\n \"uuid\": \"be9f47b9-8c95-404a-b1de-bbd4ce67487d\",\n \"name\": \"CO Superuser Delegation\"\n },\n {\n \"uuid\": \"c6102523-4cca-474f-9643-512073f4fce4\",\n \"name\": \"CO Recruiter Delegation\"\n },\n {\n \"uuid\": \"3299d1d8-dd62-43f6-a5d2-9f38a15e0576\",\n \"name\": \"London Office\"\n },\n {\n \"uuid\": \"90e4ae29-ae80-4970-b177-b48971a91275\",\n \"name\": \"Henley Office\"\n },\n {\n \"uuid\": \"98bc54e9-3512-4036-b33e-9e5281603df4\",\n \"name\": \"TSE Users\"\n },\n {\n \"uuid\": \"a0947bc5-5d12-4584-b439-e98aab2af609\",\n \"name\": \"Test Delegation\"\n },\n {\n \"uuid\": \"d5aaf5da-86bb-4974-b8bd-71668b81544c\",\n \"name\": \"testgroup\"\n },\n {\n \"uuid\": \"9beb2eb0-b19a-4f17-b3cb-e7445bcf58a5\",\n \"name\": \"Approvers\"\n },\n {\n \"uuid\": \"9dc14687-4ad1-4eed-8b38-15aea2cd131b\",\n \"name\": \"Hiring Manager delegation\"\n },\n {\n \"uuid\": \"f6147f65-761a-43cb-a62a-90dd7b72d3da\",\n \"name\": \"Hiring Manager delegation\"\n },\n {\n \"uuid\": \"3960d431-5806-46d0-854b-58e9018e2fd7\",\n \"name\": \"Custom Questionnaire Users\"\n },\n {\n \"uuid\": \"57d57f94-d16a-4a8d-877f-3d2517005335\",\n \"name\": \"Requisition Users\"\n },\n {\n \"uuid\": \"c88b1ceb-5213-4965-bacf-bfe843a964a9\",\n \"name\": \"Requisition Admins\"\n },\n {\n \"uuid\": \"704c5718-2200-44be-86a2-8bb63b9b8478\",\n \"name\": \"Rails 4 test group\"\n },\n {\n \"uuid\": \"eb198753-de8e-4174-b700-5861e2948940\",\n \"name\": \"Talent Pool users\"\n },\n {\n \"uuid\": \"dce97c65-33b9-434a-b981-5cf4778523d8\",\n \"name\": \"API Recruiter\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/user_groups/show","name":"show","apis":[{"api_url":"/hr_api/v1/user_groups/:uuid","http_method":"GET","short_description":"Return details of an existing User Group","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/user_groups/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"user_group\": {\n \"uuid\": \"a63a9159-ef32-4ee5-a399-f76e0e61ffd7\",\n \"name\": \"Super Users\",\n \"description\": \"\",\n \"group_type\": \"access_role\",\n \"sys_admin\": false,\n \"configuration_scope\": {\n \"uuid\": \"1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28\",\n \"name\": \"recruitment\",\n \"category_status\": \"active\"\n }\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"business_units":{"doc_url":"/hr_api/v1/1.0/business_units","id":"business_units","api_url":"","name":"Business units","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/business_units/index","name":"index","apis":[{"api_url":"/hr_api/v1/business_units","http_method":"GET","short_description":"Returns a list of all Business Units","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/business_units\n200\n{\n \"business_units\": [\n {\n \"uuid\": \"f626cff0-daa6-4727-8a69-56daea620f92\",\n \"category_code\": \"stores\"\n },\n {\n \"uuid\": \"b16377e1-bafa-44e3-a1c3-53760f571d95\",\n \"category_code\": \"managers\"\n },\n {\n \"uuid\": \"c2e1010f-7bea-4056-8014-803e12fee2b7\",\n \"category_code\": \"technologies\"\n },\n {\n \"uuid\": \"08e8d4cd-5b7d-4a36-83be-5bfd22adaafd\",\n \"category_code\": \"security\"\n },\n {\n \"uuid\": \"43cfd58d-b89b-415f-ba19-520bc4a00f98\",\n \"category_code\": \"head_office\"\n },\n {\n \"uuid\": \"5b5ff364-4bdb-45c4-be99-5089a22aa67e\",\n \"category_code\": \"ladbrokes_ho\"\n },\n {\n \"uuid\": \"6f7c86d4-86fb-4960-ac3a-47c8a914e720\",\n \"category_code\": \"agency\"\n },\n {\n \"uuid\": \"5e24b706-3af4-44c7-843d-118eb2c29b5f\",\n \"category_code\": \"retail\"\n },\n {\n \"uuid\": \"6721b23f-197a-49b7-9936-67f2fbef6339\",\n \"category_code\": \"channels\"\n },\n {\n \"uuid\": \"dd3f9226-2ee2-474c-9ee5-af97f72b0bf5\",\n \"category_code\": \"corporate_ceo\"\n },\n {\n \"uuid\": \"71469798-d680-4829-866a-653442069e70\",\n \"category_code\": \"product\"\n },\n {\n \"uuid\": \"8741c2fe-a9da-4271-9de9-795c1d408f03\",\n \"category_code\": \"customer\"\n },\n {\n \"uuid\": \"895a638b-7c03-4d63-a063-ede6a04efc38\",\n \"category_code\": \"finance_and_strategy\"\n },\n {\n \"uuid\": \"2871dcca-80d2-4adc-b623-ede2e99c88db\",\n \"category_code\": \"group_hr\"\n },\n {\n \"uuid\": \"0e38ef84-fd35-4f61-b5f9-eac8d589c7fc\",\n \"category_code\": \"operations_director_uk_retail\"\n },\n {\n \"uuid\": \"25185b47-a5a1-44c8-9601-75b982c88805\",\n \"category_code\": \"crieffhydro\"\n },\n {\n \"uuid\": \"3781188e-e0ff-44ca-ad24-98e03768a91f\",\n \"category_code\": \"0_7_recruitment\"\n },\n {\n \"uuid\": \"157f20f6-350e-4621-b765-a52a24b0254e\",\n \"category_code\": \"0_8_test\"\n },\n {\n \"uuid\": \"63ba7403-fde0-4646-8571-4260f4a18cae\",\n \"category_code\": \"0_8_5_business_unit\"\n },\n {\n \"uuid\": \"e21c00a4-6038-4955-ace3-37a3ad285353\",\n \"category_code\": \"0_9_bu\"\n },\n {\n \"uuid\": \"07c355c4-6f60-43f1-8bac-22495b69135e\",\n \"category_code\": \"rails_4_testing\"\n },\n {\n \"uuid\": \"7d6a1040-90cb-4f00-a029-7fb823083aa4\",\n \"category_code\": \"boots3\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/business_units/show","name":"show","apis":[{"api_url":"/hr_api/v1/business_units/:uuid","http_method":"GET","short_description":"Return details of an existing Business Unit","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/business_units/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"business_unit\": {\n \"uuid\": \"f626cff0-daa6-4727-8a69-56daea620f92\",\n \"category_code\": \"stores\",\n \"comments\": \"\",\n \"sort\": null,\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2012-05-01T10:13:29.000+01:00\",\n \"worksite_selection\": \"organizational_unit\",\n \"category_description\": \"Stores\",\n \"configuration_scope_names\": \"recruitment,employees\",\n \"organizational_units\": [\n {\n \"uuid\": \"e3fdeb44-2f00-46bb-96cf-6bd6f7d02ec0\",\n \"organizational_unit_id_string\": \"region_11\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:18.000+00:00\",\n \"organizational_unit_name\": \"Deep South\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n }\n ]\n },\n {\n \"uuid\": \"7559f888-6bf4-441e-ae20-d5d441b503bb\",\n \"organizational_unit_id_string\": \"test_unit\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:18.000+00:00\",\n \"organizational_unit_name\": \"test unit\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n }\n ]\n },\n {\n \"uuid\": \"c8549632-a5d9-4028-ab57-c42d282d08d1\",\n \"organizational_unit_id_string\": \"test\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:18.000+00:00\",\n \"organizational_unit_name\": \"Test\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n }\n ]\n },\n {\n \"uuid\": \"f5af87d4-fce5-44d3-b251-e80b2f48a167\",\n \"organizational_unit_id_string\": \"test2\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:18.000+00:00\",\n \"organizational_unit_name\": \"test2\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n }\n ]\n },\n {\n \"uuid\": \"24232ecf-43ec-495d-b2b0-28a694ba57ad\",\n \"organizational_unit_id_string\": \"rest\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:18.000+00:00\",\n \"organizational_unit_name\": \"rest\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n }\n ]\n },\n {\n \"uuid\": \"73ee9d59-ec8d-4e37-9d81-fd77723809e1\",\n \"organizational_unit_id_string\": \"dev_server\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:19.000+00:00\",\n \"organizational_unit_name\": \"Test from Dev on soerver\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n }\n ]\n },\n {\n \"uuid\": \"419fadf1-a5d3-47df-9e64-e37b3ef65402\",\n \"organizational_unit_id_string\": \"yorkshire\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:19.000+00:00\",\n \"organizational_unit_name\": \"Yorkshire\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"9609adce-6f75-499c-969d-3017131ec6ee\",\n \"organizational_unit_id_string\": \"r4_test_osu\",\n \"description\": \"Rails 4 Test\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Rails 4 Test\"\n }\n ]\n },\n {\n \"uuid\": \"c24dd1d0-7d24-4b9b-ac76-3397d65e48e8\",\n \"organizational_unit_id_string\": \"northern_ireland\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:17.000+00:00\",\n \"organizational_unit_name\": \"Northern Ireland\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"439612f4-909c-43b8-b550-30bf56f4e04a\",\n \"organizational_unit_id_string\": \"megastore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Megastore\"\n },\n {\n \"uuid\": \"0ce4298e-a34b-4584-8ee0-744968f98f75\",\n \"organizational_unit_id_string\": \"superstore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Superstore\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n }\n ]\n },\n {\n \"uuid\": \"d92d8d9a-903a-468d-93d0-a494a9660142\",\n \"organizational_unit_id_string\": \"south_east\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2014-01-23T10:50:32.000+00:00\",\n \"organizational_unit_name\": \"South East\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"439612f4-909c-43b8-b550-30bf56f4e04a\",\n \"organizational_unit_id_string\": \"megastore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Megastore\"\n },\n {\n \"uuid\": \"0ce4298e-a34b-4584-8ee0-744968f98f75\",\n \"organizational_unit_id_string\": \"superstore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Superstore\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"8754af0e-761e-43a5-a4bd-5083879c840e\",\n \"organizational_unit_id_string\": \"0_7_org_sub_unit\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_7_org_sub_unit\"\n },\n {\n \"uuid\": \"683073d3-f463-4e84-af9d-bcc9f0410358\",\n \"organizational_unit_id_string\": \"0_8_test_org_sub_unit\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_test_org_sub_unit\"\n },\n {\n \"uuid\": \"e648f9e7-9b7d-44fa-b63a-e0470ade1e5d\",\n \"organizational_unit_id_string\": \"0_8_5_organisational_sub_unit\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_5_organisational_sub_unit\"\n },\n {\n \"uuid\": \"379ee99d-953b-4d6a-939f-f28a4e3f4a81\",\n \"organizational_unit_id_string\": \"0_8_5_organisational_sub_unit2\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_5_organisational_sub_unit2\"\n },\n {\n \"uuid\": \"9609adce-6f75-499c-969d-3017131ec6ee\",\n \"organizational_unit_id_string\": \"r4_test_osu\",\n \"description\": \"Rails 4 Test\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Rails 4 Test\"\n },\n {\n \"uuid\": \"cde4fdff-d4d9-4293-a5f6-60b22fd0cfe5\",\n \"organizational_unit_id_string\": \"boots3\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"BootS3\"\n }\n ]\n },\n {\n \"uuid\": \"80384abe-a773-4b00-b742-b9335504c4c9\",\n \"organizational_unit_id_string\": \"eu_local\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:17.000+00:00\",\n \"organizational_unit_name\": \"European Locals\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n }\n ]\n },\n {\n \"uuid\": \"3b42dadf-b4d7-421e-91b9-6777ad94b1fd\",\n \"organizational_unit_id_string\": \"east_anglia\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:20.000+00:00\",\n \"organizational_unit_name\": \"East Anglia\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n }\n ]\n },\n {\n \"uuid\": \"9e5aebb5-7d96-4a70-a6a1-9914c9e75e6d\",\n \"organizational_unit_id_string\": \"london\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:19.000+00:00\",\n \"organizational_unit_name\": \"London\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"c9234f37-9043-425f-95ea-f13209cb1e78\",\n \"organizational_unit_id_string\": \"exceptions\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Exceptions\"\n },\n {\n \"uuid\": \"8754af0e-761e-43a5-a4bd-5083879c840e\",\n \"organizational_unit_id_string\": \"0_7_org_sub_unit\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_7_org_sub_unit\"\n },\n {\n \"uuid\": \"9609adce-6f75-499c-969d-3017131ec6ee\",\n \"organizational_unit_id_string\": \"r4_test_osu\",\n \"description\": \"Rails 4 Test\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Rails 4 Test\"\n }\n ]\n },\n {\n \"uuid\": \"71631a8e-aaa1-44d4-9cde-14f0e54a6fd4\",\n \"organizational_unit_id_string\": \"london_m25\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:15.000+00:00\",\n \"organizational_unit_name\": \"London inside M25\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"439612f4-909c-43b8-b550-30bf56f4e04a\",\n \"organizational_unit_id_string\": \"megastore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Megastore\"\n },\n {\n \"uuid\": \"0ce4298e-a34b-4584-8ee0-744968f98f75\",\n \"organizational_unit_id_string\": \"superstore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Superstore\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"cde4fdff-d4d9-4293-a5f6-60b22fd0cfe5\",\n \"organizational_unit_id_string\": \"boots3\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"BootS3\"\n }\n ]\n },\n {\n \"uuid\": \"65189483-c73e-4f8f-a751-c4c444519fd7\",\n \"organizational_unit_id_string\": \"roi\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:19.000+00:00\",\n \"organizational_unit_name\": \"Republic of Ireland\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"9609adce-6f75-499c-969d-3017131ec6ee\",\n \"organizational_unit_id_string\": \"r4_test_osu\",\n \"description\": \"Rails 4 Test\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Rails 4 Test\"\n }\n ]\n },\n {\n \"uuid\": \"a1bdd37f-9b54-4179-b14e-021e212ddfb8\",\n \"organizational_unit_id_string\": \"east_midlands\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:20.000+00:00\",\n \"organizational_unit_name\": \"East Midland\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"9609adce-6f75-499c-969d-3017131ec6ee\",\n \"organizational_unit_id_string\": \"r4_test_osu\",\n \"description\": \"Rails 4 Test\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Rails 4 Test\"\n }\n ]\n },\n {\n \"uuid\": \"a6db65df-f204-4c04-b583-414e0eba57e2\",\n \"organizational_unit_id_string\": \"west_midlands\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:19.000+00:00\",\n \"organizational_unit_name\": \"West Midlands\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"9609adce-6f75-499c-969d-3017131ec6ee\",\n \"organizational_unit_id_string\": \"r4_test_osu\",\n \"description\": \"Rails 4 Test\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Rails 4 Test\"\n }\n ]\n },\n {\n \"uuid\": \"2918c736-ba82-407b-a821-306e994b7aa2\",\n \"organizational_unit_id_string\": \"south_west\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2014-01-23T10:50:49.000+00:00\",\n \"organizational_unit_name\": \"South West\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"439612f4-909c-43b8-b550-30bf56f4e04a\",\n \"organizational_unit_id_string\": \"megastore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Megastore\"\n },\n {\n \"uuid\": \"0ce4298e-a34b-4584-8ee0-744968f98f75\",\n \"organizational_unit_id_string\": \"superstore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Superstore\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"cde4fdff-d4d9-4293-a5f6-60b22fd0cfe5\",\n \"organizational_unit_id_string\": \"boots3\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"BootS3\"\n }\n ]\n },\n {\n \"uuid\": \"1312f677-a21f-4f92-a46b-69449c1967d7\",\n \"organizational_unit_id_string\": \"wales\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:16.000+00:00\",\n \"organizational_unit_name\": \"Wales\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"0ce4298e-a34b-4584-8ee0-744968f98f75\",\n \"organizational_unit_id_string\": \"superstore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Superstore\"\n },\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"439612f4-909c-43b8-b550-30bf56f4e04a\",\n \"organizational_unit_id_string\": \"megastore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Megastore\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"cde4fdff-d4d9-4293-a5f6-60b22fd0cfe5\",\n \"organizational_unit_id_string\": \"boots3\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"BootS3\"\n }\n ]\n },\n {\n \"uuid\": \"ba634129-c20f-4a92-8207-5815be9edc51\",\n \"organizational_unit_id_string\": \"us_local\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:16.000+00:00\",\n \"organizational_unit_name\": \"US Locals\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"c6cf4903-0eed-4fd1-85f9-f3e8f59e38fd\",\n \"organizational_unit_id_string\": \"gas_station\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Petrol Station\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"683073d3-f463-4e84-af9d-bcc9f0410358\",\n \"organizational_unit_id_string\": \"0_8_test_org_sub_unit\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_test_org_sub_unit\"\n }\n ]\n },\n {\n \"uuid\": \"94469db0-dde7-49d3-8951-b4bc4597ee92\",\n \"organizational_unit_id_string\": \"north_west\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:17.000+00:00\",\n \"organizational_unit_name\": \"North West\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"439612f4-909c-43b8-b550-30bf56f4e04a\",\n \"organizational_unit_id_string\": \"megastore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Megastore\"\n },\n {\n \"uuid\": \"0ce4298e-a34b-4584-8ee0-744968f98f75\",\n \"organizational_unit_id_string\": \"superstore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Superstore\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"cde4fdff-d4d9-4293-a5f6-60b22fd0cfe5\",\n \"organizational_unit_id_string\": \"boots3\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"BootS3\"\n }\n ]\n },\n {\n \"uuid\": \"fe804072-55d6-4b95-acda-a62d8bd09314\",\n \"organizational_unit_id_string\": \"uk_local\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:16.000+00:00\",\n \"organizational_unit_name\": \"UK Locals\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"c6cf4903-0eed-4fd1-85f9-f3e8f59e38fd\",\n \"organizational_unit_id_string\": \"gas_station\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Petrol Station\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n }\n ]\n },\n {\n \"uuid\": \"f4486354-7571-4448-b155-92798e4b3020\",\n \"organizational_unit_id_string\": \"scotland\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-03-11T11:34:16.000+00:00\",\n \"organizational_unit_name\": \"Scotland\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"439612f4-909c-43b8-b550-30bf56f4e04a\",\n \"organizational_unit_id_string\": \"megastore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Megastore\"\n },\n {\n \"uuid\": \"0ce4298e-a34b-4584-8ee0-744968f98f75\",\n \"organizational_unit_id_string\": \"superstore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Superstore\"\n },\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"cde4fdff-d4d9-4293-a5f6-60b22fd0cfe5\",\n \"organizational_unit_id_string\": \"boots3\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"BootS3\"\n }\n ]\n },\n {\n \"uuid\": \"cdeceb58-5f90-4fdb-9a30-1e59aab14d35\",\n \"organizational_unit_id_string\": \"north_east\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-06-29T14:54:14.000+01:00\",\n \"organizational_unit_name\": \"North East\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"439612f4-909c-43b8-b550-30bf56f4e04a\",\n \"organizational_unit_id_string\": \"megastore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Megastore\"\n },\n {\n \"uuid\": \"0ce4298e-a34b-4584-8ee0-744968f98f75\",\n \"organizational_unit_id_string\": \"superstore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Superstore\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"8754af0e-761e-43a5-a4bd-5083879c840e\",\n \"organizational_unit_id_string\": \"0_7_org_sub_unit\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_7_org_sub_unit\"\n },\n {\n \"uuid\": \"683073d3-f463-4e84-af9d-bcc9f0410358\",\n \"organizational_unit_id_string\": \"0_8_test_org_sub_unit\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_test_org_sub_unit\"\n },\n {\n \"uuid\": \"e648f9e7-9b7d-44fa-b63a-e0470ade1e5d\",\n \"organizational_unit_id_string\": \"0_8_5_organisational_sub_unit\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_5_organisational_sub_unit\"\n },\n {\n \"uuid\": \"379ee99d-953b-4d6a-939f-f28a4e3f4a81\",\n \"organizational_unit_id_string\": \"0_8_5_organisational_sub_unit2\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_5_organisational_sub_unit2\"\n },\n {\n \"uuid\": \"9609adce-6f75-499c-969d-3017131ec6ee\",\n \"organizational_unit_id_string\": \"r4_test_osu\",\n \"description\": \"Rails 4 Test\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Rails 4 Test\"\n },\n {\n \"uuid\": \"cde4fdff-d4d9-4293-a5f6-60b22fd0cfe5\",\n \"organizational_unit_id_string\": \"boots3\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"BootS3\"\n }\n ]\n },\n {\n \"uuid\": \"c586c1a2-84b5-4b3f-bf35-bda96b935fa8\",\n \"organizational_unit_id_string\": \"inactive_test\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"inactive\",\n \"transferred_to_vms_at\": \"2013-05-15T10:57:51.000+01:00\",\n \"organizational_unit_name\": \"Inactive test\",\n \"organizational_sub_units\": []\n },\n {\n \"uuid\": \"adfe2841-3c9a-427c-a889-520f55c49e24\",\n \"organizational_unit_id_string\": \"ben_vms_copy2\",\n \"description\": \"ben vms copy\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2013-09-04T09:24:13.000+01:00\",\n \"organizational_unit_name\": \"ben vms copy2\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"878d618a-7a7d-43e6-8638-a20095a57dbd\",\n \"organizational_unit_id_string\": \"ben_vms_copy_su\",\n \"description\": \"ben vms copy su\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"ben vms copy su\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"daf7b6f2-1f62-4bae-aeeb-8a6ab8be2c2b\",\n \"organizational_unit_id_string\": \"recruitment\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Recruitment\"\n },\n {\n \"uuid\": \"483649b1-f623-4253-8f4d-f83e9e092b9a\",\n \"organizational_unit_id_string\": \"department_1\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Department 1 a\"\n },\n {\n \"uuid\": \"379ee99d-953b-4d6a-939f-f28a4e3f4a81\",\n \"organizational_unit_id_string\": \"0_8_5_organisational_sub_unit2\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_5_organisational_sub_unit2\"\n }\n ]\n },\n {\n \"uuid\": \"86887a75-7235-4330-af99-db96c97c9bc3\",\n \"organizational_unit_id_string\": \"ben_vms_copy_2\",\n \"description\": \"ben_vms_copy_2\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2013-09-03T15:15:18.000+01:00\",\n \"organizational_unit_name\": \"ben_vms_copy_2\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"d2e5e2b1-de51-4683-9c45-0b87d13a6966\",\n \"organizational_unit_id_string\": \"ben_vms_copy_su_2\",\n \"description\": \"ben_vms_copy_su_2\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"ben_vms_copy_su_2\"\n }\n ]\n },\n {\n \"uuid\": \"316ef75c-f17d-497a-ac53-120bfe548229\",\n \"organizational_unit_id_string\": \"0_8_5_test_organisational_unit\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2013-09-04T10:03:20.000+01:00\",\n \"organizational_unit_name\": \"0_8_5_test_organisational_unit\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"e648f9e7-9b7d-44fa-b63a-e0470ade1e5d\",\n \"organizational_unit_id_string\": \"0_8_5_organisational_sub_unit\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_5_organisational_sub_unit\"\n }\n ]\n },\n {\n \"uuid\": \"b669485c-ee5f-44e2-bf80-675dfb341ab5\",\n \"organizational_unit_id_string\": \"test_0_8_5\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2013-02-07T14:24:21.000+00:00\",\n \"organizational_unit_name\": \"test 0.8.5\",\n \"organizational_sub_units\": []\n },\n {\n \"uuid\": \"e27bc32b-28c4-42f7-9a47-d95d14faf8be\",\n \"organizational_unit_id_string\": \"0_7_org_unit\",\n \"description\": null,\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"inactive\",\n \"transferred_to_vms_at\": \"2013-05-22T15:15:43.000+01:00\",\n \"organizational_unit_name\": \"0_7_org_unit\",\n \"organizational_sub_units\": []\n },\n {\n \"uuid\": \"004ac32b-28c4-42f7-9a47-d95d14faf8be\",\n \"organizational_unit_id_string\": \"09_test_org_unit_import\",\n \"description\": null,\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"inactive\",\n \"transferred_to_vms_at\": \"2013-05-22T15:15:44.000+01:00\",\n \"organizational_unit_name\": \"09 Test Org Unit Import\",\n \"organizational_sub_units\": []\n },\n {\n \"uuid\": \"004ac32b-28c4-42f7-9a47-d95d14faf8be\",\n \"organizational_unit_id_string\": \"09_test_org_unit_import\",\n \"description\": null,\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"inactive\",\n \"transferred_to_vms_at\": \"2013-05-22T15:15:44.000+01:00\",\n \"organizational_unit_name\": \"09 Test Org Unit Import\",\n \"organizational_sub_units\": []\n },\n {\n \"uuid\": \"eb2fb86f-d453-4cfd-a6cc-3b521c82ab0c\",\n \"organizational_unit_id_string\": \"new_store\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2013-09-03T14:00:16.000+01:00\",\n \"organizational_unit_name\": \"New Store\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"c6cf4903-0eed-4fd1-85f9-f3e8f59e38fd\",\n \"organizational_unit_id_string\": \"gas_station\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Petrol Station\"\n }\n ]\n },\n {\n \"uuid\": \"2802bef4-1e21-4f84-92d7-f770eab22786\",\n \"organizational_unit_id_string\": \"test4\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2013-09-03T15:11:38.000+01:00\",\n \"organizational_unit_name\": \"test4\",\n \"organizational_sub_units\": []\n },\n {\n \"uuid\": \"3b8ac110-6902-4fe8-9af3-715ac948149b\",\n \"organizational_unit_id_string\": \"new5\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2013-09-03T15:17:11.000+01:00\",\n \"organizational_unit_name\": \"new\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"c6cf4903-0eed-4fd1-85f9-f3e8f59e38fd\",\n \"organizational_unit_id_string\": \"gas_station\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Petrol Station\"\n },\n {\n \"uuid\": \"daf7b6f2-1f62-4bae-aeeb-8a6ab8be2c2b\",\n \"organizational_unit_id_string\": \"recruitment\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Recruitment\"\n }\n ]\n },\n {\n \"uuid\": \"68fea6d2-7efa-42f0-9c9c-f373e0e5be64\",\n \"organizational_unit_id_string\": \"r4_test_ou\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2013-12-06T12:48:08.000+00:00\",\n \"organizational_unit_name\": \"Rails 4 Test\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"826720b1-1ec0-43c2-9301-0d8056c4cd62\",\n \"organizational_unit_id_string\": \"department_3\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Department 3\"\n },\n {\n \"uuid\": \"c9234f37-9043-425f-95ea-f13209cb1e78\",\n \"organizational_unit_id_string\": \"exceptions\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Exceptions\"\n }\n ]\n },\n {\n \"uuid\": \"3806002b-9505-48d7-abcb-97536ee2b7fe\",\n \"organizational_unit_id_string\": \"boots3\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2014-01-16T10:26:24.000+00:00\",\n \"organizational_unit_name\": \"BootS3\",\n \"organizational_sub_units\": []\n },\n {\n \"uuid\": \"68f442cf-6e26-4d30-83fa-299bf2450b02\",\n \"organizational_unit_id_string\": \"a\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2014-01-23T10:54:05.000+00:00\",\n \"organizational_unit_name\": \"a\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"75878428-9f37-4fcf-81c1-55911a5e4206\",\n \"organizational_unit_id_string\": \"a\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"a\"\n }\n ]\n },\n {\n \"uuid\": \"e525d983-b11e-4b48-9415-52e06aa5ff88\",\n \"organizational_unit_id_string\": \"tes3\",\n \"description\": \"test\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2014-01-23T14:29:32.000+00:00\",\n \"organizational_unit_name\": \"test3\",\n \"organizational_sub_units\": []\n }\n ],\n \"vms_job_levels\": [\n {\n \"uuid\": \"8bc64394-8228-49d4-9e5b-35dee03b5781\",\n \"category_code\": \"PSA\",\n \"comments\": \"\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Permanent Sales Advisor\"\n },\n {\n \"uuid\": \"88082bd8-a172-4e41-a081-4e080cb20819\",\n \"category_code\": \"AM\",\n \"comments\": \"\",\n \"sort\": 20,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Assistant Manager\"\n },\n {\n \"uuid\": \"db31a581-334d-4726-af5f-2ea0914c1bbf\",\n \"category_code\": \"GS_07\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"0_7_Test_Job\"\n },\n {\n \"uuid\": \"4fa53a4e-a813-4243-a2cc-e2ec44e461d8\",\n \"category_code\": \"TM\",\n \"comments\": \"\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"category_filter\": \"team_members\",\n \"category_description\": \"Trainee Manager\"\n },\n {\n \"uuid\": \"ef2d093a-b9ec-4b5d-967f-5a8f67f51e98\",\n \"category_code\": \"another_new_job_level\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Another New Job Level\"\n },\n {\n \"uuid\": \"6ae6731a-2be7-40d4-8bc1-6a1f522725f3\",\n \"category_code\": \"AreaM 0.9\",\n \"comments\": \"\",\n \"sort\": 11,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Area Manager 0.9\"\n },\n {\n \"uuid\": \"0f841d0e-7c7e-400f-8397-537381ed2605\",\n \"category_code\": \"0.9 Test Job Level\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"0.9 Test Job Level\"\n },\n {\n \"uuid\": \"8fa46ec3-9158-411f-a07b-4d4d7b5efcc4\",\n \"category_code\": \"Rails 4 Test\",\n \"comments\": \"Testing for rails 4\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Rails 4\"\n },\n {\n \"uuid\": \"8d98b1a0-c360-4259-a5f8-02fc653313a0\",\n \"category_code\": \"boots3\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"BootS3\"\n },\n {\n \"uuid\": \"4a7bd663-ec16-46fc-b732-960bc124f536\",\n \"category_code\": \"Cute\",\n \"comments\": \"Cute\",\n \"sort\": 100,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Cute\"\n }\n ],\n \"remuneration_package_keywords\": [\n {\n \"uuid\": \"a29e3f73-c030-4c53-b610-370c3c0a3254\",\n \"name\": \"remun kw\",\n \"currency_code\": null,\n \"base_interval\": \"year\",\n \"base_pay_amount_min\": 1234,\n \"base_pay_amount_max\": 123567,\n \"other_interval\": null,\n \"other_pay_amount_min\": null,\n \"other_pay_amount_max\": null,\n \"other_pay_calculation\": \"\",\n \"other_pay_comments\": \"\",\n \"insurance\": null,\n \"insurance_type\": \"\",\n \"retirement_or_savings_plan\": null,\n \"company_vehicle\": null,\n \"company_vehicle_description\": \"\",\n \"relocation_assistance\": null,\n \"relocation_assistance_description\": \"\",\n \"visa_sponsorship\": \"\",\n \"time_off_allowance\": \"\",\n \"expatriate_benefits\": \"\",\n \"other_benefits\": \"\",\n \"comments\": \"\",\n \"title\": \"test\",\n \"is_keyword\": true,\n \"sort\": 10,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"ca15baea-f433-413a-b549-0cb84fc50396\",\n \"name\": \"rem package keyword\",\n \"currency_code\": null,\n \"base_interval\": \"year\",\n \"base_pay_amount_min\": 1,\n \"base_pay_amount_max\": 234,\n \"other_interval\": null,\n \"other_pay_amount_min\": null,\n \"other_pay_amount_max\": null,\n \"other_pay_calculation\": \"\",\n \"other_pay_comments\": \"\",\n \"insurance\": null,\n \"insurance_type\": \"\",\n \"retirement_or_savings_plan\": null,\n \"company_vehicle\": null,\n \"company_vehicle_description\": \"\",\n \"relocation_assistance\": null,\n \"relocation_assistance_description\": \"\",\n \"visa_sponsorship\": \"\",\n \"time_off_allowance\": \"\",\n \"expatriate_benefits\": \"\",\n \"other_benefits\": \"\",\n \"comments\": \"\",\n \"title\": \"test rem package keyworda\",\n \"is_keyword\": true,\n \"sort\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"4629df90-7ffe-44bf-a340-2a7e8ee82b37\",\n \"name\": \"final_test_rem_package\",\n \"currency_code\": null,\n \"base_interval\": \"year\",\n \"base_pay_amount_min\": 123,\n \"base_pay_amount_max\": 321,\n \"other_interval\": null,\n \"other_pay_amount_min\": null,\n \"other_pay_amount_max\": null,\n \"other_pay_calculation\": \"\",\n \"other_pay_comments\": \"\",\n \"insurance\": null,\n \"insurance_type\": \"\",\n \"retirement_or_savings_plan\": null,\n \"company_vehicle\": null,\n \"company_vehicle_description\": \"\",\n \"relocation_assistance\": null,\n \"relocation_assistance_description\": \"\",\n \"visa_sponsorship\": \"\",\n \"time_off_allowance\": \"\",\n \"expatriate_benefits\": \"\",\n \"other_benefits\": \"\",\n \"comments\": \"\",\n \"title\": \"final_test_rem_package\",\n \"is_keyword\": true,\n \"sort\": 10,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"c42c6904-2b66-4998-8dd4-3247630fd30c\",\n \"name\": \"15 to 25 k\",\n \"currency_code\": null,\n \"base_interval\": \"month\",\n \"base_pay_amount_min\": 4,\n \"base_pay_amount_max\": 25000,\n \"other_interval\": null,\n \"other_pay_amount_min\": null,\n \"other_pay_amount_max\": null,\n \"other_pay_calculation\": \"\",\n \"other_pay_comments\": \"\",\n \"insurance\": null,\n \"insurance_type\": \"\",\n \"retirement_or_savings_plan\": null,\n \"company_vehicle\": null,\n \"company_vehicle_description\": \"\",\n \"relocation_assistance\": null,\n \"relocation_assistance_description\": \"\",\n \"visa_sponsorship\": \"\",\n \"time_off_allowance\": \"\",\n \"expatriate_benefits\": \"\",\n \"other_benefits\": \"\",\n \"comments\": \"\",\n \"title\": \"£15k to £25k\",\n \"is_keyword\": true,\n \"sort\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"2b0e8072-2ac7-40e5-b3f4-bae230ae5023\",\n \"name\": \"0.9 Salary\",\n \"currency_code\": null,\n \"base_interval\": \"month\",\n \"base_pay_amount_min\": 500,\n \"base_pay_amount_max\": null,\n \"other_interval\": null,\n \"other_pay_amount_min\": null,\n \"other_pay_amount_max\": null,\n \"other_pay_calculation\": \"\",\n \"other_pay_comments\": \"\",\n \"insurance\": null,\n \"insurance_type\": \"\",\n \"retirement_or_savings_plan\": null,\n \"company_vehicle\": null,\n \"company_vehicle_description\": \"\",\n \"relocation_assistance\": null,\n \"relocation_assistance_description\": \"\",\n \"visa_sponsorship\": \"\",\n \"time_off_allowance\": \"\",\n \"expatriate_benefits\": \"\",\n \"other_benefits\": \"\",\n \"comments\": \"\",\n \"title\": \"CandidateProfile Remuneration\",\n \"is_keyword\": true,\n \"sort\": 12,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"92a8ae41-eecf-49b3-bad9-742a78000102\",\n \"name\": \"Rails 4.0 Test\",\n \"currency_code\": null,\n \"base_interval\": \"year\",\n \"base_pay_amount_min\": 10000,\n \"base_pay_amount_max\": 15000,\n \"other_interval\": null,\n \"other_pay_amount_min\": null,\n \"other_pay_amount_max\": null,\n \"other_pay_calculation\": \"\",\n \"other_pay_comments\": \"\",\n \"insurance\": null,\n \"insurance_type\": \"\",\n \"retirement_or_savings_plan\": null,\n \"company_vehicle\": null,\n \"company_vehicle_description\": \"\",\n \"relocation_assistance\": null,\n \"relocation_assistance_description\": \"\",\n \"visa_sponsorship\": \"\",\n \"time_off_allowance\": \"\",\n \"expatriate_benefits\": \"\",\n \"other_benefits\": \"\",\n \"comments\": \"\",\n \"title\": \"Rails testing\",\n \"is_keyword\": true,\n \"sort\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"2d7d436e-f3da-4c4e-86c9-e50bca0e7333\",\n \"name\": \"boots3_remu\",\n \"currency_code\": null,\n \"base_interval\": \"year\",\n \"base_pay_amount_min\": 20001,\n \"base_pay_amount_max\": 25001,\n \"other_interval\": null,\n \"other_pay_amount_min\": null,\n \"other_pay_amount_max\": null,\n \"other_pay_calculation\": \"\",\n \"other_pay_comments\": \"\",\n \"insurance\": null,\n \"insurance_type\": \"\",\n \"retirement_or_savings_plan\": null,\n \"company_vehicle\": null,\n \"company_vehicle_description\": \"\",\n \"relocation_assistance\": null,\n \"relocation_assistance_description\": \"\",\n \"visa_sponsorship\": \"\",\n \"time_off_allowance\": \"\",\n \"expatriate_benefits\": \"\",\n \"other_benefits\": \"\",\n \"comments\": \"\",\n \"title\": \"20K-25K\",\n \"is_keyword\": true,\n \"sort\": null,\n \"category_status\": \"active\"\n }\n ],\n \"shift_keywords\": [\n {\n \"uuid\": \"08460745-2387-4135-850a-b4d557043066\",\n \"name\": \"shift keyword\",\n \"hours\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"pay_type_hours\": \"shift keyword\",\n \"comments\": null,\n \"title\": \"shift keyword\",\n \"is_keyword\": true,\n \"sort\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"1802d48b-e309-4672-9387-9e47c52ef530\",\n \"name\": \"shift keyword #2\",\n \"hours\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"pay_type_hours\": \"shift keyword #2\",\n \"comments\": null,\n \"title\": \"shift keyword #2\",\n \"is_keyword\": true,\n \"sort\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"bda2d47b-3532-4f1c-93bc-690dd841f8d4\",\n \"name\": \"unassoc_shift_keyword\",\n \"hours\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"pay_type_hours\": \"unassoc_shift_keyword #hours\",\n \"comments\": null,\n \"title\": \"unassoc_shift_keyword\",\n \"is_keyword\": true,\n \"sort\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"d48d3926-5d2c-4381-8ed5-9f673e99db47\",\n \"name\": \"unassoc_shift_keyword 2\",\n \"hours\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"pay_type_hours\": \"unassoc_shift_keyword #hours\",\n \"comments\": null,\n \"title\": \"unassoc_shift_keyword 2\",\n \"is_keyword\": true,\n \"sort\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"155155fd-986c-4903-9dd4-9a2471b30f06\",\n \"name\": \"shift1\",\n \"hours\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"pay_type_hours\": \"4\",\n \"comments\": null,\n \"title\": \"shift\",\n \"is_keyword\": true,\n \"sort\": 1,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"f33826aa-ee33-4c43-ae18-767fd9bcd36e\",\n \"name\": \"shift11 amended\",\n \"hours\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"pay_type_hours\": \"44\",\n \"comments\": null,\n \"title\": \"shiftOne\",\n \"is_keyword\": true,\n \"sort\": 10,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"a9c706e9-f6f8-4142-b3af-347a76f1c197\",\n \"name\": \"0.9 Shift\",\n \"hours\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"pay_type_hours\": \"38\",\n \"comments\": null,\n \"title\": \"Shift 0.9\",\n \"is_keyword\": true,\n \"sort\": 12,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"10e5651b-1b0c-45a5-9afd-e553c59c553e\",\n \"name\": \"Rails 4.0 Test\",\n \"hours\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"pay_type_hours\": \"20\",\n \"comments\": null,\n \"title\": \"Rails 4\",\n \"is_keyword\": true,\n \"sort\": 105,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"5298744a-4bef-4fd8-9ee4-32c4d9492f13\",\n \"name\": \"Boot S3 Shift\",\n \"hours\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"pay_type_hours\": \"42\",\n \"comments\": null,\n \"title\": \"9-7\",\n \"is_keyword\": true,\n \"sort\": null,\n \"category_status\": \"active\"\n }\n ],\n \"contract_types\": [\n {\n \"uuid\": \"9286e97a-823a-4eda-8bf0-697db694eab1\",\n \"category_code\": \"test1\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"comments\": \"test\",\n \"category_description\": \"test1\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,bdZ9wnUjTbx7OzuGVeOa-y,bVFiBuHVTjykW6r8IPfoCG\"\n },\n {\n \"uuid\": \"482fa7d6-10f6-44fb-ba94-23dcd740972a\",\n \"category_code\": \"second contact type\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"comments\": \"second contact type\",\n \"category_description\": \"second contact type\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,bdZ9wnUjTbx7OzuGVeOa-y,bBx_nKs9TfXl6zuiMIkQz-\"\n },\n {\n \"uuid\": null,\n \"category_code\": \"import_test\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"comments\": null,\n \"category_description\": \"Import Test\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,bdZ9wnUjTbx7OzuGVeOa-y\"\n },\n {\n \"uuid\": null,\n \"category_code\": \"import_test_2\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"comments\": \"second contact type\",\n \"category_description\": \"Import Test 2\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,bdZ9wnUjTbx7OzuGVeOa-y\"\n },\n {\n \"uuid\": \"fc4cf021-e490-41dd-8e50-6417293fcec2\",\n \"category_code\": \"0.9 ft\",\n \"sort\": 111,\n \"category_status\": \"active\",\n \"comments\": \"\",\n \"category_description\": \"Full Time\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,dc4qepE-PavOauGd4s_Uk3,bBx_nKs9TfXl6zuiMIkQz-,bEjlCgoVreX4q9ey6YWPTF\"\n },\n {\n \"uuid\": \"51a8bdbb-6dfa-4d11-b33a-180cdd3cec1d\",\n \"category_code\": \"Rails 4 Testing\",\n \"sort\": 90,\n \"category_status\": \"active\",\n \"comments\": \"Testing 123\",\n \"category_description\": \"Rails 4 Test\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,bdZ9wnUjTbx7OzuGVeOa-y,bBx_nKs9TfXl6zuiMIkQz-,bEjlCgoVreX4q9ey6YWPTF,bNiBi_gxPjT5K2z_l772m5,bXrPEy1ObikyzQztrcbP5W,cjwMolFanny6bJ7EAGtVW4\"\n },\n {\n \"uuid\": \"68a906ff-78b7-4235-8f3c-8a19c3ecaaf4\",\n \"category_code\": \"boots3\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"comments\": \"\",\n \"category_description\": \"BootS3 Edit\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,cXy3FHUVPe46hdu3ypvX2v,dc4qepE-PavOauGd4s_Uk3,bdZ9wnUjTbx7OzuGVeOa-y,bEjlCgoVreX4q9ey6YWPTF\"\n }\n ],\n \"job_category_ones\": [\n {\n \"job_category_one_id\": null,\n \"uuid\": \"f8795ca8-ee85-436f-b182-5936c62a99ad\",\n \"category_code\": \"1-1\",\n \"comments\": \"\u003cp\u003ecomments test\u003c/p\u003e\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Category One 1\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,dc4qepE-PavOauGd4s_Uk3\"\n },\n {\n \"job_category_one_id\": null,\n \"uuid\": \"9bfd612a-faac-4dbd-b90e-1bd10e357503\",\n \"category_code\": \"job_category_4\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Job Cat 4\",\n \"business_unit_references\": \"bBx_nKs9TfXl6zuiMIkQz-,d2jS_W2Qzhj4PPvTRQyG-s\"\n },\n {\n \"job_category_one_id\": null,\n \"uuid\": \"a7c66e80-d708-4b4b-8f24-6626d2ecc0e6\",\n \"category_code\": \"job_category_3\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Job Cat 3\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,bBx_nKs9TfXl6zuiMIkQz-,cXy3FHUVPe46hdu3ypvX2v\"\n },\n {\n \"job_category_one_id\": null,\n \"uuid\": \"b7967c3b-57e2-45e1-918f-c2591f4a3e9c\",\n \"category_code\": \"jc11\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"zxc\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,d2jS_W2Qzhj4PPvTRQyG-s\"\n },\n {\n \"job_category_one_id\": null,\n \"uuid\": \"b7967c3b-57e2-45e1-918f-c2591f4a3e9c\",\n \"category_code\": \"jc11\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"zxc\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,d2jS_W2Qzhj4PPvTRQyG-s\"\n },\n {\n \"job_category_one_id\": null,\n \"uuid\": \"05fa0918-ff70-4c9b-a763-2dbf1409d1af\",\n \"category_code\": \"0_9__job_cat\",\n \"comments\": \"\",\n \"sort\": 99,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"0.9 Testing\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s\"\n },\n {\n \"job_category_one_id\": null,\n \"uuid\": \"43d60f4c-1b81-4ef3-b4a0-c7ad7d1f655b\",\n \"category_code\": \"1-2-3\",\n \"comments\": \"\",\n \"sort\": 20,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Category One 2 trhee\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s\"\n },\n {\n \"job_category_one_id\": null,\n \"uuid\": \"e21c39fc-7dd6-42bc-8d03-7372640005fa\",\n \"category_code\": \"R4_test_JC1\",\n \"comments\": \"Testing 123\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Rails 4 test\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,bdZ9wnUjTbx7OzuGVeOa-y,bNiBi_gxPjT5K2z_l772m5,chqCl-QDPcCz3PEvWDqi8d\"\n },\n {\n \"job_category_one_id\": null,\n \"uuid\": \"83e6e227-f8a9-4177-a855-3b5b256b5de0\",\n \"category_code\": \"boots31\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"BootS31\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,cXy3FHUVPe46hdu3ypvX2v,dc4qepE-PavOauGd4s_Uk3,bdZ9wnUjTbx7OzuGVeOa-y\"\n }\n ],\n \"job_category_twos\": [\n {\n \"job_category_two_id\": null,\n \"uuid\": \"6cb3cff7-482b-4164-96f8-32868a486a3f\",\n \"category_code\": \"2-2\",\n \"comments\": \"\u003cp\u003esadf\u003c/p\u003e\",\n \"sort\": 5,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Category Two - 2\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s\"\n },\n {\n \"job_category_two_id\": null,\n \"uuid\": \"3b088272-73e3-4bf1-8815-c569e6d43c34\",\n \"category_code\": \"jc222\",\n \"comments\": \"\",\n \"sort\": 1,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"22\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,cXy3FHUVPe46hdu3ypvX2v,bBx_nKs9TfXl6zuiMIkQz-\"\n },\n {\n \"job_category_two_id\": null,\n \"uuid\": \"79ea0013-c6f9-4346-85c9-9325ec77bc46\",\n \"category_code\": \"0.9 jc 2\",\n \"comments\": \"\",\n \"sort\": 111,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Job Cat 2 0.9\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,dc4qepE-PavOauGd4s_Uk3\"\n },\n {\n \"job_category_two_id\": null,\n \"uuid\": \"3615278f-129c-4599-be9b-7da7ae684c9a\",\n \"category_code\": \"cost_centre_1\",\n \"comments\": \"\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Cost Center 1 amended\",\n \"business_unit_references\": \"bBx_nKs9TfXl6zuiMIkQz-,d2jS_W2Qzhj4PPvTRQyG-s\"\n },\n {\n \"job_category_two_id\": null,\n \"uuid\": \"dbd571a0-2da2-4071-9449-16935a8d21f2\",\n \"category_code\": \"R4_test_JC2\",\n \"comments\": \"Rails 4 test\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Rails 4 testing\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,bVFiBuHVTjykW6r8IPfoCG,bEjlCgoVreX4q9ey6YWPTF,dDp5iMlUjhtj7LR5F3kWV1,bXrPEy1ObikyzQztrcbP5W\"\n },\n {\n \"job_category_two_id\": null,\n \"uuid\": \"f9f5feb7-606c-4ff6-b78c-dd4d4574d7dc\",\n \"category_code\": \"boots31\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"BootS31\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,cXy3FHUVPe46hdu3ypvX2v,dc4qepE-PavOauGd4s_Uk3,bdZ9wnUjTbx7OzuGVeOa-y\"\n }\n ],\n \"job_category_threes\": [\n {\n \"job_category_three_id\": null,\n \"uuid\": null,\n \"category_code\": \"T3-1\",\n \"comments\": \"\u003cp\u003efgsd\u003c/p\u003e\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Category Three - T1\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,cXy3FHUVPe46hdu3ypvX2v\"\n },\n {\n \"job_category_three_id\": null,\n \"uuid\": \"f49c340b-1075-4e0b-a8eb-84b7ce387bcf\",\n \"category_code\": \"jc33\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"jc33\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,bdZ9wnUjTbx7OzuGVeOa-y\"\n },\n {\n \"job_category_three_id\": null,\n \"uuid\": \"59db3d1b-9e37-4b08-b5ff-d950bf387472\",\n \"category_code\": \"jc3 0.9\",\n \"comments\": \"\",\n \"sort\": 111,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"0.9 Job Cat 3\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,dc4qepE-PavOauGd4s_Uk3,bBx_nKs9TfXl6zuiMIkQz-\"\n },\n {\n \"job_category_three_id\": null,\n \"uuid\": \"8ee63d0b-10ad-4ed0-ad90-ed17410dec8c\",\n \"category_code\": \"3-2\",\n \"comments\": \"\",\n \"sort\": 20,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Category Three - 2 amended\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,dc4qepE-PavOauGd4s_Uk3\"\n },\n {\n \"job_category_three_id\": null,\n \"uuid\": \"0365c522-fa61-4f97-8c31-649bbd4b08b2\",\n \"category_code\": \"boots31\",\n \"comments\": \"\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"BootS31\",\n \"business_unit_references\": \"d2jS_W2Qzhj4PPvTRQyG-s,cXy3FHUVPe46hdu3ypvX2v,dc4qepE-PavOauGd4s_Uk3,bdZ9wnUjTbx7OzuGVeOa-y\"\n },\n {\n \"job_category_three_id\": null,\n \"uuid\": \"bc964216-de37-49f0-a4aa-1fc1e2845011\",\n \"category_code\": \"3-1\",\n \"comments\": \"\u003cp\u003efgsd\u003c/p\u003e\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"category_filter\": null,\n \"category_description\": \"Category Three - 1\",\n \"business_unit_references\": \"ahW1xeB2bd8yUSiKLBArnE,d2jS_W2Qzhj4PPvTRQyG-s\"\n }\n ]\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"worksites":{"doc_url":"/hr_api/v1/1.0/worksites","id":"worksites","api_url":"","name":"Worksites","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/worksites/index","name":"index","apis":[{"api_url":"/hr_api/v1/worksites","http_method":"GET","short_description":"Returns a list of active Worksites","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/worksites\n200\n{\n \"worksites\": [\n {\n \"uuid\": \"ab000d1b-010d-4625-bebe-8d3011900bee\",\n \"postal_code\": \"RG9 1EY\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"736b013e-5b48-46c9-8adf-33a9b552202b\",\n \"postal_code\": \"rg91ey\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"2eb074e8-982b-4c17-9161-5ee87abdddb5\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"343e490a-9590-2b6b-c89e-73eac020b4b8\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"e0eeb731-2532-a8ca-869a-2feac020b4b8\",\n \"postal_code\": \"TN23 1AE\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"423e490a-9590-2b6b-c89e-73eac020b4b8\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"0c332318-5219-4292-b956-45cadc008dde\",\n \"postal_code\": \"RG9 1EY\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"736de175-d873-4c2e-84ba-3fdae88f6313\",\n \"postal_code\": \"\",\n \"category_status\": \"Active\"\n },\n {\n \"uuid\": \"cf0499f5-30c7-4ddc-b0f9-6f8d0b2e67e6\",\n \"postal_code\": \"\",\n \"category_status\": \"Active\"\n },\n {\n \"uuid\": \"a3d939cc-8478-4b5c-9ed9-abf25108047f\",\n \"postal_code\": \"\",\n \"category_status\": \"Active\"\n },\n {\n \"uuid\": \"72a7255f-3cd6-42f2-a07d-e9633b3388c0\",\n \"postal_code\": \"\",\n \"category_status\": \"Active\"\n },\n {\n \"uuid\": \"c6e40a69-9fc6-43bc-9022-0acb208a9a30\",\n \"postal_code\": \"\",\n \"category_status\": \"Active\"\n },\n {\n \"uuid\": \"8774a028-f216-43ee-85cd-1113e6887d19\",\n \"postal_code\": \"\",\n \"category_status\": \"Active\"\n },\n {\n \"uuid\": \"fcc913dd-8c4f-4921-af91-16c3ef0234da\",\n \"postal_code\": \"AB1 1HW\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"7dd28ec1-951e-4be6-a433-10bf871019bc\",\n \"postal_code\": \"WA14 1RJ\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"1cd0f924-2a56-40ad-af22-79c02e89f2cd\",\n \"postal_code\": \"\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"9aedb83b-adcc-494c-aa32-a1a68bc940d0\",\n \"postal_code\": \"TN23 1AE\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"bec1b3f7-8709-4fb8-afd4-60af3d3d2205\",\n \"postal_code\": \"\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"1148b727-46c5-4076-9186-c742e730a9d2\",\n \"postal_code\": \"HP20 1ST\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"7870b668-db4c-422e-8cc4-2644a6c0d485\",\n \"postal_code\": \"KA7 1QT\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"fcda775e-575b-4944-baab-d18df05ca314\",\n \"postal_code\": \"KA7 1TN\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"9bed9a74-791a-4a53-9d4c-df8bbf4b52ce\",\n \"postal_code\": \"BT43 6UF\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"041f82b4-a449-4806-a7fe-ceba3e338ca3\",\n \"postal_code\": \"BT43 6AH\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"b35ef20c-a1b5-48cf-bb5c-690ca7b17561\",\n \"postal_code\": \"LL57 2UP\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"35c964da-e376-46a2-a780-8a1848901dbe\",\n \"postal_code\": \"BT19 7HB\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"f598be7e-2e74-4423-85b9-f41b83b91240\",\n \"postal_code\": \"IG11 0AS\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"c5e91f9c-e301-45a5-adf2-a7e8b3b760fd\",\n \"postal_code\": \"LA14 1DB\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"afb13d8c-d21e-4ba5-a5cb-e0b9ea5397ca\",\n \"postal_code\": \"SS14 1EX\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"15d66473-829b-474f-887f-fb95ebd427ef\",\n \"postal_code\": \"RG21 7BF\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"e4db8313-0427-44fe-a948-2333341c8024\",\n \"postal_code\": \"BA1 1QE\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"7624f8af-7196-475c-a5de-65ac6c4933bb\",\n \"postal_code\": \"E6 7ER\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"34e87b61-835d-46ca-93d5-a1a65810dea8\",\n \"postal_code\": \"MK40 15Y\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"053f4726-6175-469b-ab6a-71017e56db94\",\n \"postal_code\": \"BT12 6HU\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"7fe425a1-2557-407d-b4bf-0ae868a2c31b\",\n \"postal_code\": \"BT1 5BB\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"41469454-3663-44a1-bab8-6aa08b21d3c4\",\n \"postal_code\": \"BT8 6FX\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"67f72ab8-e105-488a-b552-6dfdfccbe35e\",\n \"postal_code\": \"BT1 5BA\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"619512c5-034b-465b-a3e4-cb580a772c7b\",\n \"postal_code\": \"SL9 7AH\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"d6488b2e-4e05-43e9-b1d4-2a62ec068e50\",\n \"postal_code\": \"RH3 7HB\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"ea2a04c5-7ef6-4f41-9713-aebcfac6f809\",\n \"postal_code\": \"DA6 7JJ\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"5d7055b0-4f6a-43fa-b510-2f670397693b\",\n \"postal_code\": \"CH41 2ZL\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"9ffbaf31-f785-4ca7-b2dc-67d0d0ebc124\",\n \"postal_code\": \"\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"3676e650-48ec-4d17-96f8-8f477fb6058f\",\n \"postal_code\": \"B5 4BG\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"d466e533-aa82-40b0-8c50-64bb179cb338\",\n \"postal_code\": \"B24 9FP\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"de691985-11f2-4f7c-ab6e-2f10afab8a24\",\n \"postal_code\": \"BB1 7JB\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"9dcc20f7-af67-452b-b82f-e924f997c995\",\n \"postal_code\": \"FY1 4RS\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"db6c2abf-d635-4d33-8a84-63aa0f157b85\",\n \"postal_code\": \"DA9 9SP\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"32ccdcff-f3f5-4674-bc62-2ed37507d1c9\",\n \"postal_code\": \"BL1 2AL\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"d91bf7e4-4c11-4463-883d-a62380b5bd2b\",\n \"postal_code\": \"RG9 1EY\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"01703126-0ad3-05e4-5857-ba1eb5db7e39\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"99fa1140-758c-4d0a-907a-4ba062b7635c\",\n \"postal_code\": \"BH1 1LG\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"8504fe38-b641-4794-8081-24235ac99aba\",\n \"postal_code\": \"BH8 9UZ\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"58bc3577-8ccd-4893-a591-1538205f1334\",\n \"postal_code\": \"BD1 1QR\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"dc002e22-ac06-4d0d-8f85-78fa5056d1dd\",\n \"postal_code\": \"NW4 3FP\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"630704f5-49a6-44c8-9b15-e16050ded456\",\n \"postal_code\": \"BN1 2RG\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"479c2dc7-1b0e-410b-a130-f35f81809583\",\n \"postal_code\": \"BS1 3HN\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"b7bc2dfd-ffc6-48ba-8f60-5356fc0958d8\",\n \"postal_code\": \"BR1 1DD\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"00aef428-38f2-453b-ae53-d89b6e9d6f4b\",\n \"postal_code\": \"WC1N 1AF\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"d7694346-17e2-4a41-a86d-72e03ffa2772\",\n \"postal_code\": \"BB11 1AX\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"c7a2c41e-fdaf-46e9-a6b6-f8b78a7598fb\",\n \"postal_code\": \"DE14 1DD\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"64a0f93e-76ed-4203-ba89-f81e8d13d38a\",\n \"postal_code\": \"IP33 3FA\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"9f73b1dc-3d50-462e-9e9e-231fefe51eb3\",\n \"postal_code\": \"GU15 3SW\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"d43d64c6-d7e7-46d6-8ff5-b58a53ac2804\",\n \"postal_code\": \"CB2 3BJ\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"825063ce-8743-45ee-b3c4-2dda99cd4bbb\",\n \"postal_code\": \"08028\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"d7586253-37c2-4ef8-863c-64729da180b8\",\n \"postal_code\": \"E14 4QS\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"23114ab3-dd85-4940-895b-967cb1152277\",\n \"postal_code\": \"CT1 2TD\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"6afdd399-2d9a-4698-b4e5-b93010b9bb30\",\n \"postal_code\": \"CF10 2BE\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"a61f433c-96a6-43e5-9e9e-d6b7c9da8079\",\n \"postal_code\": \"CA3 8JU\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"b95206bb-e3bb-41c4-a1f5-323bcc7f242e\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"6af2f6c6-9ceb-427c-b9ef-38040d916753\",\n \"postal_code\": \"RG9 1UP\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"cd9540c2-1bee-456c-b1de-7e554ca8f070\",\n \"postal_code\": \"EC2V 7JB\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"2d9325b7-482e-40b8-a994-99c890ebae07\",\n \"postal_code\": \"CM2 6XE\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"fbd9964e-5e21-4086-98ce-298ba1dcc81a\",\n \"postal_code\": \"GL50 1JZ\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"cf2f7d7e-a1a0-4b7d-9cad-8f3212dbbd4d\",\n \"postal_code\": \"EN8 0QL\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"70c875ef-d8ee-48ec-a0ed-976c69541aa8\",\n \"postal_code\": \"CH4 0DP\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"a9c1da33-a590-4569-9dd4-31be3a2cb4c1\",\n \"postal_code\": \"CH1 1ER\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"d20225b3-f387-4af7-bcf8-a90c57942b50\",\n \"postal_code\": \"S40 1PY\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"7dce2c94-76b7-4109-a827-420cde7b089f\",\n \"postal_code\": \"PO19 1HA\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"7e812499-6c29-4be6-8f29-f536e7135a6a\",\n \"postal_code\": \"CO1 1LX\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"9c73cbee-9310-424e-8347-bb12c39aa453\",\n \"postal_code\": \"NN17 1BH\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"f20e5416-fef5-4623-9847-d99e67936801\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"2f361b9f-414d-49c8-8567-4e4db1d52d69\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"fcbcb525-237a-448b-b824-8bf670432480\",\n \"postal_code\": \"CV1 1DD\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"ab20f3ba-b141-49a6-8d53-e34ccd20b218\",\n \"postal_code\": \"SW11 1NJ\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"b4070b38-49da-4dd4-88c3-33e1ba8636ad\",\n \"postal_code\": \"BT64 1AA\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"76d22ae5-31e3-4dbf-9a62-0c129731e288\",\n \"postal_code\": \"RH10 1FF\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"41b191c2-cca9-4b48-bb27-47a0241c0127\",\n \"postal_code\": \"CW1 2EL\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"6e7daee1-8907-418f-b509-afe4da549cf6\",\n \"postal_code\": \"BS34 5UP\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"2b54d6d0-50ea-4fde-af01-92d3300cb090\",\n \"postal_code\": \"CR0 1US\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"1fcd8493-b1fe-49fa-a56e-3693d2afcc0c\",\n \"postal_code\": \"G69 1YW\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"b3fceaef-7258-41fb-b300-66cdf04f6f88\",\n \"postal_code\": \"NP44 1PS\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"eae69b80-1157-4840-96be-037d269a4180\",\n \"postal_code\": \"DL1 1TR\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"6b7b82ce-61a9-4426-be91-da569316abae\",\n \"postal_code\": \"M34 3LY\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"61a6ae45-4683-4287-bdb8-08a8866b2791\",\n \"postal_code\": \"DE1 2PR\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"49dffd54-0a36-4b64-ba2b-3ec5e2b27e96\",\n \"postal_code\": \"DN1 1LF\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"666b07ab-cc30-4db1-a727-97a4ef437531\",\n \"postal_code\": \"3311 BT\",\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"b6ca6aad-589e-4a04-bbeb-0828a3b1145a\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"6166885a-02e0-48e6-abb1-f2930553ac28\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"3e6dcc0f-e0e6-4451-970b-c784c67be637\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"a1c5e92c-f711-4462-a8a3-f37a21f8f9c6\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n },\n {\n \"uuid\": \"20ccffa2-171f-4837-8cda-e6a8fcc533ae\",\n \"postal_code\": null,\n \"category_status\": \"active\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/worksites/show","name":"show","apis":[{"api_url":"/hr_api/v1/worksites/:uuid","http_method":"GET","short_description":"Return details of an existing Worksite","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/worksites/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"worksite\": {\n \"name\": \"Changeworknow HO TEST 12312312312321\",\n \"uuid\": \"2b433c8c-dd88-4060-b2e9-fe3c74acf86b\",\n \"details\": \"\u003cp\u003eOffice details\u003c/p\u003e\",\n \"travel_directions\": \"\u003cp\u003eDirections to the office\u003c/p\u003e\",\n \"parking_instructions\": \"\",\n \"environment_name\": \"Office\",\n \"web_url\": null,\n \"worksite_id_string\": \"updated example worksite id string\",\n \"category_status\": \"Inactive\",\n \"flagship\": false,\n \"sort\": null,\n \"title\": \"Head Office\",\n \"postal_address\": {\n \"organization\": \"Changework Now\",\n \"building_number\": \"\",\n \"unit\": \"\",\n \"post_office_box\": \"\",\n \"address_line_1\": \"Girdler House\",\n \"address_line_2\": \"Quebec Road\",\n \"street_name\": \"\",\n \"municipality\": \"Henley-on-Thames\",\n \"region\": \"Oxfordshire\",\n \"postal_code\": \"RG9 1EY\",\n \"country_code\": \"GB\",\n \"physical_location\": {\n \"uuid\": \"8cc720b2-e1e8-4956-9d4e-4e83478d74c4\",\n \"name\": \"ChangeworkNow HO\",\n \"timezone\": \"Europe/London\",\n \"latitude\": 51.5307,\n \"longitude\": -0.898216,\n \"horizontal_accuracy\": null,\n \"vertical_accuracy\": null,\n \"comments\": \"\u003cp\u003eLimited Parking\u003c/p\u003e\",\n \"geocoded_by\": \"pca\",\n \"geocoded_at\": \"2014-02-23T14:21:53.000+00:00\",\n \"geocoder_error\": null,\n \"geocoder\": \"pca\",\n \"business_unit\": null,\n \"job_category_one\": null,\n \"job_category_two\": null,\n \"job_category_three\": null,\n \"vms_category_one\": null,\n \"vms_category_two\": null,\n \"address_hash\": \"d31e2a451fdfd78e072ad803144c1819\"\n }\n }\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/worksites/create","name":"create","apis":[{"api_url":"/hr_api/v1/worksites","http_method":"POST","short_description":"Creates a new Worksite","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"category_status","full_name":"category_status","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003einactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"worksite_id_string","full_name":"worksite_id_string","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_unit_ids","full_name":"business_unit_ids","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /hr_api/v1/worksites\n{\n \"name\": \"Worksite name\",\n \"category_status\": \"active\",\n \"worksite_id_string\": \"worksite_id_string\",\n \"business_unit_ids\": [\n 1\n ]\n}\n201\n{\n \"message\": \"Worksite successfully created\",\n \"worksite\": {\n \"name\": \"example_name\",\n \"uuid\": \"d5fdf46b-f0bb-4a1c-bfae-97811b1745a2\",\n \"details\": null,\n \"travel_directions\": null,\n \"parking_instructions\": null,\n \"environment_name\": null,\n \"web_url\": null,\n \"worksite_id_string\": \"example_worksite_id_string\",\n \"category_status\": \"Active\",\n \"flagship\": null,\n \"sort\": null,\n \"title\": null\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/worksites/update","name":"update","apis":[{"api_url":"/hr_api/v1/worksites/:uuid","http_method":"PATCH","short_description":"Updates an existing Worksite","deprecated":null},{"api_url":"/hr_api/v1/worksites/:uuid","http_method":"PUT","short_description":"Updates an existing Worksite","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"category_status","full_name":"category_status","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003einactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"worksite_id_string","full_name":"worksite_id_string","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_unit_ids","full_name":"business_unit_ids","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PUT /hr_api/v1/worksites/(%3F-mix:.%7B10,50%7D)\n{\n \"name\": \"Worksite name\"\n}\n200\n{\n \"message\": \"Worksite successfully updated\",\n \"worksite\": {\n \"name\": \"Worksite name\",\n \"uuid\": \"135c1c6f-d443-4982-8915-d99002835ac4\",\n \"details\": \"\",\n \"travel_directions\": \"\",\n \"parking_instructions\": null,\n \"environment_name\": \"River Island\",\n \"web_url\": null,\n \"worksite_id_string\": \"worksite_id_string\",\n \"category_status\": \"active\",\n \"flagship\": null,\n \"sort\": null,\n \"title\": null,\n \"organization\": null,\n \"building_number\": \"\",\n \"unit\": \"\",\n \"post_office_box\": null,\n \"address_line_1\": \"11 15, Union Street\",\n \"address_line_2\": \"\",\n \"street_name\": \"\",\n \"municipality\": \"BURY\",\n \"region\": \"Lancashire\",\n \"postal_code\": \"BL9 0NY\",\n \"country_code\": \"GB\",\n \"postal_address\": {\n \"uuid\": \"5f772d9f-e84a-4a01-b0cc-ed42fa735412\",\n \"name\": \"BURY\"\n },\n \"timezone\": \"Europe/London\",\n \"latitude\": 53.6478,\n \"longitude\": -2.3165,\n \"horizontal_accuracy\": null,\n \"vertical_accuracy\": null,\n \"comments\": \"\",\n \"geocoded_by\": \"google\",\n \"geocoded_at\": \"2011-05-25T10:58:37.000+01:00\",\n \"geocoder_error\": null,\n \"geocoder\": \"google\",\n \"business_unit\": null,\n \"job_category_one\": null,\n \"job_category_two\": null,\n \"job_category_three\": null,\n \"vms_category_one\": null,\n \"vms_category_two\": null,\n \"address_hash\": \"150e155414715e748e72ed5b5e579ab0\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/worksites/destroy","name":"destroy","apis":[{"api_url":"/hr_api/v1/worksites/:uuid","http_method":"DELETE","short_description":"Deletes an existing Worksite","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /hr_api/v1/worksites/(%3F-mix:.%7B10,50%7D)\n{}\n200\n{\n \"message\": \"Worksite successfully made inactive\",\n \"worksite\": {\n \"name\": \"BURY\",\n \"uuid\": \"135c1c6f-d443-4982-8915-d99002835ac4\",\n \"details\": \"\",\n \"travel_directions\": \"\",\n \"parking_instructions\": null,\n \"environment_name\": \"River Island\",\n \"web_url\": null,\n \"worksite_id_string\": \"139\",\n \"category_status\": \"inactive\",\n \"flagship\": null,\n \"sort\": null,\n \"title\": null,\n \"organization\": null,\n \"building_number\": \"\",\n \"unit\": \"\",\n \"post_office_box\": null,\n \"address_line_1\": \"11 15, Union Street\",\n \"address_line_2\": \"\",\n \"street_name\": \"\",\n \"municipality\": \"BURY\",\n \"region\": \"Lancashire\",\n \"postal_code\": \"BL9 0NY\",\n \"country_code\": \"GB\",\n \"postal_address\": {\n \"uuid\": \"5f772d9f-e84a-4a01-b0cc-ed42fa735412\",\n \"name\": \"BURY\"\n },\n \"timezone\": \"Europe/London\",\n \"latitude\": 53.6478,\n \"longitude\": -2.3165,\n \"horizontal_accuracy\": null,\n \"vertical_accuracy\": null,\n \"comments\": \"\",\n \"geocoded_by\": \"google\",\n \"geocoded_at\": \"2011-05-25T10:58:37.000+01:00\",\n \"geocoder_error\": null,\n \"geocoder\": \"google\",\n \"business_unit\": null,\n \"job_category_one\": null,\n \"job_category_two\": null,\n \"job_category_three\": null,\n \"vms_category_one\": null,\n \"vms_category_two\": null,\n \"address_hash\": \"150e155414715e748e72ed5b5e579ab0\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"employees":{"doc_url":"/hr_api/v1/1.0/employees","id":"employees","api_url":"","name":"Employees","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/employees/index","name":"index","apis":[{"api_url":"/hr_api/v1/employees","http_method":"GET","short_description":"Returns a list of Employees","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/employees\n200\n{\n \"employees\": [\n {\n \"uuid\": \"737c1dd0-4134-4743-849d-8e38d0e11644\",\n \"employee_id_string\": \"123456\"\n },\n {\n \"uuid\": \"7b517859-c1c9-48cb-a508-325fa8a1b6b5\",\n \"employee_id_string\": \"234234\"\n },\n {\n \"uuid\": \"9d3f1d9a-ed0c-4cf0-80a4-d6b703b58231\",\n \"employee_id_string\": \"56232342\"\n },\n {\n \"uuid\": \"8a161061-ba23-4f1c-99ba-78b1578465ce\",\n \"employee_id_string\": \"345234523\"\n },\n {\n \"uuid\": \"625a97d6-efda-4aba-93a2-25d35ea7ce7b\",\n \"employee_id_string\": \"benpearson_demo\"\n },\n {\n \"uuid\": \"9436eb98-7998-40b8-9ddd-481129a05ebf\",\n \"employee_id_string\": \"Jonny NoDetails\"\n },\n {\n \"uuid\": \"d6084128-82be-4814-98f5-9107faaa3636\",\n \"employee_id_string\": \"id string\"\n },\n {\n \"uuid\": \"d3ec6d11-2f78-4490-ad7d-0b7911814504\",\n \"employee_id_string\": \"id string2\"\n },\n {\n \"uuid\": \"22620604-eaae-4564-b11d-230671930dbe\",\n \"employee_id_string\": \"updated example employee id string\"\n },\n {\n \"uuid\": \"3809606b-0944-457d-8a06-f71a7a0e79da\",\n \"employee_id_string\": \"a\"\n },\n {\n \"uuid\": \"2cd9b201-9f7c-4f3e-8de8-94d9d7ac2804\",\n \"employee_id_string\": \"123\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/employees/show","name":"show","apis":[{"api_url":"/hr_api/v1/employees/:uuid","http_method":"GET","short_description":"Return details of an existing Employee","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/employees/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"employee\": {\n \"employee_id_string\": \"123456\",\n \"former_employee_id_string\": null,\n \"uuid\": \"737c1dd0-4134-4743-849d-8e38d0e11644\",\n \"is_employed\": null,\n \"start_date\": null,\n \"end_date\": null,\n \"employments\": [\n {\n \"uuid\": \"d724cd8d-afb2-403f-bea4-cccab7207f5f\",\n \"hire_date\": \"2016-01-01T00:00:00.000+00:00\",\n \"original_hire_date\": \"2016-01-01T00:00:00.000+00:00\",\n \"adjusted_hire_date\": \"2016-01-01T00:00:00.000+00:00\",\n \"is_on_leave\": false,\n \"is_terminated\": true,\n \"termination_is_voluntary\": true,\n \"termination_reason_comments\": \"TEST\",\n \"termination_date\": \"2016-02-02T00:00:00.000+00:00\",\n \"last_date_worked\": \"2016-02-02T00:00:00.000+00:00\",\n \"last_date_paid\": null,\n \"employee\": {\n \"employee_id_string\": \"123456\",\n \"former_employee_id_string\": null,\n \"uuid\": \"737c1dd0-4134-4743-849d-8e38d0e11644\",\n \"is_employed\": null,\n \"start_date\": null,\n \"end_date\": null\n },\n \"termination_reason\": {\n \"keyword_type\": \"ReasonForLeaving\",\n \"keyword_id\": null,\n \"uuid\": \"5e4405f6-532c-46be-a72a-8b372803525b\",\n \"category_code\": \"reaon_for_leaving\",\n \"comments\": \"\u003cp\u003ecomment for test reason for leaving\u003c/p\u003e\",\n \"sort\": 100,\n \"category_status\": \"active\",\n \"category_description\": \"test reason for leaving keyword\"\n }\n }\n ],\n \"person_info\": {\n \"date_of_birth\": \"1976-01-05T00:00:00.000+00:00\",\n \"date_of_death\": null,\n \"gender_code\": 1,\n \"is_veteran\": null,\n \"is_disabled\": null,\n \"is_tobacco_user\": null,\n \"race\": null,\n \"ethnicity\": null,\n \"primary_language\": null,\n \"religion\": null,\n \"marital_status\": null,\n \"mobility_keyword_id\": null,\n \"mobility_comments\": null,\n \"employee\": {\n \"employee_id_string\": \"123456\",\n \"former_employee_id_string\": null,\n \"uuid\": \"737c1dd0-4134-4743-849d-8e38d0e11644\",\n \"is_employed\": null,\n \"start_date\": null,\n \"end_date\": null\n },\n \"person\": {\n \"uuid\": \"20317796-8abd-4f89-97bb-2b378e7c4ec4\",\n \"status\": \"active\",\n \"formatted_name\": \"Michael Hefferan\",\n \"given_name\": \"Michael\",\n \"family_name\": \"Hefferan\",\n \"form_of_address\": \"Mr\",\n \"middle_name\": null,\n \"preferred_name\": null,\n \"person_info\": {\n \"date_of_birth\": \"1976-01-05T00:00:00.000+00:00\",\n \"date_of_death\": null,\n \"gender_code\": 1,\n \"is_veteran\": null,\n \"is_disabled\": null,\n \"is_tobacco_user\": null,\n \"race\": null,\n \"ethnicity\": null,\n \"primary_language\": null,\n \"religion\": null,\n \"marital_status\": null,\n \"mobility_keyword_id\": null,\n \"mobility_comments\": null,\n \"employee\": {\n \"employee_id_string\": \"123456\",\n \"former_employee_id_string\": null,\n \"uuid\": \"737c1dd0-4134-4743-849d-8e38d0e11644\",\n \"is_employed\": null,\n \"start_date\": null,\n \"end_date\": null\n }\n }\n }\n }\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/employees/create","name":"create","apis":[{"api_url":"/hr_api/v1/employees","http_method":"POST","short_description":"Creates a new Employee","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"employee_id_string","full_name":"employee_id_string","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"given_name","full_name":"given_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"middle_name","full_name":"middle_name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family_name","full_name":"family_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"preferred_name","full_name":"preferred_name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"date_of_birth","full_name":"date_of_birth","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_employed","full_name":"is_employed","description":"\n\u003cp\u003eThe Employee\u0026#39;s current employment status.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"Not employed","1":"Employed"},"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gender_code","full_name":"gender_code","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e2\u003c/code\u003e, \u003ccode\u003e9\u003c/code\u003e.","expected_type":"string","metadata":{"0":"None","1":"Male","2":"Female","9":"None specified"},"show":true,"validations":[]},{"name":"primary_language","full_name":"primary_language","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"marital_status","full_name":"marital_status","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":["Domestic Partner","Divorced","Legally Separated","Married","Separated","Unmarried","Unreported","Widowed"],"show":true,"validations":[]},{"name":"form_of_address","full_name":"form_of_address","description":"\n\u003cp\u003eSalutation.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":["Mr","Mrs","Miss","Dr"],"show":true,"validations":[]},{"name":"former_employee_id_string","full_name":"former_employee_id_string","description":"\n\u003cp\u003eTo link to a previous Employee record when an existing Employee moves to a new role.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"date_of_death","full_name":"date_of_death","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_veteran","full_name":"is_veteran","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"No","1":"Yes"},"show":true,"validations":[]},{"name":"is_disabled","full_name":"is_disabled","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"No","1":"Yes"},"show":true,"validations":[]},{"name":"is_tobacco_user","full_name":"is_tobacco_user","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"No","1":"Yes"},"show":true,"validations":[]},{"name":"race","full_name":"race","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ethnicity","full_name":"ethnicity","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"religion","full_name":"religion","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mobility_comments","full_name":"mobility_comments","description":"\n\u003cp\u003eTo indicate whether the Employee is willing and able to relocate.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eWill default to \u0026#39;active\u0026#39; if not set, and will automatically update based on other conditions unless overridden.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003einactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /hr_api/v1/employees\n{\n \"employee_id_string\": \"123456\",\n \"given_name\": \"John\",\n \"family_name\": \"Smith\",\n \"date_of_birth\": \"1900-01-01\"\n}\n201\n{\n \"message\": \"Employee created successfully\",\n \"employee\": {\n \"employee_id_string\": \"test\",\n \"former_employee_id_string\": null,\n \"uuid\": \"737c1dd0-4134-4743-849d-8e38d0e11644\",\n \"is_employed\": null,\n \"start_date\": null,\n \"end_date\": null,\n \"date_of_birth\": \"1900-01-01T00:00:00.000+00:00\",\n \"date_of_death\": null,\n \"gender_code\": 1,\n \"is_veteran\": null,\n \"is_disabled\": null,\n \"is_tobacco_user\": null,\n \"race\": null,\n \"ethnicity\": null,\n \"primary_language\": null,\n \"religion\": null,\n \"marital_status\": null,\n \"mobility_keyword_id\": null,\n \"mobility_comments\": null,\n \"person_info\": {\n \"uuid\": \"20317796-8abd-4f89-97bb-2b378e7c4ec4\"\n },\n \"status\": \"active\",\n \"formatted_name\": \"John Smith\",\n \"given_name\": \"John\",\n \"family_name\": \"Smith\",\n \"form_of_address\": null,\n \"middle_name\": null,\n \"preferred_name\": null\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/employees/update","name":"update","apis":[{"api_url":"/hr_api/v1/employees/:uuid","http_method":"PATCH","short_description":"Updates an existing Employee","deprecated":null},{"api_url":"/hr_api/v1/employees/:uuid","http_method":"PUT","short_description":"Updates an existing Employee","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"employee_id_string","full_name":"employee_id_string","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"given_name","full_name":"given_name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"middle_name","full_name":"middle_name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"family_name","full_name":"family_name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"preferred_name","full_name":"preferred_name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"date_of_birth","full_name":"date_of_birth","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_employed","full_name":"is_employed","description":"\n\u003cp\u003eThe Employee\u0026#39;s current employment status.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"Not employed","1":"Employed"},"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"gender_code","full_name":"gender_code","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e2\u003c/code\u003e, \u003ccode\u003e9\u003c/code\u003e.","expected_type":"string","metadata":{"0":"None","1":"Male","2":"Female","9":"None specified"},"show":true,"validations":[]},{"name":"primary_language","full_name":"primary_language","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"marital_status","full_name":"marital_status","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":["Domestic Partner","Divorced","Legally Separated","Married","Separated","Unmarried","Unreported","Widowed"],"show":true,"validations":[]},{"name":"form_of_address","full_name":"form_of_address","description":"\n\u003cp\u003eSalutation.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":["Mr","Mrs","Miss","Dr"],"show":true,"validations":[]},{"name":"former_employee_id_string","full_name":"former_employee_id_string","description":"\n\u003cp\u003eTo link to a previous Employee record when an existing Employee moves to a new role.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"date_of_death","full_name":"date_of_death","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"is_veteran","full_name":"is_veteran","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"No","1":"Yes"},"show":true,"validations":[]},{"name":"is_disabled","full_name":"is_disabled","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"No","1":"Yes"},"show":true,"validations":[]},{"name":"is_tobacco_user","full_name":"is_tobacco_user","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"No","1":"Yes"},"show":true,"validations":[]},{"name":"race","full_name":"race","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ethnicity","full_name":"ethnicity","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"religion","full_name":"religion","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mobility_comments","full_name":"mobility_comments","description":"\n\u003cp\u003eTo indicate whether the Employee is willing and able to relocate.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"\n\u003cp\u003eWill default to \u0026#39;active\u0026#39; if not set, and will automatically update based on other conditions unless overridden.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enew\u003c/code\u003e, \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003einactive\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PUT /hr_api/v1/employees/(%3F-mix:.%7B10,50%7D)\n{\n \"employee_id_string\": \"123456\"\n}\n200\n{\n \"message\": \"Employee updated successfully\",\n \"employee\": {\n \"employee_id_string\": \"updated example employee id string\",\n \"former_employee_id_string\": null,\n \"uuid\": \"737c1dd0-4134-4743-849d-8e38d0e11644\",\n \"is_employed\": null,\n \"start_date\": null,\n \"end_date\": null,\n \"date_of_birth\": \"1976-01-05T00:00:00.000+00:00\",\n \"date_of_death\": null,\n \"gender_code\": 1,\n \"is_veteran\": null,\n \"is_disabled\": null,\n \"is_tobacco_user\": null,\n \"race\": null,\n \"ethnicity\": null,\n \"primary_language\": null,\n \"religion\": null,\n \"marital_status\": null,\n \"mobility_keyword_id\": null,\n \"mobility_comments\": null,\n \"person_info\": {\n \"uuid\": \"20317796-8abd-4f89-97bb-2b378e7c4ec4\"\n },\n \"status\": \"active\",\n \"formatted_name\": \"John Smith\",\n \"given_name\": \"John\",\n \"family_name\": \"Smith\",\n \"form_of_address\": \"Mr\",\n \"middle_name\": null,\n \"preferred_name\": null\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/employees/destroy","name":"destroy","apis":[{"api_url":"/hr_api/v1/employees/:uuid","http_method":"DELETE","short_description":"Deletes an existing Employee","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /hr_api/v1/employees/(%3F-mix:.%7B10,50%7D)\n{}\n200\n{\n \"message\": \"Employee cannot be deleted because it is referenced by other data\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"position_requisition_templates":{"doc_url":"/hr_api/v1/1.0/position_requisition_templates","id":"position_requisition_templates","api_url":"","name":"Position requisition templates","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/position_requisition_templates/index","name":"index","apis":[{"api_url":"/hr_api/v1/position_requisition_templates","http_method":"GET","short_description":"Returns a list of active Position Requisition Templates","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/position_requisition_templates\n200\n{\n \"position_requisition_templates\": [\n {\n \"uuid\": \"c7a28a16-6a2a-4254-a577-600382fac3ac\",\n \"name\": \"0.9 Test PReq Template\"\n },\n {\n \"uuid\": \"803e57ca-fe19-4e17-a17c-a372f460c6d0\",\n \"name\": \"API Test\"\n },\n {\n \"uuid\": \"b6a3813c-1061-47ef-8705-451db997ded2\",\n \"name\": \"BootS3 Requisition\"\n },\n {\n \"uuid\": \"12139b87-951a-4400-8b9a-13fcc917702a\",\n \"name\": \"BS3 Requisition\"\n },\n {\n \"uuid\": \"1a608d50-86b2-4bcb-863f-88b95d4a3ba3\",\n \"name\": \"Ladbrokes HO\"\n },\n {\n \"uuid\": \"f9bdc470-2344-4419-aa64-ab59f1b7864f\",\n \"name\": \"Rails 4.0 test\"\n },\n {\n \"uuid\": \"8aa07709-6490-4c54-ba5b-b7b0a4d93a66\",\n \"name\": \"Recruiters and Approvers Only\"\n },\n {\n \"uuid\": \"d905d706-8788-4176-b0a5-5cff5c9d83f5\",\n \"name\": \"test feb 27\"\n },\n {\n \"uuid\": \"1839e241-e7ae-46a2-ab43-01dc29a230c5\",\n \"name\": \"Test Linking\"\n },\n {\n \"uuid\": \"77eb60e3-19e1-4f37-a830-5b8e952f7a2a\",\n \"name\": \"Test Linking 2\"\n },\n {\n \"uuid\": \"0ab9bdd1-f24a-4438-bae7-f94caf102a1f\",\n \"name\": \"Test Linking 3\"\n },\n {\n \"uuid\": \"a06a8f2f-3a38-4537-8111-dd8f5b8e33a2\",\n \"name\": \"Test Linking 4\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/position_requisition_templates/show","name":"show","apis":[{"api_url":"/hr_api/v1/position_requisition_templates/:uuid","http_method":"GET","short_description":"Return details of an existing Position Requisition Template","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/position_requisition_templates/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"position_requisition_template\": {\n \"uuid\": \"1839e241-e7ae-46a2-ab43-01dc29a230c5\",\n \"name\": \"Test Linking\",\n \"requisition_title\": \"Test Linking\",\n \"description\": \"test\",\n \"number_to_fill\": null,\n \"status\": \"active\",\n \"requisition_form_options\": {\n \"require_business_unit\": \"1\",\n \"require_contract_types\": \"0\",\n \"require_job_category_ones\": \"0\",\n \"require_job_category_threes\": \"0\",\n \"require_job_category_twos\": \"0\",\n \"require_organizational_sub_units\": \"1\",\n \"require_organizational_units\": \"1\",\n \"require_vms_job_levels\": \"0\",\n \"restrict_worksites_flag\": \"restrict_worksites_in_template\",\n \"use_business_unit\": \"1\",\n \"use_contract_types\": \"1\",\n \"use_job_category_ones\": \"1\",\n \"use_job_category_threes\": \"1\",\n \"use_job_category_twos\": \"1\",\n \"use_organizational_sub_units\": \"0\",\n \"use_organizational_units\": \"0\",\n \"use_vms_job_levels\": \"1\"\n },\n \"position_title\": null,\n \"auto_fill_type\": null,\n \"restricted_access\": 0,\n \"system_flags\": 0,\n \"configuration_scope\": {\n \"uuid\": \"1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28\",\n \"name\": \"recruitment\",\n \"category_status\": \"active\"\n },\n \"custom_fieldset_template\": {\n \"custom_fieldset_templateable_type\": \"PositionRequisitionTemplate\",\n \"available_field_options\": [\n \"text_1\",\n \"text_6\",\n \"\"\n ],\n \"text_1\": \"\",\n \"text_2\": null,\n \"text_3\": null,\n \"text_4\": null,\n \"text_5\": null,\n \"text_6\": \"\",\n \"text_7\": null,\n \"text_8\": null,\n \"text_9\": null,\n \"text_10\": null,\n \"text_11\": null,\n \"text_12\": null,\n \"text_13\": null,\n \"text_14\": null,\n \"datetime_1\": null,\n \"datetime_2\": null,\n \"text_1_editable\": true,\n \"text_1_required\": false,\n \"text_2_editable\": null,\n \"text_2_required\": null,\n \"text_3_editable\": null,\n \"text_3_required\": null,\n \"text_4_editable\": null,\n \"text_4_required\": null,\n \"text_5_editable\": null,\n \"text_5_required\": null,\n \"text_6_editable\": true,\n \"text_6_required\": true,\n \"text_7_editable\": null,\n \"text_7_required\": null,\n \"text_8_editable\": null,\n \"text_8_required\": null,\n \"text_9_editable\": null,\n \"text_9_required\": null,\n \"text_10_editable\": null,\n \"text_10_required\": null,\n \"text_11_editable\": null,\n \"text_11_required\": null,\n \"text_12_editable\": null,\n \"text_12_required\": null,\n \"text_13_editable\": null,\n \"text_13_required\": null,\n \"text_14_editable\": null,\n \"text_14_required\": null,\n \"datetime_1_required\": null,\n \"datetime_2_required\": null,\n \"keyword_1_required\": null,\n \"keyword_2_required\": null,\n \"text_area_1\": null,\n \"text_area_1_editable\": null,\n \"text_area_1_required\": null,\n \"text_15\": null,\n \"text_16\": null,\n \"text_17\": null,\n \"text_18\": null,\n \"text_19\": null,\n \"text_20\": null,\n \"text_15_editable\": null,\n \"text_15_required\": null,\n \"text_16_editable\": null,\n \"text_16_required\": null,\n \"text_17_editable\": null,\n \"text_17_required\": null,\n \"text_18_editable\": null,\n \"text_18_required\": null,\n \"text_19_editable\": null,\n \"text_19_required\": null,\n \"text_20_editable\": null,\n \"text_20_required\": null,\n \"keyword_3_required\": null,\n \"keyword_4_required\": null,\n \"keyword_5_required\": null,\n \"keyword_ones\": [],\n \"keyword_twos\": [],\n \"keyword_threes\": [],\n \"keyword_fours\": [],\n \"keyword_fives\": []\n }\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"position_requisitions":{"doc_url":"/hr_api/v1/1.0/position_requisitions","id":"position_requisitions","api_url":"","name":"Position requisitions","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/position_requisitions/index","name":"index","apis":[{"api_url":"/hr_api/v1/position_requisitions","http_method":"GET","short_description":"Returns a list of open Position Requisitions","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eall\u003c/code\u003e, \u003ccode\u003eapproved\u003c/code\u003e, \u003ccode\u003eopen\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/position_requisitions\n200\n{\n \"position_requisitions\": [\n {\n \"uuid\": \"314fc28f-f823-44e8-afe8-d372e4a55377\",\n \"requisition_reference\": \"REF-G-GG7O30N\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"1d7bc8d2-25ab-4218-aa72-b20301fdfbbc\",\n \"requisition_reference\": \"REF-E-MXLHR0D\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"9d7d67d4-63da-4220-bf9d-4e5f5733b0c9\",\n \"requisition_reference\": \"REF-G-M9G8T09\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"5770ffcd-55f8-4fb8-affb-e0e3035b3772\",\n \"requisition_reference\": \"REF-D-N4TS2WP\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"d427bb57-e11d-40e9-9b2b-9d504002d8a9\",\n \"requisition_reference\": \"REF-J-CHXGIKT\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"e6d59ae7-a85e-48ea-b125-48056eb3f9b7\",\n \"requisition_reference\": \"REF-J-D17H3WZ\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"8bb50732-74f5-42cb-b20c-52682c169937\",\n \"requisition_reference\": \"REF-J-DNAZ2P5\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"58db8e73-3703-489a-a03b-6b860294adb5\",\n \"requisition_reference\": \"REF-G-FF35Projects Associate AAQ\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"053da9eb-3be9-41f5-8bd7-791cbdeb1a69\",\n \"requisition_reference\": \"REF-G-QYVWUEX\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"186c26b3-3ff3-43f6-9f30-dcaf978ede63\",\n \"requisition_reference\": \"REF-J-ODJTIJE\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"4d68cbc1-0bf3-423e-9bc6-ad6f6e11651d\",\n \"requisition_reference\": \"REF-G-I7CHVQJ\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"fb363151-0b65-47ec-a650-4891f386a320\",\n \"requisition_reference\": \"REF-G-LS0FEP5\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"cb6c1cf9-afb9-4ec6-a1af-cd500a922d55\",\n \"requisition_reference\": \"REF-G-G5ZZSY8\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"0b9f0952-f0b7-4a22-b29c-810c319d83a4\",\n \"requisition_reference\": \"REF-1W-LAS46EA\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"59238feb-21e0-4106-ba84-4b508357f784\",\n \"requisition_reference\": \"REF-1W-OH93UTG\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"4d18b1b7-ed03-4ae1-9c81-68e5bb0b6500\",\n \"requisition_reference\": \"REF-1W-OIKG3X9\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"a83b7398-f504-4801-80f7-fcad0d8f83ef\",\n \"requisition_reference\": \"REF-1W-OJQYH6R\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"7c69f88f-855f-415a-a7f7-a3060e23434e\",\n \"requisition_reference\": \"REF-1W-OKJQ09S\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"1d38e12e-a556-42fa-8bed-32a9e3f82d98\",\n \"requisition_reference\": \"REF-1W-OLF3KCV\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"3dfbb4f8-9602-4bb5-bfff-c98399d8b5e4\",\n \"requisition_reference\": \"REF-1W-OMCO0Y7\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"59af4075-9fbc-499f-b544-a0e28fb329ec\",\n \"requisition_reference\": \"REF-1W-ONGIKSQ\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"b00c4b63-0b46-401c-8fee-c2c333fa0d30\",\n \"requisition_reference\": \"REF-1W-LF9A83P\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"6936850c-507a-4bf1-a1da-6da2bdb9e1b9\",\n \"requisition_reference\": \"SELECTHR-VACANCY-134\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"a0e6d274-3bfc-44bd-a778-9cf421cfa097\",\n \"requisition_reference\": \"SELECTHR-VACANCY-136\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"98562f53-e6d2-4457-bd3c-1df12bf3c624\",\n \"requisition_reference\": \"SELECTHR-VACANCY-137\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"2869ab5a-abfc-4b75-bfec-15f865a301c0\",\n \"requisition_reference\": \"SELECTHR-VACANCY-138\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"bd7ba348-3346-42b5-8aab-b353d683fdd5\",\n \"requisition_reference\": \"SELECTHR-VACANCY-139\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"829526fb-3b4f-4a1a-ac6a-2d84127e2810\",\n \"requisition_reference\": \"SELECTHR-VACANCY-140\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"ed3f5e59-a3cf-4334-96a6-cb9da96e8e5b\",\n \"requisition_reference\": \"SELECTHR-VACANCY-142\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"23c03135-4b10-4604-b93f-27e7cc750100\",\n \"requisition_reference\": \"SELECTHR-VACANCY-143\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"dab1143a-df4d-4f3a-b6a7-0b61317b2441\",\n \"requisition_reference\": \"SELECTHR-VACANCY-149\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"df79c5d6-3b3e-4cbc-8778-1297503d055b\",\n \"requisition_reference\": \"SELECTHR-VACANCY-151\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"ae6bbb57-01fc-48f7-95be-157834662924\",\n \"requisition_reference\": \"SELECTHR-VACANCY-152\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"bf60242c-dca4-47ee-9265-50b21c3c9056\",\n \"requisition_reference\": \"SELECTHR-VACANCY-153\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"0505ea03-1c2a-4981-aa2f-88d4ef0c2dd4\",\n \"requisition_reference\": \"SELECTHR-VACANCY-154\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"cbc1a7da-ff4d-48e1-ae3f-e2b103593d79\",\n \"requisition_reference\": \"SELECTHR-VACANCY-155\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"80756b9b-3205-4e60-b605-d987f6f027c8\",\n \"requisition_reference\": \"SELECTHR-VACANCY-157\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"95cbc740-4d5a-4503-928d-1d9f33337888\",\n \"requisition_reference\": \"SELECTHR-VACANCY-158\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"62e2d0e9-4a93-4cba-b3cb-fc8c0bde7759\",\n \"requisition_reference\": \"SELECTHR-VACANCY-159\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"f64b2921-4123-4011-88d5-db45af709510\",\n \"requisition_reference\": \"SELECTHR-VACANCY-160\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"2b0221f7-54d8-4bd3-8b81-cab5936c3177\",\n \"requisition_reference\": \"SELECTHR-VACANCY-161\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"9888fdf0-5f35-480b-99ae-268266279b61\",\n \"requisition_reference\": \"SELECTHR-VACANCY-162\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"d7ba88b0-e165-438f-8e47-aef90ceff0bd\",\n \"requisition_reference\": \"SELECTHR-VACANCY-181\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"5d2db3f1-4ad5-4e35-b84c-1d6eb7696cff\",\n \"requisition_reference\": \"SELECTHR-VACANCY-182\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"d7ea265b-b9db-4679-8e85-bcc6914a1035\",\n \"requisition_reference\": \"SELECTHR-VACANCY-184\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"1dd4e6f8-9360-44af-81f7-79f2188fffc0\",\n \"requisition_reference\": \"SELECTHR-VACANCY-185\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"35c34840-09f9-4e4f-bfe4-04458f6200b4\",\n \"requisition_reference\": \"SELECTHR-VACANCY-133\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"47412ce9-1794-46f1-a0a3-e0c0adc34017\",\n \"requisition_reference\": \"SELECTHR-8507599C-AEE0-4BC1-AF4C-BB1ED8EDEA5F\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"151f543a-c159-484c-bda8-b500a49df392\",\n \"requisition_reference\": \"SELECTHR-59D423B6-3998-4843-BDEF-C1CFF1FA4428\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"c4f8d1c7-46ae-4615-a8bf-918016c923f1\",\n \"requisition_reference\": \"SELECTHR-0ED0C5B5-D87A-4934-8ADF-D48EFBD74B5C\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"5110895f-bf6a-4f55-93d2-671c25f64af6\",\n \"requisition_reference\": \"SELECTHR-VACANCY-135\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"181ec9b6-8bfe-4de2-bc5a-876037862961\",\n \"requisition_reference\": \"SELECTHR-336D94FD-912E-475F-80F5-7A58F6CFC161\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"d0073189-801d-4e31-a900-cd021f479292\",\n \"requisition_reference\": \"SELECTHR-21CEB825-AB4C-4374-ADF5-00773210D938\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"056719f7-05f9-410a-84d3-18454e1994b5\",\n \"requisition_reference\": \"SELECTHR-EFA7F851-4A01-49CE-8E08-66A8D8D183C7\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"756a60ae-5acf-48fb-b9c6-1ca975a31616\",\n \"requisition_reference\": \"SELECTHR-VACANCY-201\",\n \"status\": \"open\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/position_requisitions/show","name":"show","apis":[{"api_url":"/hr_api/v1/position_requisitions/:uuid","http_method":"GET","short_description":"Return details of an existing Position Requisition","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/position_requisitions/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"position_requisition\": {\n \"uuid\": \"7ea48f86-0c1a-43e2-875e-6666ffb1587b\",\n \"requisition_reference\": \"REF-M-OXMP9Q8\",\n \"description\": \"\",\n \"status\": \"open\",\n \"number_to_fill\": 2,\n \"valid_from\": \"2012-03-01T00:00:00.000+00:00\",\n \"valid_to\": null,\n \"approval_status\": null,\n \"submitted_for_approval_at\": null,\n \"approval_completed_at\": null,\n \"position_title\": null,\n \"job_purpose\": null,\n \"responsibilities\": null,\n \"experience\": null,\n \"budgeted\": null,\n \"business_case\": null,\n \"start_date\": null,\n \"end_date\": null,\n \"replacement_for\": null,\n \"opening_owner_type\": null,\n \"auto_fill\": null,\n \"position_location\": null,\n \"position_requisition_template\": {\n \"uuid\": \"77eb60e3-19e1-4f37-a830-5b8e952f7a2a\",\n \"name\": \"Test Linking 2\",\n \"requisition_title\": \"Test Linking 2\",\n \"description\": \"\",\n \"number_to_fill\": null,\n \"status\": \"active\",\n \"requisition_form_options\": {\n \"position_title\": \"Test Linking 2 Position\",\n \"position_title_editable\": \"0\",\n \"require_business_unit\": \"0\",\n \"restrict_worksites_flag\": \"\",\n \"use_budgeted\": \"0\",\n \"use_business_case\": \"0\",\n \"use_business_unit\": \"1\",\n \"use_business_units\": \"0\",\n \"use_contract_types\": \"0\",\n \"use_end_date\": \"0\",\n \"use_experience\": \"0\",\n \"use_hours_of_work\": \"0\",\n \"use_job_category_ones\": \"0\",\n \"use_job_category_threes\": \"0\",\n \"use_job_category_twos\": \"0\",\n \"use_job_grades\": \"0\",\n \"use_job_purpose\": \"0\",\n \"use_min_max_salary\": \"0\",\n \"use_organizational_sub_units\": \"0\",\n \"use_organizational_units\": \"0\",\n \"use_other_interval\": \"0\",\n \"use_replacement_for\": \"0\",\n \"use_responsibilities\": \"0\",\n \"use_salary_currency\": \"0\",\n \"use_salary_text\": \"0\",\n \"use_shift_name\": \"0\",\n \"use_start_date\": \"0\",\n \"use_vms_job_levels\": \"0\",\n \"opening_owner_type\": \"all\",\n \"use_hiring_manager\": \"0\",\n \"use_shift_title\": \"0\",\n \"use_pay_type_hours\": \"0\",\n \"auto_fill_type\": \"\",\n \"use_shift_keywords\": \"0\",\n \"use_remuneration_package_keywords\": \"0\",\n \"use_worksites\": \"0\"\n },\n \"position_title\": \"dsafs\",\n \"auto_fill_type\": \"\",\n \"restricted_access\": 0,\n \"system_flags\": 0,\n \"configuration_scope\": {\n \"uuid\": \"1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28\",\n \"name\": \"recruitment\",\n \"category_status\": \"active\"\n },\n \"custom_fieldset_template\": {\n \"custom_fieldset_templateable_type\": \"PositionRequisitionTemplate\",\n \"available_field_options\": [\n \"keyword_2\"\n ],\n \"text_1\": null,\n \"text_2\": null,\n \"text_3\": null,\n \"text_4\": null,\n \"text_5\": null,\n \"text_6\": null,\n \"text_7\": null,\n \"text_8\": null,\n \"text_9\": null,\n \"text_10\": null,\n \"text_11\": null,\n \"text_12\": null,\n \"text_13\": null,\n \"text_14\": null,\n \"datetime_1\": null,\n \"datetime_2\": null,\n \"text_1_editable\": null,\n \"text_1_required\": null,\n \"text_2_editable\": null,\n \"text_2_required\": null,\n \"text_3_editable\": null,\n \"text_3_required\": null,\n \"text_4_editable\": null,\n \"text_4_required\": null,\n \"text_5_editable\": null,\n \"text_5_required\": null,\n \"text_6_editable\": null,\n \"text_6_required\": null,\n \"text_7_editable\": null,\n \"text_7_required\": null,\n \"text_8_editable\": null,\n \"text_8_required\": null,\n \"text_9_editable\": null,\n \"text_9_required\": null,\n \"text_10_editable\": null,\n \"text_10_required\": null,\n \"text_11_editable\": null,\n \"text_11_required\": null,\n \"text_12_editable\": null,\n \"text_12_required\": null,\n \"text_13_editable\": null,\n \"text_13_required\": null,\n \"text_14_editable\": null,\n \"text_14_required\": null,\n \"datetime_1_required\": null,\n \"datetime_2_required\": null,\n \"keyword_1_required\": null,\n \"keyword_2_required\": false,\n \"text_area_1\": null,\n \"text_area_1_editable\": null,\n \"text_area_1_required\": null,\n \"text_15\": null,\n \"text_16\": null,\n \"text_17\": null,\n \"text_18\": null,\n \"text_19\": null,\n \"text_20\": null,\n \"text_15_editable\": null,\n \"text_15_required\": null,\n \"text_16_editable\": null,\n \"text_16_required\": null,\n \"text_17_editable\": null,\n \"text_17_required\": null,\n \"text_18_editable\": null,\n \"text_18_required\": null,\n \"text_19_editable\": null,\n \"text_19_required\": null,\n \"text_20_editable\": null,\n \"text_20_required\": null,\n \"keyword_3_required\": null,\n \"keyword_4_required\": null,\n \"keyword_5_required\": null,\n \"keyword_ones\": [],\n \"keyword_twos\": [\n {\n \"keyword_type\": \"PositionRequisitionKeywordTwo\",\n \"keyword_id\": null,\n \"uuid\": \"fda8c0f5-575a-4fd3-b0b0-1b8035ed7fda\",\n \"category_code\": \"0.8 pos req key two\",\n \"comments\": \"0.8 pos req key two\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_description\": \"0.8 pos req key two\"\n },\n {\n \"keyword_type\": \"PositionRequisitionKeywordTwo\",\n \"keyword_id\": null,\n \"uuid\": \"5358a382-d02e-4821-bbba-485370a63de0\",\n \"category_code\": \"no\",\n \"comments\": \"\",\n \"sort\": 20,\n \"category_status\": \"active\",\n \"category_description\": \"No\"\n },\n {\n \"keyword_type\": \"PositionRequisitionKeywordTwo\",\n \"keyword_id\": null,\n \"uuid\": \"fda8c0f5-575a-4fd3-b0b0-1b8035ed7fda\",\n \"category_code\": \"0.8 pos req key two\",\n \"comments\": \"0.8 pos req key two\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_description\": \"0.8 pos req key two\"\n },\n {\n \"keyword_type\": \"PositionRequisitionKeywordTwo\",\n \"keyword_id\": null,\n \"uuid\": \"5358a382-d02e-4821-bbba-485370a63de0\",\n \"category_code\": \"no\",\n \"comments\": \"\",\n \"sort\": 20,\n \"category_status\": \"active\",\n \"category_description\": \"No\"\n },\n {\n \"keyword_type\": \"PositionRequisitionKeywordTwo\",\n \"keyword_id\": null,\n \"uuid\": \"fda8c0f5-575a-4fd3-b0b0-1b8035ed7fda\",\n \"category_code\": \"0.8 pos req key two\",\n \"comments\": \"0.8 pos req key two\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_description\": \"0.8 pos req key two\"\n },\n {\n \"keyword_type\": \"PositionRequisitionKeywordTwo\",\n \"keyword_id\": null,\n \"uuid\": \"5358a382-d02e-4821-bbba-485370a63de0\",\n \"category_code\": \"no\",\n \"comments\": \"\",\n \"sort\": 20,\n \"category_status\": \"active\",\n \"category_description\": \"No\"\n }\n ],\n \"keyword_threes\": [],\n \"keyword_fours\": [],\n \"keyword_fives\": []\n }\n },\n \"configuration_scope\": {\n \"uuid\": \"1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28\",\n \"name\": \"recruitment\",\n \"category_status\": \"active\"\n },\n \"business_unit\": {\n \"uuid\": \"f626cff0-daa6-4727-8a69-56daea620f92\",\n \"category_code\": \"stores\",\n \"comments\": \"\",\n \"sort\": null,\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2012-05-01T10:13:29.000+01:00\",\n \"worksite_selection\": \"organizational_unit\",\n \"category_description\": \"Stores\"\n }\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/position_requisitions/create","name":"create","apis":[{"api_url":"/hr_api/v1/position_requisitions","http_method":"POST","short_description":"Creates a new Position Requisition","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"position_title","full_name":"position_title","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position_reason_uuid","full_name":"position_reason_uuid","description":"\n\u003cp\u003eObtained from a separate Position Reason request.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"valid_from","full_name":"valid_from","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_to_fill","full_name":"number_to_fill","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"requisition_reference","full_name":"requisition_reference","description":"\n\u003cp\u003eExample format: REF-5N-QLBVS7E\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position_requisition_template_uuid","full_name":"position_requisition_template_uuid","description":"\n\u003cp\u003eObtained from a separate Position Requisition Template request.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"configuration_scope_uuid","full_name":"configuration_scope_uuid","description":"\n\u003cp\u003eObtained from a separate Configuration Scope request.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eopen\u003c/code\u003e, \u003ccode\u003eclosed_filled\u003c/code\u003e, \u003ccode\u003eclosed_not_filled\u003c/code\u003e, \u003ccode\u003eclosed_not_approved\u003c/code\u003e, \u003ccode\u003eclosed_cancelled\u003c/code\u003e, \u003ccode\u003eclosed_part_filled\u003c/code\u003e, \u003ccode\u003edraft\u003c/code\u003e, \u003ccode\u003ehold\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"valid_to","full_name":"valid_to","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submitted_for_approval_at","full_name":"submitted_for_approval_at","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approval_completed_at","full_name":"approval_completed_at","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_purpose","full_name":"job_purpose","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"responsibilities","full_name":"responsibilities","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"experience","full_name":"experience","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"budgeted","full_name":"budgeted","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_case","full_name":"business_case","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"replacement_for","full_name":"replacement_for","description":"\n\u003cp\u003eRequires the PositionRequisitionTemplate used to have \u0026#39;use_replacement_for\u0026#39; set to true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_fill","full_name":"auto_fill","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"No","1":"Yes"},"show":true,"validations":[]},{"name":"position_location","full_name":"position_location","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position_requestor","full_name":"position_requestor","description":"\n\u003cp\u003eA string to identify the requestor.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"salary_text","full_name":"salary_text","description":"\n\u003cp\u003eRequires the PositionRequisitionTemplate used to have \u0026#39;use_salary_text\u0026#39; set to true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approval_status","full_name":"approval_status","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eapproved\u003c/code\u003e, \u003ccode\u003enot_approved\u003c/code\u003e, \u003ccode\u003erework\u003c/code\u003e, \u003ccode\u003ecancelled\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_specification_attachment_data","full_name":"job_specification_attachment_data","description":"\n\u003cp\u003eBase64 encoded string. Will be decoded and saved against the PositionRequisition with filename provided in job_specification_attachment_filename.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_specification_attachment_filename","full_name":"job_specification_attachment_filename","description":"\n\u003cp\u003eRequired if job_specification_attachment_data is present. Requires file extension.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_specification_attachment_content_type","full_name":"job_specification_attachment_content_type","description":"\n\u003cp\u003eRequired if job_specification_attachment_data is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"person_specification_attachment_data","full_name":"person_specification_attachment_data","description":"\n\u003cp\u003eBase64 encoded string. Will be decoded and saved against the PositionRequisition. with filename provided in person_specification_attachment_filename.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"person_specification_attachment_filename","full_name":"person_specification_attachment_filename","description":"\n\u003cp\u003eRequired if person_specification_attachment_data is present. Requires file extension.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"person_specification_attachment_content_type","full_name":"person_specification_attachment_content_type","description":"\n\u003cp\u003eRequired if person_specification_attachment_data is present. Requires file extension.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /hr_api/v1/position_requisitions\n{\n \"position_title\": \"CREATED VIA API!\",\n \"position_reason_uuid\": \"7efc3807-4931-498f-9bfd-25a6743cb5e2\",\n \"valid_from\": \"2016-11-17T00:00:00.000+00:00\",\n \"number_to_fill\": 1,\n \"requisition_reference\": \"SELECTHR-VACANCY-647\",\n \"position_requisition_template_uuid\": \"803e57ca-fe19-4e17-a17c-a372f460c6d0\"\n}\n201\n{\n \"message\": \"Position Requisition created successfully\",\n \"position_requisition\": {\n \"uuid\": \"a45b5dad-9870-4cd9-a976-223e629a0c0f\",\n \"requisition_reference\": \"SELECTHR-VACANCY-647\",\n \"description\": \"\",\n \"status\": \"open\",\n \"number_to_fill\": 1,\n \"valid_from\": \"2016-11-17T00:00:00.000+00:00\",\n \"valid_to\": null,\n \"approval_status\": null,\n \"submitted_for_approval_at\": null,\n \"approval_completed_at\": null,\n \"position_title\": \"CREATED VIA API!\",\n \"job_purpose\": null,\n \"responsibilities\": null,\n \"experience\": null,\n \"budgeted\": null,\n \"business_case\": null,\n \"start_date\": \"2016-11-17T00:00:00.000+00:00\",\n \"end_date\": \"2016-12-31T00:00:00.000+00:00\",\n \"replacement_for\": null,\n \"opening_owner_type\": \"all\",\n \"auto_fill\": null,\n \"position_location\": \"AEG Europe Head Office\",\n \"position_requisition_template\": {\n \"uuid\": \"803e57ca-fe19-4e17-a17c-a372f460c6d0\",\n \"number_to_fill\": null,\n \"status\": \"active\",\n \"opening_owner_type\": \"\",\n \"position_title\": \"\"\n },\n \"name\": \"API Test\",\n \"requisition_title\": \"API test\",\n \"use_hiring_manager\": \"0\",\n \"use_start_date\": \"1\",\n \"require_start_date\": \"0\",\n \"use_end_date\": \"1\",\n \"require_end_date\": \"0\",\n \"use_business_case\": \"1\",\n \"require_business_case\": \"0\",\n \"use_replacement_for\": \"1\",\n \"require_replacement_for\": \"0\",\n \"use_budgeted\": \"1\",\n \"require_budgeted\": \"0\",\n \"position_title_editable\": \"1\",\n \"use_position_location\": \"1\",\n \"require_position_location\": \"0\",\n \"use_job_purpose\": \"1\",\n \"require_job_purpose\": \"0\",\n \"use_responsibilities\": \"1\",\n \"require_responsibilities\": \"0\",\n \"use_experience\": \"1\",\n \"require_experience\": \"0\",\n \"use_salary_text\": \"1\",\n \"require_salary_text\": \"0\",\n \"use_min_max_salary\": \"1\",\n \"require_min_max_salary\": \"0\",\n \"use_salary_currency\": \"1\",\n \"require_salary_currency\": \"0\",\n \"use_other_interval\": \"1\",\n \"require_other_interval\": \"0\",\n \"use_shift_title\": \"1\",\n \"require_shift_title\": \"0\",\n \"use_pay_type_hours\": \"1\",\n \"require_pay_type_hours\": \"0\",\n \"use_job_grades\": \"0\",\n \"auto_fill_type\": \"\",\n \"use_business_units\": \"0\",\n \"use_organizational_units\": \"0\",\n \"use_organizational_sub_units\": \"0\",\n \"use_shift_keywords\": \"0\",\n \"use_remuneration_package_keywords\": \"0\",\n \"use_vms_job_levels\": \"0\",\n \"use_contract_types\": \"0\",\n \"use_job_category_ones\": \"0\",\n \"use_job_category_twos\": \"0\",\n \"use_job_category_threes\": \"0\",\n \"use_worksites\": \"0\",\n \"api_only\": \"1\",\n \"restricted_access\": 0,\n \"configuration_scope\": {\n \"uuid\": null,\n \"name\": \"distributed\",\n \"category_status\": \"active\"\n },\n \"category_status\": \"active\",\n \"custom_fieldset_templateable_type\": \"PositionRequisitionTemplate\",\n \"available_field_options\": [],\n \"text_1\": null,\n \"text_2\": null,\n \"text_3\": null,\n \"text_4\": null,\n \"text_5\": null,\n \"text_6\": null,\n \"text_7\": null,\n \"text_8\": null,\n \"text_9\": null,\n \"text_10\": null,\n \"text_11\": null,\n \"text_12\": null,\n \"text_13\": null,\n \"text_14\": null,\n \"datetime_1\": null,\n \"datetime_2\": null,\n \"text_1_editable\": null,\n \"text_1_required\": null,\n \"text_2_editable\": null,\n \"text_2_required\": null,\n \"text_3_editable\": null,\n \"text_3_required\": null,\n \"text_4_editable\": null,\n \"text_4_required\": null,\n \"text_5_editable\": null,\n \"text_5_required\": null,\n \"text_6_editable\": null,\n \"text_6_required\": null,\n \"text_7_editable\": null,\n \"text_7_required\": null,\n \"text_8_editable\": null,\n \"text_8_required\": null,\n \"text_9_editable\": null,\n \"text_9_required\": null,\n \"text_10_editable\": null,\n \"text_10_required\": null,\n \"text_11_editable\": null,\n \"text_11_required\": null,\n \"text_12_editable\": null,\n \"text_12_required\": null,\n \"text_13_editable\": null,\n \"text_13_required\": null,\n \"text_14_editable\": null,\n \"text_14_required\": null,\n \"datetime_1_required\": null,\n \"datetime_2_required\": null,\n \"keyword_1_required\": null,\n \"keyword_2_required\": null,\n \"text_area_1\": null,\n \"text_area_1_editable\": null,\n \"text_area_1_required\": null,\n \"text_15\": null,\n \"text_16\": null,\n \"text_17\": null,\n \"text_18\": null,\n \"text_19\": null,\n \"text_20\": null,\n \"text_15_editable\": null,\n \"text_15_required\": null,\n \"text_16_editable\": null,\n \"text_16_required\": null,\n \"text_17_editable\": null,\n \"text_17_required\": null,\n \"text_18_editable\": null,\n \"text_18_required\": null,\n \"text_19_editable\": null,\n \"text_19_required\": null,\n \"text_20_editable\": null,\n \"text_20_required\": null,\n \"keyword_3_required\": null,\n \"keyword_4_required\": null,\n \"keyword_5_required\": null,\n \"keyword_ones\": [],\n \"keyword_twos\": [],\n \"keyword_threes\": [],\n \"keyword_fours\": [],\n \"keyword_fives\": [],\n \"keyword_type\": \"PositionReason\",\n \"position_reason\": {\n \"uuid\": \"7efc3807-4931-498f-9bfd-25a6743cb5e2\",\n \"category_status\": \"active\"\n },\n \"category_code\": \"perm_new_position\",\n \"comments\": \"\",\n \"sort\": 10,\n \"category_description\": \"Perm - New Position`\",\n \"remuneration_package\": {\n \"uuid\": \"50deee3f-d0a7-46c6-bc89-093ed790b2df\",\n \"name\": null,\n \"comments\": null,\n \"sort\": null,\n \"category_status\": \"active\"\n },\n \"currency_code\": null,\n \"base_interval\": null,\n \"base_pay_amount_min\": null,\n \"base_pay_amount_max\": null,\n \"other_interval\": null,\n \"other_pay_amount_min\": null,\n \"other_pay_amount_max\": null,\n \"other_pay_calculation\": null,\n \"other_pay_comments\": null,\n \"insurance\": null,\n \"insurance_type\": null,\n \"retirement_or_savings_plan\": null,\n \"company_vehicle\": null,\n \"company_vehicle_description\": null,\n \"relocation_assistance\": null,\n \"relocation_assistance_description\": null,\n \"visa_sponsorship\": null,\n \"time_off_allowance\": null,\n \"expatriate_benefits\": null,\n \"other_benefits\": null,\n \"is_keyword\": false,\n \"salary_text\": \"free\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/position_requisitions/update","name":"update","apis":[{"api_url":"/hr_api/v1/position_requisitions/:uuid","http_method":"PATCH","short_description":"Updates an existing Position Requisition","deprecated":null},{"api_url":"/hr_api/v1/position_requisitions/:uuid","http_method":"PUT","short_description":"Updates an existing Position Requisition","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position_title","full_name":"position_title","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position_reason_uuid","full_name":"position_reason_uuid","description":"\n\u003cp\u003eObtained from a separate Position Reason request.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"valid_from","full_name":"valid_from","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"number_to_fill","full_name":"number_to_fill","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"requisition_reference","full_name":"requisition_reference","description":"\n\u003cp\u003eExample format: REF-5N-QLBVS7E\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position_requisition_template_uuid","full_name":"position_requisition_template_uuid","description":"\n\u003cp\u003eObtained from a separate Position Requisition Template request.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"configuration_scope_uuid","full_name":"configuration_scope_uuid","description":"\n\u003cp\u003eObtained from a separate Configuration Scope request.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_date","full_name":"start_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"end_date","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"status","full_name":"status","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eopen\u003c/code\u003e, \u003ccode\u003eclosed_filled\u003c/code\u003e, \u003ccode\u003eclosed_not_filled\u003c/code\u003e, \u003ccode\u003eclosed_not_approved\u003c/code\u003e, \u003ccode\u003eclosed_cancelled\u003c/code\u003e, \u003ccode\u003eclosed_part_filled\u003c/code\u003e, \u003ccode\u003edraft\u003c/code\u003e, \u003ccode\u003ehold\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"valid_to","full_name":"valid_to","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submitted_for_approval_at","full_name":"submitted_for_approval_at","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approval_completed_at","full_name":"approval_completed_at","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Date","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_purpose","full_name":"job_purpose","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"responsibilities","full_name":"responsibilities","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"experience","full_name":"experience","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"budgeted","full_name":"budgeted","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eyes\u003c/code\u003e, \u003ccode\u003eno\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"business_case","full_name":"business_case","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"replacement_for","full_name":"replacement_for","description":"\n\u003cp\u003eRequires the PositionRequisitionTemplate used to have \u0026#39;use_replacement_for\u0026#39; set to true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"auto_fill","full_name":"auto_fill","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e.","expected_type":"string","metadata":{"0":"No","1":"Yes"},"show":true,"validations":[]},{"name":"position_location","full_name":"position_location","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"position_requestor","full_name":"position_requestor","description":"\n\u003cp\u003eA string to identify the requestor.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"salary_text","full_name":"salary_text","description":"\n\u003cp\u003eRequires the PositionRequisitionTemplate used to have \u0026#39;use_salary_text\u0026#39; set to true.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approval_status","full_name":"approval_status","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eapproved\u003c/code\u003e, \u003ccode\u003enot_approved\u003c/code\u003e, \u003ccode\u003erework\u003c/code\u003e, \u003ccode\u003ecancelled\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_specification_attachment_data","full_name":"job_specification_attachment_data","description":"\n\u003cp\u003eBase64 encoded string. Will be decoded and saved against the PositionRequisition with filename provided in job_specification_attachment_filename.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_specification_attachment_filename","full_name":"job_specification_attachment_filename","description":"\n\u003cp\u003eRequired if job_specification_attachment_data is present. Requires file extension.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"job_specification_attachment_content_type","full_name":"job_specification_attachment_content_type","description":"\n\u003cp\u003eRequired if job_specification_attachment_data is present.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"person_specification_attachment_data","full_name":"person_specification_attachment_data","description":"\n\u003cp\u003eBase64 encoded string. Will be decoded and saved against the PositionRequisition. with filename provided in person_specification_attachment_filename.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"person_specification_attachment_filename","full_name":"person_specification_attachment_filename","description":"\n\u003cp\u003eRequired if person_specification_attachment_data is present. Requires file extension.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"person_specification_attachment_content_type","full_name":"person_specification_attachment_content_type","description":"\n\u003cp\u003eRequired if person_specification_attachment_data is present. Requires file extension.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PUT /hr_api/v1/position_requisitions/(%3F-mix:.%7B10,50%7D)\n{\n \"position_title\": \"CREATED VIA API!\"\n}\n200\n{\n \"message\": \"Position Requisition updated successfully\",\n \"position_requisition\": {\n \"uuid\": \"b874ea38-f631-45d0-8ff1-73cabc9eae74\",\n \"requisition_reference\": \"REF-C-I1TA7ON\",\n \"description\": \"\",\n \"status\": \"open\",\n \"number_to_fill\": 10,\n \"valid_from\": \"2012-03-06T00:00:00.000+00:00\",\n \"valid_to\": null,\n \"approval_status\": \"approved\",\n \"submitted_for_approval_at\": \"2012-04-03T15:46:48.000+01:00\",\n \"approval_completed_at\": \"2012-04-03T15:53:52.000+01:00\",\n \"position_title\": \"Example Position Title\",\n \"job_purpose\": \"\u003cp\u003eJob Purpose\u003c/p\u003e\",\n \"responsibilities\": \"\u003cp\u003eResponsibilities\u003c/p\u003e\",\n \"experience\": \"\u003cp\u003eExperience\u003c/p\u003e\",\n \"budgeted\": \"yes\",\n \"business_case\": \"\u003cp\u003eWe need a new person\u003c/p\u003e\\r\\n\u003cp\u003e\u0026nbsp;\u003c/p\u003e\",\n \"start_date\": \"2012-03-08T00:00:00.000+00:00\",\n \"end_date\": \"2013-03-07T00:00:00.000+00:00\",\n \"replacement_for\": \"A former employee\",\n \"opening_owner_type\": \"all\",\n \"auto_fill\": false,\n \"position_location\": null,\n \"position_requisition_template\": {\n \"uuid\": \"1a608d50-86b2-4bcb-863f-88b95d4a3ba3\",\n \"description\": \"Text to see if we can get Ladbrokes HO form looking close.\",\n \"number_to_fill\": null,\n \"status\": \"active\",\n \"opening_owner_type\": \"named_user\",\n \"position_title\": \"\"\n },\n \"name\": \"Ladbrokes HO\",\n \"requisition_title\": \"Ladbrokes Requisition\",\n \"auto_fill_type\": \"always_auto_fill\",\n \"hiring_manager_type\": \"delegation_list\",\n \"position_title_editable\": \"1\",\n \"require_budgeted\": \"1\",\n \"require_business_case\": \"1\",\n \"require_business_unit\": \"1\",\n \"require_business_units\": \"1\",\n \"require_contract_types\": \"1\",\n \"require_end_date\": \"1\",\n \"require_experience\": \"1\",\n \"require_hours_of_work\": \"1\",\n \"require_job_category_ones\": \"1\",\n \"require_job_category_threes\": \"0\",\n \"require_job_category_twos\": \"1\",\n \"require_job_grades\": \"1\",\n \"require_job_purpose\": \"1\",\n \"require_min_max_salary\": \"1\",\n \"require_organizational_sub_units\": \"1\",\n \"require_organizational_units\": \"1\",\n \"require_other_interval\": \"1\",\n \"require_pay_type_hours\": \"1\",\n \"require_replacement_for\": \"1\",\n \"require_responsibilities\": \"1\",\n \"require_salary_currency\": \"1\",\n \"require_salary_text\": \"1\",\n \"require_shift_name\": \"1\",\n \"require_shift_title\": \"1\",\n \"require_start_date\": \"1\",\n \"require_vms_job_levels\": \"1\",\n \"require_worksites\": \"1\",\n \"restrict_worksites_flag\": \"\",\n \"use_budgeted\": \"1\",\n \"use_business_case\": \"1\",\n \"use_business_unit\": \"1\",\n \"use_business_units\": \"1\",\n \"use_contract_types\": \"1\",\n \"use_end_date\": \"1\",\n \"use_experience\": \"1\",\n \"use_hiring_manager\": \"1\",\n \"use_hours_of_work\": \"1\",\n \"use_job_category_ones\": \"1\",\n \"use_job_category_threes\": \"1\",\n \"use_job_category_twos\": \"1\",\n \"use_job_grades\": \"1\",\n \"use_job_purpose\": \"1\",\n \"use_min_max_salary\": \"1\",\n \"use_organizational_sub_units\": \"1\",\n \"use_organizational_units\": \"1\",\n \"use_other_interval\": \"1\",\n \"use_pay_type_hours\": \"1\",\n \"use_replacement_for\": \"1\",\n \"use_responsibilities\": \"1\",\n \"use_salary_currency\": \"1\",\n \"use_salary_text\": \"1\",\n \"use_shift_name\": \"1\",\n \"use_shift_title\": \"1\",\n \"use_start_date\": \"1\",\n \"use_vms_job_levels\": \"1\",\n \"use_worksites\": \"1\",\n \"use_shift_keywords\": \"0\",\n \"use_remuneration_package_keywords\": \"0\",\n \"restricted_access\": 0,\n \"configuration_scope\": {\n \"name\": \"recruitment\",\n \"category_status\": \"active\"\n },\n \"category_status\": \"active\",\n \"custom_fieldset_templateable_type\": \"PositionRequisitionTemplate\",\n \"available_field_options\": [\n \"text_1\",\n \"keyword_1\",\n \"keyword_2\"\n ],\n \"text_1\": \"234 months\",\n \"text_2\": null,\n \"text_3\": null,\n \"text_4\": null,\n \"text_5\": null,\n \"text_6\": null,\n \"text_7\": null,\n \"text_8\": null,\n \"text_9\": null,\n \"text_10\": null,\n \"text_11\": null,\n \"text_12\": null,\n \"text_13\": null,\n \"text_14\": null,\n \"datetime_1\": null,\n \"datetime_2\": null,\n \"text_1_editable\": true,\n \"text_1_required\": true,\n \"text_2_editable\": null,\n \"text_2_required\": null,\n \"text_3_editable\": null,\n \"text_3_required\": null,\n \"text_4_editable\": null,\n \"text_4_required\": null,\n \"text_5_editable\": null,\n \"text_5_required\": null,\n \"text_6_editable\": null,\n \"text_6_required\": null,\n \"text_7_editable\": null,\n \"text_7_required\": null,\n \"text_8_editable\": null,\n \"text_8_required\": null,\n \"text_9_editable\": null,\n \"text_9_required\": null,\n \"text_10_editable\": null,\n \"text_10_required\": null,\n \"text_11_editable\": null,\n \"text_11_required\": null,\n \"text_12_editable\": null,\n \"text_12_required\": null,\n \"text_13_editable\": null,\n \"text_13_required\": null,\n \"text_14_editable\": null,\n \"text_14_required\": null,\n \"datetime_1_required\": null,\n \"datetime_2_required\": null,\n \"keyword_1_required\": true,\n \"keyword_2_required\": true,\n \"text_area_1\": null,\n \"text_area_1_editable\": null,\n \"text_area_1_required\": null,\n \"text_15\": null,\n \"text_16\": null,\n \"text_17\": null,\n \"text_18\": null,\n \"text_19\": null,\n \"text_20\": null,\n \"text_15_editable\": null,\n \"text_15_required\": null,\n \"text_16_editable\": null,\n \"text_16_required\": null,\n \"text_17_editable\": null,\n \"text_17_required\": null,\n \"text_18_editable\": null,\n \"text_18_required\": null,\n \"text_19_editable\": null,\n \"text_19_required\": null,\n \"text_20_editable\": null,\n \"text_20_required\": null,\n \"keyword_3_required\": null,\n \"keyword_4_required\": null,\n \"keyword_5_required\": null,\n \"keyword_ones\": [\n {\n \"keyword_type\": \"PositionRequisitionKeywordOne\",\n \"uuid\": \"0763280b-dc02-483b-8381-86185906d306\",\n \"category_code\": \"0.8 pos req key one\",\n \"comments\": \"0.8 pos req key one\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_description\": \"0.8 pos req key one\"\n }\n ],\n \"keyword_twos\": [\n {\n \"keyword_type\": \"PositionRequisitionKeywordTwo\",\n \"uuid\": \"5e08d5b9-abc2-4271-8171-f7facf9abacd\",\n \"category_code\": \"yes\",\n \"comments\": \"\",\n \"sort\": 10,\n \"category_status\": \"active\",\n \"category_description\": \"Yes\"\n },\n {\n \"keyword_type\": \"PositionRequisitionKeywordTwo\",\n \"uuid\": \"fda8c0f5-575a-4fd3-b0b0-1b8035ed7fda\",\n \"category_code\": \"0.8 pos req key two\",\n \"comments\": \"0.8 pos req key two\",\n \"sort\": null,\n \"category_status\": \"active\",\n \"category_description\": \"0.8 pos req key two\"\n },\n {\n \"keyword_type\": \"PositionRequisitionKeywordTwo\",\n \"uuid\": \"5358a382-d02e-4821-bbba-485370a63de0\",\n \"category_code\": \"no\",\n \"comments\": \"\",\n \"sort\": 20,\n \"category_status\": \"active\",\n \"category_description\": \"No\"\n }\n ],\n \"keyword_threes\": [],\n \"keyword_fours\": [],\n \"keyword_fives\": [],\n \"business_unit\": {\n \"uuid\": \"5b5ff364-4bdb-45c4-be99-5089a22aa67e\",\n \"category_status\": \"active\"\n },\n \"category_code\": \"ladbrokes_ho\",\n \"comments\": \"\",\n \"sort\": null,\n \"vms_transfer_status\": \"complete\",\n \"transferred_to_vms_at\": \"2012-03-05T10:15:38.000+00:00\",\n \"worksite_selection\": \"organizational_sub_unit\",\n \"category_description\": \"Ladbrokes Head Office\",\n \"keyword_type\": \"PositionReason\",\n \"keyword_id\": null,\n \"position_reason\": {\n \"uuid\": \"467ac832-a2d9-4319-bddf-fd27e1a94625\",\n \"category_code\": \"perm_replacement\",\n \"comments\": \"\",\n \"category_status\": \"active\",\n \"category_description\": \"Perm - Replacement\"\n }\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/position_requisitions/destroy","name":"destroy","apis":[{"api_url":"/hr_api/v1/position_requisitions/:uuid","http_method":"DELETE","short_description":"Deletes an existing Position Requisition","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["DELETE /hr_api/v1/position_requisitions/(%3F-mix:.%7B10,50%7D)\n{}\n200\n{\n \"message\": \"PositionRequisition 48bbe474-62bf-459b-8bb4-77d5866a87ff deleted\"\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"position_openings":{"doc_url":"/hr_api/v1/1.0/position_openings","id":"position_openings","api_url":"","name":"Position openings","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/position_openings/index","name":"index","apis":[{"api_url":"/hr_api/v1/position_openings","http_method":"GET","short_description":"Returns a list of open Position Openings","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eclosed_or_filled\u003c/code\u003e, \u003ccode\u003eis_open\u003c/code\u003e, \u003ccode\u003eunfilled\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/position_openings\n200\n{\n \"position_openings\": [\n {\n \"uuid\": \"c334fec5-b133-48b0-ac8e-a9b9dbe67ba9\",\n \"position_reference\": \"ddnp7fStniSkYoQBNB5NUP\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"5a5508fd-b299-44cf-91ec-27ee5e6bb4c5\",\n \"position_reference\": \"bAvqJ9SPLeZ5hSj-5EA7tf\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"e33986c4-2276-4deb-a755-5a953374adaa\",\n \"position_reference\": \"dJoyBeiNzn66DvwPuZDk2Q\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"329b2b2a-07b5-4d85-9562-d7049809e3cb\",\n \"position_reference\": \"aYMYSQb7vnHzvI1WsycEpl\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"5cc4c30f-fa59-432e-ab55-5fa3e653fc4e\",\n \"position_reference\": \"bCXmmp-LLdlQTvx6pMu_Xo\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"18245f4b-9e41-4f3c-9178-939ea33eccec\",\n \"position_reference\": \"ayjf9lNKfppjf4K56JpSZS\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"502e6b92-e680-4b57-8307-e387c40f07ee\",\n \"position_reference\": \"bqlMUs5Oblv4mh44FedWFU\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"80524f84-9f43-45f9-8b9c-13f195ff3b18\",\n \"position_reference\": \"cauK-eN0nf-yUCe_gv_ZSy\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"10b657bd-7e5e-45b1-9c33-f4824ce4727a\",\n \"position_reference\": \"aqTLE9FL5fSzWZ9ijm5hj6\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"acca05cc-b375-4194-8b88-81ce627a7159\",\n \"position_reference\": \"cSYGxmS3vbLiUiGC5IENfz\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"8f952fa6-128f-479a-ae10-428e2890c7a7\",\n \"position_reference\": \"cpLs-MeO9hMQ4qqO4OKmEN\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"d07b4893-846c-4e2e-aea6-e9e2905871f8\",\n \"position_reference\": \"dqE0ItHgXolQ6M6Ekqwhh4\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"f4a4d3e1-e4d6-4772-aa59-ca210dc683f0\",\n \"position_reference\": \"d0PnpH5nzhCQPzYIenXOpW\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"388d8d11-5604-4c1e-b777-3ca14e30e97c\",\n \"position_reference\": \"a4Jy0rvGrmhRD3pkfomoL8\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"f5cc82b5-19da-4abd-9d07-9c0ca5f462a6\",\n \"position_reference\": \"d1Zik1gDPkVz0hNaYL9gkM\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"f049a47c-c0b6-430b-975e-959393c21b17\",\n \"position_reference\": \"dWsAr8Wlzdc5DELzotWHSx\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"6fa6782c-10f6-469f-9455-a9a45a936d07\",\n \"position_reference\": \"bVPNGSepzgN5rvQArAK20h\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"b7f64dcf-679b-42f9-9c35-d840c7a86612\",\n \"position_reference\": \"c39K3pz5Tc-zW12edhQgys\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"8aa469ab-c809-46c2-af08-54de135babd1\",\n \"position_reference\": \"ckPgMRYaLgWQ8ivn4tw6Vr\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"9161deef-8381-45e6-94d1-9bcfc612e3e5\",\n \"position_reference\": \"cryD7VG4ff5PtrM8_geUpL\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"f50ec959-b3a0-4f8e-b80d-50b2f303ca1e\",\n \"position_reference\": \"d1dSLzS6bpJRGnullZa8OE\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"ece028ec-30da-49a5-95ce-67f411328952\",\n \"position_reference\": \"dS4cJSmnPjPzxoz_qrmOLs\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"b996df5b-a144-4347-a259-f5b4352840fc\",\n \"position_reference\": \"c5LT9BOurdr6jz9Bq1ked8\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"bc036e90-3a17-41f6-afa3-a70bc5cb9c1e\",\n \"position_reference\": \"c8a26qoHDb9Q-JPWVfY5WE\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"984accb9-1e58-4b2e-8e2a-04a5eb7fd27a\",\n \"position_reference\": \"cysSY5hLHllO4QbkxRF9j6\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"39d37903-39cc-446f-b16e-93bc3c127015\",\n \"position_reference\": \"a503KdoCXeB7fUK7W8eNav\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"f8536e00-3d9f-475c-af80-de2aac297505\",\n \"position_reference\": \"d4u24apz9hxk-a3IQSkxuf\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"275f2b03-4899-4cd4-af18-8ec025cfc0bf\",\n \"position_reference\": \"aNxYSdsjLm1k8yJSaLZ8c_\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"9895b2c7-873f-41fe-899b-a32333154537\",\n \"position_reference\": \"cyLBlhHZ9b_OMBOYmZfuu3\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"741a5eea-58e3-4c3c-81f3-c636e74dbbd2\",\n \"position_reference\": \"b0gL7QwonmpihZXJBNtBVs\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"19d3c7b3-8be5-4ef1-8cc6-5a55f53b2f30\",\n \"position_reference\": \"az08EZI-vo8yZgwLx1oY8W\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"a4f95e4c-28fb-48d2-9988-7b83fb784748\",\n \"position_reference\": \"cK-v5mkpTi0PMiE4p7EeDi\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"a587abcc-6885-451c-9b3c-1605214ce0e7\",\n \"position_reference\": \"cLH6VmAivfhjS8fGuHtodN\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"031e54d3-f245-4590-90da-add08d5849e5\",\n \"position_reference\": \"adhLtt8KvfKjdARDcnweNL\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"80893c79-8fb2-4305-b694-ad861fdfbc9c\",\n \"position_reference\": \"caItX5J7jdbBAuRyyF37YC\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"63870117-6dd2-41ed-96ec-bf580437ed3f\",\n \"position_reference\": \"bJHWexBDjb7zBSV1Gen-0_\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"932afb0e-5b32-4de8-a699-fad000945dbc\",\n \"position_reference\": \"ctkVSowZjn6kAz-TaaLf28\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"dabdd0c8-879e-4db7-9587-4267d84ed1c3\",\n \"position_reference\": \"dAVDdiH55nT5whqMFytThd\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"8d432050-b89a-403a-9c14-52d7168dde08\",\n \"position_reference\": \"cnqYbqUjPaoPWuuTCwJD4i\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"66bf36a7-a963-41a0-bef6-7440c7c735ea\",\n \"position_reference\": \"bMVZANQwnbOl72DedhXZxQ\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"0c5d127f-1872-4ae7-b117-4e0c75a9ab4d\",\n \"position_reference\": \"amxrj_ghjk57extGX1QATn\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"be0fd314-1c5f-4b11-84fc-bfc6ba21429f\",\n \"position_reference\": \"c-d9muhf9leyt8V8A6iukF\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"4d1cd280-bc52-4ce3-93e0-a97471c71bff\",\n \"position_reference\": \"bnhnkaVfjm45pGQxrXXXV_\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"3b1e9036-dd26-4618-aebc-0ad37c8ff561\",\n \"position_reference\": \"a7hPa23szggk68cTn8J_vH\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"45c072a2-e875-4fd2-8a2c-69fcf697f289\",\n \"position_reference\": \"bfWhkI6hvp0OOSAFZ2L_kj\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"c1926e9a-a8be-4d84-b393-78f70b9cf6b2\",\n \"position_reference\": \"dbKM6AQl5nHlotEpClNpAY\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"50698047-39d9-41dd-b875-491b6a23a024\",\n \"position_reference\": \"bqAybhoDLb3BH1srTQi6aK\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"60279fdd-00cd-46d3-840e-7cfc364bf10b\",\n \"position_reference\": \"bGj5_Dam1g04qoFpW2s_el\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"a47f40ff-6673-4c49-a3d9-1d65866828ce\",\n \"position_reference\": \"cKF0d_zNnmsApzhwwgAcJo\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"5236a40e-f3de-40ea-b5ec-a3c707cfe532\",\n \"position_reference\": \"REF-M-R9J2DWL\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"0ea929b2-3188-404c-81c4-fc2f6f76a02e\",\n \"position_reference\": \" cmGLoJIi5b25pjs3fcYqq_\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"8e25fd4c-a00b-430a-8e4b-aa8724659f50\",\n \"position_reference\": \" cmGLoJIi5b25pjs3fcYqq_\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"11421cae-d72a-4848-b224-c00005dad341\",\n \"position_reference\": \"REF-4D-LDSPJ1P\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"42698021-d0a7-49ce-9d4d-89f2b28c07ad\",\n \"position_reference\": \"REF-C-P5MNFAG\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"d532219e-abba-4684-8ffb-262cb14eef21\",\n \"position_reference\": \"REF-4D-QI8N0EQ\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"0213cb7c-6562-4afe-9d3d-60e8ba13cc3a\",\n \"position_reference\": \"REF-M-KHA2QTS\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"084a3a25-5155-4cb4-9a5a-aeb26f5ff8d6\",\n \"position_reference\": \"REF-C-Q4E77QJ\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"4e97f28f-7bb4-4a2f-9f22-9eb8827bc68a\",\n \"position_reference\": \"REF-M-PR1YBA8\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"ae634ec3-1895-4a18-b1b9-0e6a097bf87e\",\n \"position_reference\": \"REF-M-K61LYY8\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"02a290ce-f882-4f38-a1e1-247aa1e7789d\",\n \"position_reference\": \"REF-M-JKLNPHN\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"03f15def-5cbd-479d-92c2-09ca23781bb9\",\n \"position_reference\": \"REF-4D-OVVC6EY\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"ebf404c1-b8ed-48a0-a6d6-47e1477d8771\",\n \"position_reference\": \"REF-57-UXDVIHN\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"1eac8ac9-f260-4807-b596-696eef616657\",\n \"position_reference\": \"REF-4D-J3WBEU3\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"5e34fc74-99b1-4b8b-9ba6-07cab3003f41\",\n \"position_reference\": \"REF-5A-PDYFMH7\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"0c73b2f3-5169-405c-a5b5-5e06d3b39e59\",\n \"position_reference\": \"REF-5A-I5F24PL\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"fb8b92e0-d344-4465-a8f8-7f8fc1828afe\",\n \"position_reference\": \"REF-4D-J7UMTRK\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"ac54b34a-f43c-4c40-bb16-6773c5feae32\",\n \"position_reference\": \"REF-57-MPI4PDM\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"685b0bf2-526a-438e-9f4b-314264fd3df8\",\n \"position_reference\": \"REF-5A-QX7Y04I\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"43f0a8fa-8b2e-4aee-9d75-bb809d136855\",\n \"position_reference\": \"REF-5A-ID2M0QK\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"9b146eea-5153-4426-8d48-834cb579182a\",\n \"position_reference\": \"REF-4X-SQ85HVZ\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"ff0074db-3296-4bf3-8f5d-8f2f635fc705\",\n \"position_reference\": \"REF-5A-PWPKPP5\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"d15c2a90-03ee-4775-a0c2-cdb7d9da9b13\",\n \"position_reference\": \"REF-5A-OR97NNF\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"6ec509ed-6bdd-471d-a89f-a3ed7ddf0b0e\",\n \"position_reference\": \"REF-7T-PIS5BDH\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"7332b9f2-476a-4d6d-95ce-22e454bfe856\",\n \"position_reference\": \"REF-5A-QCZ8CS9\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"43e416e8-973b-4e96-b8e0-3f968288bf20\",\n \"position_reference\": \"REF-8U-FYE4K9W\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"090b31db-930d-47c5-a4c4-f18b032c133c\",\n \"position_reference\": \"REF-4D-OLSJQ9I\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"425797ba-c727-4d34-998e-66f9a48b5de4\",\n \"position_reference\": \"REF-57-HWSCHNQ\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"a1892405-5ee9-44dc-94dd-a635bd4b1be5\",\n \"position_reference\": \"REF-5A-GGUC1OO\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"dbf413c8-f51a-42b0-87f6-e76dc8b2630c\",\n \"position_reference\": \"REF-5A-H72APAG\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"04318712-6849-4ce0-8138-5561da354bfa\",\n \"position_reference\": \"REF-5A-HHH38V7\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"edaeb800-4a0a-4640-9e22-424492010602\",\n \"position_reference\": \"REF-5A-HTDO43N\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"1df17bf1-83e6-471d-a905-a85835099cf2\",\n \"position_reference\": \"REF-5A-FAY2XZA\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"4d4ee379-0f16-4487-901e-ebb37445f16d\",\n \"position_reference\": \"REF-4D-GVZ1WAI\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"139a7ece-e87d-43cc-819f-16920c8e9625\",\n \"position_reference\": \"REF-M-PW0YIFR\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"bf81bc90-7350-4e1b-89d5-6ea9c27cdec3\",\n \"position_reference\": \"REF-5N-KLBCUFJ\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"658f3f53-c061-4604-8f24-cbcca31e6452\",\n \"position_reference\": \"REF-5N-LII867G\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"f7bcaf78-5dc3-4fa7-91ad-6835d29cc7c1\",\n \"position_reference\": \"REF-M-JA7VMQL\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"a737463d-4065-4f8f-96f4-d1b89084a543\",\n \"position_reference\": \"REF-4X-RD2LQAM\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"80d674d7-1af9-4add-a2d8-7dbc69858a70\",\n \"position_reference\": \"REF-C-PTMLKLV\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"b8898aaf-7c4a-4eb8-ac2f-a0fd73d0d79b\",\n \"position_reference\": \"REF-C-TDIEESG\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"b2edfde6-6d3a-4f47-bddf-45d9b7947e44\",\n \"position_reference\": \"REF-4D-RV9H912\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"0bacf83b-498d-4e4b-929f-3d2b19e58077\",\n \"position_reference\": \"REF-9T-S9FQE9M\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"b3a485da-4c0e-4527-97e0-d84c0dba11d9\",\n \"position_reference\": \"REF-5N-JIID7QA\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"1d3abf99-68fe-4670-a481-90b570c67803\",\n \"position_reference\": \"REF-C-T55AJX1\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"c72d292d-f8f0-483d-bbef-e9c4d0f489f3\",\n \"position_reference\": \"REF-C-JBMB2CN\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"aeb85513-a34b-4e78-8d0e-2ab774869691\",\n \"position_reference\": \"REF-C-N3N4DCS\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"5d4981db-c371-494f-ae82-45b3322e8a33\",\n \"position_reference\": \"REF-5N-OSNGWTL\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"55474f79-824d-43f1-96bb-ae20ef804afd\",\n \"position_reference\": \"REF-4D-N4E4FTP\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"5115d173-160f-4238-b3bf-2927d4b48a7e\",\n \"position_reference\": \"REF-C-RCTGJ86\",\n \"status\": \"open\"\n },\n {\n \"uuid\": \"f32a0a93-e197-415c-8082-f2e7c9e8e1f8\",\n \"position_reference\": \"REF-C-HOG2VG8\",\n \"status\": \"open\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/position_openings/show","name":"show","apis":[{"api_url":"/hr_api/v1/position_openings/:uuid","http_method":"GET","short_description":"Return details of an existing Position Opening","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/position_openings/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"position_opening\": {\n \"uuid\": \"c334fec5-b133-48b0-ac8e-a9b9dbe67ba9\",\n \"position_reference\": \"ddnp7fStniSkYoQBNB5NUP\",\n \"language\": null,\n \"number_to_fill\": 10,\n \"status\": \"open\",\n \"valid_from\": \"2010-03-26T00:00:00.000+00:00\",\n \"valid_to\": null,\n \"vms_transfer_status\": \"complete\",\n \"quota\": 100,\n \"approval_status\": \"approved\",\n \"description\": \"Description in new description field. test\",\n \"applications_owner_type\": \"named_user\",\n \"transferred_to_vms_at\": \"2013-11-11T13:45:52.000+00:00\",\n \"quota_publication_flag\": \"quota_not_reached\",\n \"publication_status\": \"published\",\n \"quota_auto_republish\": true,\n \"ni_flag\": false,\n \"ni_exported\": null,\n \"ni_salary\": null,\n \"ni_location\": null,\n \"ni_advertising_method\": null,\n \"ni_status\": null,\n \"ni_department\": null,\n \"ni_advertisment_type\": null,\n \"ni_apprentice_flag\": null,\n \"auto_fill\": false,\n \"enable_alerts\": false,\n \"position_opening_template\": {\n \"uuid\": \"e7ac39ac-9eb6-49a8-a10e-78694fd27114\",\n \"title\": \"Store Manager - UK\",\n \"language\": null,\n \"number_to_fill\": 1,\n \"quota\": 10,\n \"distribution_types\": [\n \"external\"\n ],\n \"body\": \"\u003cp\u003eUK Store manager vacancy template text.\u003c/p\u003e\",\n \"data\": null,\n \"description\": null,\n \"applications_owner_type\": \"any_named_user\",\n \"status\": \"active\",\n \"quota_auto_republish\": \"\",\n \"default_position_detail_title\": \"\",\n \"default_remuneration_package_title\": null,\n \"position_form_options\": {},\n \"auto_fill_type\": \"never_auto_fill\",\n \"use_remuneration_package_keyword\": false,\n \"use_shift_keyword\": false,\n \"restricted_access\": false,\n \"use_job_category_one\": true,\n \"use_job_category_two\": true,\n \"use_job_category_three\": true,\n \"use_contract_type\": true,\n \"position_openings_owner_type\": \"any_named_user\",\n \"system_flags\": 0,\n \"encoded_body\": \"\u0026lt;p\u0026gt;UK Store manager vacancy template text.\u0026lt;/p\u0026gt;\",\n \"user_group_names\": null,\n \"publication_scope_templates\": [\n {\n \"name\": \"external\",\n \"system_flags\": 0\n }\n ]\n },\n \"configuration_scope\": {\n \"uuid\": \"1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28\",\n \"scope_type\": \"recruitment\",\n \"sort\": 10,\n \"name\": \"recruitment\",\n \"category_status\": \"active\",\n \"title\": \"Recruitment\"\n }\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"position_opening_templates":{"doc_url":"/hr_api/v1/1.0/position_opening_templates","id":"position_opening_templates","api_url":"","name":"Position opening templates","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/position_opening_templates/index","name":"index","apis":[{"api_url":"/hr_api/v1/position_opening_templates","http_method":"GET","short_description":"Returns a list of active Position Opening Templates","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/position_opening_templates\n200\n{\n \"position_opening_templates\": [\n {\n \"uuid\": \"5cc983a8-e54f-4180-8ac4-a6f659abdb02\",\n \"title\": \"0.8.5 test - BootS3\"\n },\n {\n \"uuid\": \"f3208d61-f3c2-4189-8b72-183396c002e1\",\n \"title\": \"0.9 agency template\"\n },\n {\n \"uuid\": \"e35db181-d6c5-4f02-a076-bcb4e3d2ab14\",\n \"title\": \"0.9 Test PO Template\"\n },\n {\n \"uuid\": \"d971cdee-0634-4c09-8a46-f78a47cb020b\",\n \"title\": \"0.9 Testing Custom Template\"\n },\n {\n \"uuid\": \"570f9862-a7f5-404b-be14-41d6d0284b47\",\n \"title\": \"0.9 Testing Direct Sourcing\"\n },\n {\n \"uuid\": \"f6fb1c4a-289d-423a-bdb9-52fa58120c98\",\n \"title\": \"00 Test POT Custom Fieldset\"\n },\n {\n \"uuid\": \"f8003c5c-a0d6-4fdb-9650-a08c42815ae1\",\n \"title\": \"BootS3\"\n },\n {\n \"uuid\": \"ba4ecdd7-072b-40bb-88c1-25c7eb69ac73\",\n \"title\": \"Convenience Assistant Manager\"\n },\n {\n \"uuid\": \"c4842137-9214-4ee4-bfb6-a90d5e2e1e9e\",\n \"title\": \"Convenience Store Manager - Europe\"\n },\n {\n \"uuid\": \"86f998b6-5a33-48a3-aa8a-4cc068ef00e3\",\n \"title\": \"Custom questionnaire position opening template\"\n },\n {\n \"uuid\": \"a0390682-90f8-43a9-89b2-6d85f1d9ef00\",\n \"title\": \"Direct Sourcing Template\"\n },\n {\n \"uuid\": \"3c5591f2-c316-4866-8a1d-b98957ff74d1\",\n \"title\": \"External Store Manager\"\n },\n {\n \"uuid\": \"7374e357-af7e-417b-858e-4b4b226e0a6d\",\n \"title\": \"Grouped mapped fields checks\"\n },\n {\n \"uuid\": \"97d20176-09f8-4b57-a694-daa0b858e3c5\",\n \"title\": \"Internal - External Test\"\n },\n {\n \"uuid\": \"aff5a49d-b0b7-48a8-8695-ed373f803b35\",\n \"title\": \"Job Board Test\"\n },\n {\n \"uuid\": \"02c503c1-a1af-49c3-af07-51e71b21a02c\",\n \"title\": \"Ladbrokes HO Template\"\n },\n {\n \"uuid\": \"2523c3b5-2042-4592-ae97-35b8c15427de\",\n \"title\": \"Library\"\n },\n {\n \"uuid\": \"a7238709-c95d-41ce-a558-78280ca79cfa\",\n \"title\": \"Manager template\"\n },\n {\n \"uuid\": \"86503269-d339-4551-9ff5-986e060fe9a4\",\n \"title\": \"ND - Test - CMS-1291\"\n },\n {\n \"uuid\": \"71a428b7-9b63-4498-a50f-7baa1d8f95b0\",\n \"title\": \"ND-Drapers-Test\"\n },\n {\n \"uuid\": \"916ac221-642c-4920-89eb-ad03660ff7e9\",\n \"title\": \"New Ids Columns test\"\n },\n {\n \"uuid\": \"f4d8e113-a50f-488e-87e4-fc090b692419\",\n \"title\": \"New Position Template with Custom\"\n },\n {\n \"uuid\": \"3633bd53-adf3-4f92-a64a-5f07ff28745d\",\n \"title\": \"New Template linking test\"\n },\n {\n \"uuid\": \"6c504113-5ea8-4129-a5ad-0f1047042006\",\n \"title\": \"New Template test\"\n },\n {\n \"uuid\": \"aa1e6bd5-3872-4c6e-952a-531aeabbc59f\",\n \"title\": \"Onboarding Test\"\n },\n {\n \"uuid\": \"228eb5ae-441d-4f67-b8c3-156d0dc8dda7\",\n \"title\": \"Other Pay Fields Test\"\n },\n {\n \"uuid\": \"3067b86e-0386-49b8-aa9c-e83dc97baf2d\",\n \"title\": \"PCN Agency Test\"\n },\n {\n \"uuid\": \"dae8a631-7072-4e30-9011-3e91e60dcc9d\",\n \"title\": \"PCN Import/Export Test\"\n },\n {\n \"uuid\": \"f5eaad53-8240-4915-afc0-8eee40a826b9\",\n \"title\": \"PCN ownership test\"\n },\n {\n \"uuid\": \"4b60a89b-16b5-4f64-b3f6-de078f33a639\",\n \"title\": \"PCN RP Keyword test\"\n },\n {\n \"uuid\": \"4410309f-4c1b-454a-a583-12b96d387637\",\n \"title\": \"PCN Validation Test\"\n },\n {\n \"uuid\": \"5be0595a-71bd-4528-aae8-853fbe150076\",\n \"title\": \"PCN Worfklow Test\"\n },\n {\n \"uuid\": \"0cb609d4-360e-4ee1-b28a-82d5dcf70c14\",\n \"title\": \"pot_shift_keywords\"\n },\n {\n \"uuid\": \"26878eaa-0d8f-4639-9ea1-fae2952c5436\",\n \"title\": \"Rails 4 Testing\"\n },\n {\n \"uuid\": \"f9151644-9e95-4c5f-aeaa-4412acd56991\",\n \"title\": \"Reliance Custom Fields test\"\n },\n {\n \"uuid\": \"d8021b2d-9f90-4627-a83b-030c3bc5f658\",\n \"title\": \"requisition with custom\"\n },\n {\n \"uuid\": \"0490fcde-1a99-4228-862a-41575119e15a\",\n \"title\": \"requisitions required\"\n },\n {\n \"uuid\": \"1f94bad2-63c5-4451-be1f-6a331e2d10f6\",\n \"title\": \"RI Head Office Shift Test\"\n },\n {\n \"uuid\": \"c33ee98d-31f4-4372-b6d2-783830fae5fe\",\n \"title\": \"RI Sales Advisor\"\n },\n {\n \"uuid\": \"ba86b865-6246-49ca-983d-c61a7946e5b6\",\n \"title\": \"Sales Advisor\"\n },\n {\n \"uuid\": \"e43b5574-96b4-4827-bb2d-76083ceeee36\",\n \"title\": \"SJT Test\"\n },\n {\n \"uuid\": \"e7ac39ac-9eb6-49a8-a10e-78694fd27114\",\n \"title\": \"Store Manager - UK\"\n },\n {\n \"uuid\": \"62750da0-b9d1-4203-8ef5-92a257407a48\",\n \"title\": \"Stores Trainee Manager Int/Ext\"\n },\n {\n \"uuid\": \"92d09fff-5e3d-46c8-87dd-4e33eed6782b\",\n \"title\": \"Test application process save\"\n },\n {\n \"uuid\": \"0de7484b-1c2f-42f9-9872-02a2e2ebf198\",\n \"title\": \"Test application process save 1\"\n },\n {\n \"uuid\": \"2879c8ed-14bd-4429-8de9-cb1c74d21c39\",\n \"title\": \"Test Fixed Double Create\"\n },\n {\n \"uuid\": \"675c67a9-f484-4715-b2af-3145e0aa4113\",\n \"title\": \"Test Publication Scope\"\n },\n {\n \"uuid\": \"6cfce818-4617-4a73-b0a7-c924a2d71c24\",\n \"title\": \"Test Publication Scope 2\"\n },\n {\n \"uuid\": \"a4b28b5c-3dcb-4b91-9ba9-91a073f41d31\",\n \"title\": \"Test Reporting fields\"\n },\n {\n \"uuid\": \"207ab4ed-cc04-4252-91ea-6335fa35def4\",\n \"title\": \"Test single scope template - only employee db admin \u0026 recruiter users.\"\n },\n {\n \"uuid\": \"02cf0b15-01b6-4c49-a0cd-2e609dfa6ac4\",\n \"title\": \"TestExport\"\n },\n {\n \"uuid\": \"060d5c3e-0ed9-4691-a104-6755e504e5fe\",\n \"title\": \"Trainee Manager - Europe/US\"\n },\n {\n \"uuid\": \"f372045f-a8ef-4c85-874e-ad991bcf9f8c\",\n \"title\": \"Use User Worksites - Head Office\"\n },\n {\n \"uuid\": \"f15f01b2-0856-485d-a807-616df0ae8e9e\",\n \"title\": \"Wild card\"\n },\n {\n \"uuid\": \"7e36beaf-7002-49c0-bb30-3426cd522901\",\n \"title\": \"wojciech_po_template\"\n },\n {\n \"uuid\": \"d3c6aeb8-1b27-4111-86b5-be417c6207d8\",\n \"title\": \"zzzPostion\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/position_opening_templates/show","name":"show","apis":[{"api_url":"/hr_api/v1/position_opening_templates/:uuid","http_method":"GET","short_description":"Return details of an existing Position Opening Template","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/position_opening_templates/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"position_opening_template\": {\n \"uuid\": \"c4842137-9214-4ee4-bfb6-a90d5e2e1e9e\",\n \"title\": \"Convenience Store Manager - Europe\",\n \"language\": null,\n \"number_to_fill\": 1,\n \"quota\": 5,\n \"distribution_types\": [\n \"internal\",\n \"external\",\n \"agency\"\n ],\n \"body\": \"\u003cp\u003eText for Convenience Store Manager external.\u003c/p\u003e\\r\\n\u003cp\u003e\u0026nbsp;\u003c/p\u003e\\r\\n\u003cp\u003eAdded some extra text to see if this gets updated.\u003c/p\u003e\",\n \"data\": null,\n \"description\": null,\n \"applications_owner_type\": \"any_named_user\",\n \"status\": \"active\",\n \"quota_auto_republish\": \"never\",\n \"default_position_detail_title\": \"\",\n \"default_remuneration_package_title\": \"\",\n \"position_form_options\": {\n \"choose_specific_worksites_flag\": \"\",\n \"show_min_max_salary\": \"0\",\n \"show_other_pay\": \"0\",\n \"show_position_location\": \"1\",\n \"show_shift\": \"0\",\n \"require_requisition\": \"0\",\n \"use_hiring_manager\": \"0\"\n },\n \"auto_fill_type\": \"always_auto_fill\",\n \"use_remuneration_package_keyword\": false,\n \"use_shift_keyword\": false,\n \"restricted_access\": false,\n \"use_job_category_one\": true,\n \"use_job_category_two\": true,\n \"use_job_category_three\": true,\n \"use_contract_type\": true,\n \"position_openings_owner_type\": \"creator\",\n \"system_flags\": 0,\n \"encoded_body\": \"\u0026lt;p\u0026gt;Text for Convenience Store Manager external.\u0026lt;/p\u0026gt;\\r\\n\u0026lt;p\u0026gt;\u0026amp;nbsp;\u0026lt;/p\u0026gt;\\r\\n\u0026lt;p\u0026gt;Added some extra text to see if this gets updated.\u0026lt;/p\u0026gt;\",\n \"user_group_names\": null,\n \"publication_scope_templates\": [\n {\n \"name\": \"external\",\n \"system_flags\": 0\n },\n {\n \"name\": \"internal\",\n \"system_flags\": 0\n },\n {\n \"name\": \"agency\",\n \"system_flags\": 0\n }\n ],\n \"custom_fieldset_template\": {\n \"custom_fieldset_templateable_type\": \"PositionOpeningTemplate\",\n \"available_field_options\": [\n \"text_1\",\n \"keyword_1\",\n \"keyword_2\"\n ],\n \"text_1\": \"\",\n \"text_2\": null,\n \"text_3\": null,\n \"text_4\": null,\n \"text_5\": null,\n \"text_6\": null,\n \"text_7\": null,\n \"text_8\": null,\n \"text_9\": null,\n \"text_10\": null,\n \"text_11\": null,\n \"text_12\": null,\n \"text_13\": null,\n \"text_14\": null,\n \"datetime_1\": null,\n \"datetime_2\": null,\n \"text_1_editable\": true,\n \"text_1_required\": true,\n \"text_2_editable\": null,\n \"text_2_required\": null,\n \"text_3_editable\": null,\n \"text_3_required\": null,\n \"text_4_editable\": null,\n \"text_4_required\": null,\n \"text_5_editable\": null,\n \"text_5_required\": null,\n \"text_6_editable\": null,\n \"text_6_required\": null,\n \"text_7_editable\": null,\n \"text_7_required\": null,\n \"text_8_editable\": null,\n \"text_8_required\": null,\n \"text_9_editable\": null,\n \"text_9_required\": null,\n \"text_10_editable\": null,\n \"text_10_required\": null,\n \"text_11_editable\": null,\n \"text_11_required\": null,\n \"text_12_editable\": null,\n \"text_12_required\": null,\n \"text_13_editable\": null,\n \"text_13_required\": null,\n \"text_14_editable\": null,\n \"text_14_required\": null,\n \"datetime_1_required\": null,\n \"datetime_2_required\": null,\n \"keyword_1_required\": false,\n \"keyword_2_required\": false,\n \"text_area_1\": null,\n \"text_area_1_editable\": null,\n \"text_area_1_required\": null,\n \"text_15\": null,\n \"text_16\": null,\n \"text_17\": null,\n \"text_18\": null,\n \"text_19\": null,\n \"text_20\": null,\n \"text_15_editable\": null,\n \"text_15_required\": null,\n \"text_16_editable\": null,\n \"text_16_required\": null,\n \"text_17_editable\": null,\n \"text_17_required\": null,\n \"text_18_editable\": null,\n \"text_18_required\": null,\n \"text_19_editable\": null,\n \"text_19_required\": null,\n \"text_20_editable\": null,\n \"text_20_required\": null,\n \"keyword_3_required\": null,\n \"keyword_4_required\": null,\n \"keyword_5_required\": null\n }\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"candidates":{"doc_url":"/hr_api/v1/1.0/candidates","id":"candidates","api_url":"","name":"Candidates","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/candidates/index","name":"index","apis":[{"api_url":"/hr_api/v1/candidates","http_method":"GET","short_description":"Returns a list of successful Candidates","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003ehave_no_profile\u003c/code\u003e, \u003ccode\u003ehave_profile\u003c/code\u003e, \u003ccode\u003einterviewed\u003c/code\u003e, \u003ccode\u003ejob_alerts_off\u003c/code\u003e, \u003ccode\u003ejob_alerts_on\u003c/code\u003e, \u003ccode\u003enever_applied\u003c/code\u003e, \u003ccode\u003eoffered\u003c/code\u003e, \u003ccode\u003epending\u003c/code\u003e, \u003ccode\u003esuccessful\u003c/code\u003e, \u003ccode\u003etalent\u003c/code\u003e, \u003ccode\u003eunsuccessful\u003c/code\u003e, \u003ccode\u003ewith_person_record\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/candidates\n200\n{\n \"candidates\": [\n {\n \"uuid\": \"ae610f7a-ded9-48af-a757-24d6223e3410\",\n \"formatted_name\": \"Peter Testing Nash\"\n },\n {\n \"uuid\": \"a7f1d9dc-c5bb-4a14-ae49-48c746a13d3b\",\n \"formatted_name\": \"Peter Nash\"\n },\n {\n \"uuid\": \"af150c7a-038e-49db-9758-f7c06ef65055\",\n \"formatted_name\": \"Michael2 dfgsdf Hefferan1\"\n },\n {\n \"uuid\": \"2b8c602d-a9ff-4840-8f76-46c6d930895a\",\n \"formatted_name\": \"Game 2 Boy\"\n },\n {\n \"uuid\": \"46b43665-33af-42da-83bc-a54d3212d9c4\",\n \"formatted_name\": \"Peter C Nash\"\n },\n {\n \"uuid\": \"277f575f-24d7-4247-8313-66b66490ed22\",\n \"formatted_name\": \"VMS TEST ACC\"\n },\n {\n \"uuid\": \"3583f915-240c-4881-9dfc-ce912e026e13\",\n \"formatted_name\": \"VMS TEST 08 ACC\"\n },\n {\n \"uuid\": \"049fb16e-207d-46c9-a765-754fdd0020c0\",\n \"formatted_name\": \"Adam Social\"\n },\n {\n \"uuid\": \"0acc2fbe-ac4f-46d3-96bd-8e341e1a37e4\",\n \"formatted_name\": \"VMS TEST IE7\"\n },\n {\n \"uuid\": \"66b95924-c01d-4f59-9701-5ccbc19dfda4\",\n \"formatted_name\": \"sdfgsdf Boot Tester\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/candidates/show","name":"show","apis":[{"api_url":"/hr_api/v1/candidates/:uuid","http_method":"GET","short_description":"Return details of an existing Candidate","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/candidates/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"candidate\": {\n \"uuid\": \"e5267be7-86b6-4ba5-a5a9-fc76fe6b0cfe\",\n \"status\": \"inactive\",\n \"entered_by_type\": \"applicant\",\n \"transferred_to_vms_at\": null,\n \"vms_transfer_status\": null,\n \"control_data\": {\n \"manual_candidate\": {\n \"publication_scope_name\": null,\n \"create_portal_login\": null,\n \"candidate_supplier_id\": null,\n \"supplier_name\": null,\n \"consultant_name\": null,\n \"position_reference\": null\n }\n },\n \"vms_account_status\": \"deleted_by_user\",\n \"person\": {\n \"uuid\": \"3ee87103-d4cf-42e1-9692-671ac6f3971a\",\n \"status\": \"inactive\",\n \"formatted_name\": \"FN1 One\",\n \"given_name\": \"FN1\",\n \"family_name\": \"One\",\n \"form_of_address\": \"\",\n \"middle_name\": \"\",\n \"preferred_name\": null\n },\n \"applications\": [\n {\n \"uuid\": \"07242ed1-c608-4b20-b5ad-b09e7f859877\",\n \"status\": \"pending_archive\"\n },\n {\n \"uuid\": \"1961e39b-3af7-4bd9-a162-ff05d58e6985\",\n \"status\": \"pending_archive\"\n },\n {\n \"uuid\": \"caf6e0ff-02c9-4206-8a2f-b0282f7df954\",\n \"status\": \"pending_archive\"\n },\n {\n \"uuid\": \"d342544f-81d8-46d8-94e6-62a4a32aa18b\",\n \"status\": \"pending_archive\"\n },\n {\n \"uuid\": \"83c1c652-86fd-4851-b3e5-a18ca76ebf97\",\n \"status\": \"pending_archive\"\n },\n {\n \"uuid\": \"47327e00-ea67-478a-a06c-7132f066ef99\",\n \"status\": \"complete\"\n },\n {\n \"uuid\": \"6ee6f405-5110-4b90-98cb-401aa55afd84\",\n \"status\": \"pending_archive\"\n },\n {\n \"uuid\": \"403d613e-084e-4138-a759-6ced55b8868a\",\n \"status\": \"complete\"\n }\n ]\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"organizational_sub_units":{"doc_url":"/hr_api/v1/1.0/organizational_sub_units","id":"organizational_sub_units","api_url":"","name":"Organizational sub units","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/organizational_sub_units/index","name":"index","apis":[{"api_url":"/hr_api/v1/organizational_sub_units","http_method":"GET","short_description":"Returns a list of active Organizational Sub Units","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/organizational_sub_units\n200\n{\n \"organizational_sub_units\": [\n {\n \"uuid\": \"ef2c42dc-e154-4ddc-b3eb-6a3e7253337f\",\n \"organizational_unit_id_string\": \"development\"\n },\n {\n \"uuid\": \"d432bba1-a76b-4254-888f-764df6d062f9\",\n \"organizational_unit_id_string\": \"support\"\n },\n {\n \"uuid\": \"daf7b6f2-1f62-4bae-aeeb-8a6ab8be2c2b\",\n \"organizational_unit_id_string\": \"recruitment\"\n },\n {\n \"uuid\": \"36b0145a-f3a7-4180-9c1c-30976163f314\",\n \"organizational_unit_id_string\": \"accountant\"\n },\n {\n \"uuid\": \"439612f4-909c-43b8-b550-30bf56f4e04a\",\n \"organizational_unit_id_string\": \"megastore\"\n },\n {\n \"uuid\": \"0ce4298e-a34b-4584-8ee0-744968f98f75\",\n \"organizational_unit_id_string\": \"superstore\"\n },\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\"\n },\n {\n \"uuid\": \"c6cf4903-0eed-4fd1-85f9-f3e8f59e38fd\",\n \"organizational_unit_id_string\": \"gas_station\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\"\n },\n {\n \"uuid\": \"05d41325-e08c-4242-aaf3-11a8c940957d\",\n \"organizational_unit_id_string\": \"east_midlands_and_jersey\"\n },\n {\n \"uuid\": \"c9234f37-9043-425f-95ea-f13209cb1e78\",\n \"organizational_unit_id_string\": \"exceptions\"\n },\n {\n \"uuid\": \"75878428-9f37-4fcf-81c1-55911a5e4206\",\n \"organizational_unit_id_string\": \"a\"\n },\n {\n \"uuid\": \"878d618a-7a7d-43e6-8638-a20095a57dbd\",\n \"organizational_unit_id_string\": \"ben_vms_copy_su\"\n },\n {\n \"uuid\": \"d2e5e2b1-de51-4683-9c45-0b87d13a6966\",\n \"organizational_unit_id_string\": \"ben_vms_copy_su_2\"\n },\n {\n \"uuid\": \"483649b1-f623-4253-8f4d-f83e9e092b9a\",\n \"organizational_unit_id_string\": \"department_1\"\n },\n {\n \"uuid\": \"56147845-ed41-40c4-a7fd-012795213b25\",\n \"organizational_unit_id_string\": \"department_2\"\n },\n {\n \"uuid\": \"826720b1-1ec0-43c2-9301-0d8056c4cd62\",\n \"organizational_unit_id_string\": \"department_3\"\n },\n {\n \"uuid\": \"8754af0e-761e-43a5-a4bd-5083879c840e\",\n \"organizational_unit_id_string\": \"0_7_org_sub_unit\"\n },\n {\n \"uuid\": \"683073d3-f463-4e84-af9d-bcc9f0410358\",\n \"organizational_unit_id_string\": \"0_8_test_org_sub_unit\"\n },\n {\n \"uuid\": \"e648f9e7-9b7d-44fa-b63a-e0470ade1e5d\",\n \"organizational_unit_id_string\": \"0_8_5_organisational_sub_unit\"\n },\n {\n \"uuid\": \"379ee99d-953b-4d6a-939f-f28a4e3f4a81\",\n \"organizational_unit_id_string\": \"0_8_5_organisational_sub_unit2\"\n },\n {\n \"uuid\": \"4790e950-d468-4646-a7bb-ce5937f963d1\",\n \"organizational_unit_id_string\": \"0_9_osu\"\n },\n {\n \"uuid\": \"9609adce-6f75-499c-969d-3017131ec6ee\",\n \"organizational_unit_id_string\": \"r4_test_osu\"\n },\n {\n \"uuid\": \"cde4fdff-d4d9-4293-a5f6-60b22fd0cfe5\",\n \"organizational_unit_id_string\": \"boots3\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/organizational_sub_units/show","name":"show","apis":[{"api_url":"/hr_api/v1/organizational_sub_units/:uuid","http_method":"GET","short_description":"Return details of an existing Organizational Sub Unit","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/organizational_sub_units/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"organizational_sub_unit\": {\n \"uuid\": \"ef2c42dc-e154-4ddc-b3eb-6a3e7253337f\",\n \"organizational_unit_id_string\": \"development\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Development\"\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false},"organizational_units":{"doc_url":"/hr_api/v1/1.0/organizational_units","id":"organizational_units","api_url":"","name":"Organizational units","short_description":null,"full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/hr_api/v1/1.0/organizational_units/index","name":"index","apis":[{"api_url":"/hr_api/v1/organizational_units","http_method":"GET","short_description":"Returns a list of active Organizational Units","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"scope","full_name":"scope","description":"\n\u003cp\u003eOptionally override the default scope. Will be ignored if invalid.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eactive\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"page","full_name":"page","description":"\n\u003cp\u003eIndex returns 100 records per request. Defaults to 1.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/organizational_units\n200\n{\n \"organizational_units\": [\n {\n \"uuid\": \"cdeceb58-5f90-4fdb-9a30-1e59aab14d35\",\n \"organizational_unit_id_string\": \"north_east\"\n },\n {\n \"uuid\": \"71631a8e-aaa1-44d4-9cde-14f0e54a6fd4\",\n \"organizational_unit_id_string\": \"london_m25\"\n },\n {\n \"uuid\": \"d92d8d9a-903a-468d-93d0-a494a9660142\",\n \"organizational_unit_id_string\": \"south_east\"\n },\n {\n \"uuid\": \"2918c736-ba82-407b-a821-306e994b7aa2\",\n \"organizational_unit_id_string\": \"south_west\"\n },\n {\n \"uuid\": \"ba634129-c20f-4a92-8207-5815be9edc51\",\n \"organizational_unit_id_string\": \"us_local\"\n },\n {\n \"uuid\": \"fe804072-55d6-4b95-acda-a62d8bd09314\",\n \"organizational_unit_id_string\": \"uk_local\"\n },\n {\n \"uuid\": \"f4486354-7571-4448-b155-92798e4b3020\",\n \"organizational_unit_id_string\": \"scotland\"\n },\n {\n \"uuid\": \"1312f677-a21f-4f92-a46b-69449c1967d7\",\n \"organizational_unit_id_string\": \"wales\"\n },\n {\n \"uuid\": \"c24dd1d0-7d24-4b9b-ac76-3397d65e48e8\",\n \"organizational_unit_id_string\": \"northern_ireland\"\n },\n {\n \"uuid\": \"80384abe-a773-4b00-b742-b9335504c4c9\",\n \"organizational_unit_id_string\": \"eu_local\"\n },\n {\n \"uuid\": \"94469db0-dde7-49d3-8951-b4bc4597ee92\",\n \"organizational_unit_id_string\": \"north_west\"\n },\n {\n \"uuid\": \"d745c58a-7208-4420-8992-59a5e1494463\",\n \"organizational_unit_id_string\": \"head_office\"\n },\n {\n \"uuid\": \"e3fdeb44-2f00-46bb-96cf-6bd6f7d02ec0\",\n \"organizational_unit_id_string\": \"region_11\"\n },\n {\n \"uuid\": \"7559f888-6bf4-441e-ae20-d5d441b503bb\",\n \"organizational_unit_id_string\": \"test_unit\"\n },\n {\n \"uuid\": \"c8549632-a5d9-4028-ab57-c42d282d08d1\",\n \"organizational_unit_id_string\": \"test\"\n },\n {\n \"uuid\": \"f5af87d4-fce5-44d3-b251-e80b2f48a167\",\n \"organizational_unit_id_string\": \"test2\"\n },\n {\n \"uuid\": \"24232ecf-43ec-495d-b2b0-28a694ba57ad\",\n \"organizational_unit_id_string\": \"rest\"\n },\n {\n \"uuid\": \"73ee9d59-ec8d-4e37-9d81-fd77723809e1\",\n \"organizational_unit_id_string\": \"dev_server\"\n },\n {\n \"uuid\": \"65189483-c73e-4f8f-a751-c4c444519fd7\",\n \"organizational_unit_id_string\": \"roi\"\n },\n {\n \"uuid\": \"9e5aebb5-7d96-4a70-a6a1-9914c9e75e6d\",\n \"organizational_unit_id_string\": \"london\"\n },\n {\n \"uuid\": \"a6db65df-f204-4c04-b583-414e0eba57e2\",\n \"organizational_unit_id_string\": \"west_midlands\"\n },\n {\n \"uuid\": \"419fadf1-a5d3-47df-9e64-e37b3ef65402\",\n \"organizational_unit_id_string\": \"yorkshire\"\n },\n {\n \"uuid\": \"a1bdd37f-9b54-4179-b14e-021e212ddfb8\",\n \"organizational_unit_id_string\": \"east_midlands\"\n },\n {\n \"uuid\": \"3b42dadf-b4d7-421e-91b9-6777ad94b1fd\",\n \"organizational_unit_id_string\": \"east_anglia\"\n },\n {\n \"uuid\": \"fd0bc3bb-1948-4406-947b-7e46fc9a7fea\",\n \"organizational_unit_id_string\": \"north\"\n },\n {\n \"uuid\": \"72eb6566-56cb-442d-8f99-39d39e7ca930\",\n \"organizational_unit_id_string\": \"product\"\n },\n {\n \"uuid\": \"68f442cf-6e26-4d30-83fa-299bf2450b02\",\n \"organizational_unit_id_string\": \"a\"\n },\n {\n \"uuid\": \"adfe2841-3c9a-427c-a889-520f55c49e24\",\n \"organizational_unit_id_string\": \"ben_vms_copy2\"\n },\n {\n \"uuid\": \"86887a75-7235-4330-af99-db96c97c9bc3\",\n \"organizational_unit_id_string\": \"ben_vms_copy_2\"\n },\n {\n \"uuid\": \"ff9ca5b6-e008-4f9c-8c4f-fb1326fd94b9\",\n \"organizational_unit_id_string\": \"channels\"\n },\n {\n \"uuid\": \"968407d7-daaf-4a04-be2a-f1b6d4210a92\",\n \"organizational_unit_id_string\": \"hr\"\n },\n {\n \"uuid\": \"191308df-e2d6-4761-92c6-95e28f440b8a\",\n \"organizational_unit_id_string\": \"finance\"\n },\n {\n \"uuid\": \"af972d8e-2fad-4cb0-88c9-4ac2b26cbc9d\",\n \"organizational_unit_id_string\": \"0_8_test_org_unit\"\n },\n {\n \"uuid\": \"316ef75c-f17d-497a-ac53-120bfe548229\",\n \"organizational_unit_id_string\": \"0_8_5_test_organisational_unit\"\n },\n {\n \"uuid\": \"b669485c-ee5f-44e2-bf80-675dfb341ab5\",\n \"organizational_unit_id_string\": \"test_0_8_5\"\n },\n {\n \"uuid\": \"1634216f-9a3b-4a98-a02d-40f1899b2664\",\n \"organizational_unit_id_string\": \"0_9_o_u\"\n },\n {\n \"uuid\": \"eb2fb86f-d453-4cfd-a6cc-3b521c82ab0c\",\n \"organizational_unit_id_string\": \"new_store\"\n },\n {\n \"uuid\": \"2802bef4-1e21-4f84-92d7-f770eab22786\",\n \"organizational_unit_id_string\": \"test4\"\n },\n {\n \"uuid\": \"3b8ac110-6902-4fe8-9af3-715ac948149b\",\n \"organizational_unit_id_string\": \"new5\"\n },\n {\n \"uuid\": \"68fea6d2-7efa-42f0-9c9c-f373e0e5be64\",\n \"organizational_unit_id_string\": \"r4_test_ou\"\n },\n {\n \"uuid\": \"3806002b-9505-48d7-abcb-97536ee2b7fe\",\n \"organizational_unit_id_string\": \"boots3\"\n },\n {\n \"uuid\": \"e525d983-b11e-4b48-9415-52e06aa5ff88\",\n \"organizational_unit_id_string\": \"tes3\"\n }\n ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/hr_api/v1/1.0/organizational_units/show","name":"show","apis":[{"api_url":"/hr_api/v1/organizational_units/:uuid","http_method":"GET","short_description":"Return details of an existing Organizational Unit","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorised","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":422,"description":"Validation Error","metadata":null},{"code":500,"description":"Internal Server Error","metadata":null},{"code":504,"description":"Gateway Timeout","metadata":null}],"params":[{"name":"uuid","full_name":"uuid","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /hr_api/v1/organizational_units/(%3F-mix:.%7B10,50%7D)\n200\n{\n \"organizational_unit\": {\n \"uuid\": \"cdeceb58-5f90-4fdb-9a30-1e59aab14d35\",\n \"organizational_unit_id_string\": \"north_east\",\n \"description\": \"\",\n \"vms_transfer_status\": \"complete\",\n \"category_status\": \"active\",\n \"transferred_to_vms_at\": \"2011-06-29T14:54:14.000+01:00\",\n \"organizational_unit_name\": \"North East\",\n \"organizational_sub_units\": [\n {\n \"uuid\": \"157c21ef-a0ea-46dc-912a-16ec12b9898d\",\n \"organizational_unit_id_string\": \"store\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Store\"\n },\n {\n \"uuid\": \"439612f4-909c-43b8-b550-30bf56f4e04a\",\n \"organizational_unit_id_string\": \"megastore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Megastore\"\n },\n {\n \"uuid\": \"0ce4298e-a34b-4584-8ee0-744968f98f75\",\n \"organizational_unit_id_string\": \"superstore\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Superstore\"\n },\n {\n \"uuid\": \"8be04c0e-66b7-4758-9c3b-16680c82b68e\",\n \"organizational_unit_id_string\": \"central_north\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Central North\"\n },\n {\n \"uuid\": \"8754af0e-761e-43a5-a4bd-5083879c840e\",\n \"organizational_unit_id_string\": \"0_7_org_sub_unit\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_7_org_sub_unit\"\n },\n {\n \"uuid\": \"683073d3-f463-4e84-af9d-bcc9f0410358\",\n \"organizational_unit_id_string\": \"0_8_test_org_sub_unit\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_test_org_sub_unit\"\n },\n {\n \"uuid\": \"e648f9e7-9b7d-44fa-b63a-e0470ade1e5d\",\n \"organizational_unit_id_string\": \"0_8_5_organisational_sub_unit\",\n \"description\": null,\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_5_organisational_sub_unit\"\n },\n {\n \"uuid\": \"379ee99d-953b-4d6a-939f-f28a4e3f4a81\",\n \"organizational_unit_id_string\": \"0_8_5_organisational_sub_unit2\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"0_8_5_organisational_sub_unit2\"\n },\n {\n \"uuid\": \"9609adce-6f75-499c-969d-3017131ec6ee\",\n \"organizational_unit_id_string\": \"r4_test_osu\",\n \"description\": \"Rails 4 Test\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"Rails 4 Test\"\n },\n {\n \"uuid\": \"cde4fdff-d4d9-4293-a5f6-60b22fd0cfe5\",\n \"organizational_unit_id_string\": \"boots3\",\n \"description\": \"\",\n \"category_status\": \"active\",\n \"organizational_unit_name\": \"BootS3\"\n }\n ]\n }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"Username","description":"The customer-specific username","options":{"required":true}},{"name":"Password","description":"The password provided","options":{"required":true}},{"name":"Content-Type","description":"Must be \"application/json\"","options":{"required":true}}],"deprecated":false}}}}