| Property | Required | Details | Location |
|---|---|---|---|
scope |
Optionally override the default scope. Will be ignored if invalid. Must be one of: |
URL | |
page |
Index returns 100 records per request. Defaults to 1. Must be a Integer |
URL |
GET /hr_api/v1/applications
200
{
"applications": [
{
"uuid": "78b9534f-8331-47a7-8ec1-499756604984",
"status": "complete"
},
{
"uuid": "47327e00-ea67-478a-a06c-7132f066ef99",
"status": "complete"
},
{
"uuid": "403d613e-084e-4138-a759-6ced55b8868a",
"status": "complete"
},
{
"uuid": "136a5e2f-2018-4e3c-a43e-22d52fb6b404",
"status": "complete"
},
{
"uuid": "a947afc1-3870-4d3d-9148-33ccc7569b97",
"status": "complete"
},
{
"uuid": "ec79be52-6261-4141-983d-17c0818324e6",
"status": "complete"
},
{
"uuid": "d9e96d09-e831-492c-bd2b-8714fd276af6",
"status": "complete"
},
{
"uuid": "a22cab7f-fb17-4a11-9657-48ed3c59a5a3",
"status": "complete"
},
{
"uuid": "0ef476f6-dfd1-4064-8bc3-afc00488d95c",
"status": "complete"
},
{
"uuid": "31635e95-def3-42f7-9948-94747d30ae64",
"status": "complete"
},
{
"uuid": "555b2278-c152-4e27-b941-45df94cf8166",
"status": "complete"
},
{
"uuid": "6e67f9e4-c6c2-446f-ad49-460db2cd139a",
"status": "complete"
},
{
"uuid": "20a8f760-d260-4053-b0eb-d92d1c1ae042",
"status": "complete"
},
{
"uuid": "37f1e2d0-24c1-41e2-a2b2-ec24a1d3c68b",
"status": "complete"
},
{
"uuid": "66f9c483-a598-48ca-a840-7479dbbb6f8c",
"status": "complete"
},
{
"uuid": "c403e892-00c1-42a9-9984-e8360b4d41f5",
"status": "complete"
},
{
"uuid": "b8a32624-e38f-410d-953e-3f8c60cf4d44",
"status": "complete"
},
{
"uuid": "57569aa6-9a77-4945-82c0-02401cf22720",
"status": "complete"
},
{
"uuid": "3152fdf9-0957-4d4c-a7f8-3f5ee7344f3b",
"status": "complete"
},
{
"uuid": "d1381729-5977-41c9-b70a-bdea8da7fd7f",
"status": "complete"
},
{
"uuid": "bd6d23de-1917-40f6-bbc7-e8d09a22ee69",
"status": "complete"
},
{
"uuid": "a4522580-dbbd-4141-b61c-6700d44df03b",
"status": "complete"
},
{
"uuid": "e00a6255-f30b-4535-9ed1-4966657001b4",
"status": "complete"
},
{
"uuid": "66d136e3-cdcc-406c-8a55-ec741d889930",
"status": "complete"
},
{
"uuid": "a6fa11c6-516f-471b-9f92-b6c3f1026d18",
"status": "complete"
},
{
"uuid": "8f46fb93-2e32-4e6d-9f9a-9e6c40baa96a",
"status": "complete"
},
{
"uuid": "b8ff856a-56f2-46f6-a8d4-e82e73e12208",
"status": "complete"
},
{
"uuid": "ed3d93f4-ab11-4b7d-b958-512934d84d9d",
"status": "complete"
},
{
"uuid": "9c9071d9-ee7e-4365-a318-36e9026bf75a",
"status": "complete"
},
{
"uuid": "eed2d644-09f1-4634-9791-270c685f21bd",
"status": "complete"
},
{
"uuid": "0d7547ee-2c83-4137-aabe-cef37436d33d",
"status": "complete"
},
{
"uuid": "70d92124-8fd5-4fdd-b6d2-4fc958ec8189",
"status": "complete"
},
{
"uuid": "98283f2f-547c-457a-9bbc-17da48a975e8",
"status": "complete"
},
{
"uuid": "e0b26d95-625a-45e5-b4d0-f33dab8d84c2",
"status": "complete"
},
{
"uuid": "ed32e5c7-520d-416a-ae66-e5929c524c6c",
"status": "complete"
},
{
"uuid": "7043fe73-ebbf-4628-9c4b-66b845240d86",
"status": "complete"
},
{
"uuid": "ed046979-7f2f-4f50-86a8-5243f9809002",
"status": "complete"
},
{
"uuid": "a8eb2b35-d0bc-41c3-8f22-0c1804e7af1c",
"status": "complete"
},
{
"uuid": "2d01cd96-b310-41db-b0cc-8dccec3084d4",
"status": "complete"
},
{
"uuid": "4fe3221e-bfde-4bf1-9404-eab89d2cacae",
"status": "complete"
},
{
"uuid": "c370b4ee-fa87-4174-91ba-c9161c4e8736",
"status": "complete"
},
{
"uuid": "cea15299-ae9a-4486-9a68-a841acba71d1",
"status": "complete"
},
{
"uuid": "7f25ea7e-7200-45a5-9279-d139d629d56a",
"status": "complete"
},
{
"uuid": "02cf44cb-297e-441c-bcad-cf880ea982bb",
"status": "complete"
},
{
"uuid": "c34c81eb-3c01-44f7-8d7a-60b45619c836",
"status": "complete"
},
{
"uuid": "6d3e33e6-dadc-46d8-9ce8-80250a2eae5e",
"status": "complete"
},
{
"uuid": "9e8661e9-682d-4034-a1ee-80e6d079ddf9",
"status": "complete"
},
{
"uuid": "a7f1d765-02a5-4616-adeb-0133d72e3292",
"status": "complete"
},
{
"uuid": "6e206d0b-53dd-4914-bad8-ab69e31c309d",
"status": "complete"
},
{
"uuid": "05bf5357-1b14-40a0-b329-cd4daa5502a0",
"status": "complete"
},
{
"uuid": "adc3f786-5024-448a-8c88-ac25ca3d0487",
"status": "complete"
},
{
"uuid": "e42aff0d-1ef0-4bd5-bb16-f9a8507fc812",
"status": "complete"
},
{
"uuid": "020c5349-6d79-4c8e-afa8-e0716581ff60",
"status": "complete"
},
{
"uuid": "d8d4af39-a238-4c18-8d25-70ed6e11dfe2",
"status": "complete"
},
{
"uuid": "3e90f8b6-f67e-4610-bcab-16530d883f71",
"status": "complete"
},
{
"uuid": "e2e82942-5c5f-4422-bd99-c06ba3ad29a4",
"status": "complete"
},
{
"uuid": "5a76cf40-e33b-4c54-b907-878559c6c2da",
"status": "complete"
},
{
"uuid": "4f0143ab-b98b-4c10-a74f-aad16b5c7e43",
"status": "complete"
},
{
"uuid": "f20ffc8a-ea52-4562-b456-78db4908982b",
"status": "complete"
},
{
"uuid": "6c3ac85d-caa1-4ff7-8a3b-8434113bd11e",
"status": "complete"
},
{
"uuid": "cd3c5870-6120-4afe-a4bd-5c170248ba84",
"status": "complete"
},
{
"uuid": "02e11e99-ac9f-4347-80ab-c8a4ecb17135",
"status": "complete"
},
{
"uuid": "2ea84c70-f77a-407c-b346-267a3fb62702",
"status": "complete"
},
{
"uuid": "04df3743-8cd5-4228-af0d-60c4f1203c8e",
"status": "complete"
},
{
"uuid": "74d7701b-67db-4bcb-bd2e-94948f61db00",
"status": "complete"
},
{
"uuid": "0aefe98c-7aa3-47f6-a063-a472fcf0b79e",
"status": "complete"
},
{
"uuid": "64df404c-b495-4884-a5f3-bda402be1c44",
"status": "complete"
},
{
"uuid": "9e42cc1c-813c-4e9d-a8b0-3341ac1f328c",
"status": "complete"
},
{
"uuid": "33ee612d-d3b4-4f78-9a2f-5ceddc5788bb",
"status": "complete"
},
{
"uuid": "5b2a5b47-756f-4669-82d5-cf018aa67c82",
"status": "complete"
},
{
"uuid": "aa8f31db-032c-4598-8a6e-616bc48df3ff",
"status": "complete"
},
{
"uuid": "01e67ded-76d5-4599-9717-14936804500c",
"status": "complete"
},
{
"uuid": "f7a37893-adcc-4b34-8a1b-8bd72355ab84",
"status": "complete"
},
{
"uuid": "da5abc49-59b3-4315-a1be-f25157b0d9ad",
"status": "complete"
},
{
"uuid": "5173d74f-641b-44de-a222-a84765148470",
"status": "complete"
},
{
"uuid": "6c06edc3-624e-48ec-a005-8dd4a88419c9",
"status": "complete"
},
{
"uuid": "6e0330cb-6294-4dc0-a121-75041a5c7f33",
"status": "complete"
},
{
"uuid": "d625a07b-81a0-4e1a-aad1-f0a54fc04533",
"status": "complete"
},
{
"uuid": "821b59f3-85bd-4ab3-aa10-547c5e69ee1c",
"status": "complete"
},
{
"uuid": "4e3fef6c-ec2c-4f89-9902-04b37713d008",
"status": "complete"
},
{
"uuid": "7f393890-24b3-48df-b0da-66d05198a517",
"status": "complete"
},
{
"uuid": "7147a048-47c2-49c9-a544-d49a50b319f8",
"status": "complete"
},
{
"uuid": "a07bc64b-c326-48fc-8914-9187e1b8dd07",
"status": "complete"
},
{
"uuid": "f9e360e4-9670-4f3f-a9cf-2e2bed284f7c",
"status": "complete"
},
{
"uuid": "f9f73810-c327-4bdd-bb24-84387696cb30",
"status": "complete"
},
{
"uuid": "cecc99a9-7425-40e5-8376-d9f9ad0a681c",
"status": "complete"
},
{
"uuid": "011e0319-f459-4c16-acb7-679b3904bacb",
"status": "complete"
},
{
"uuid": "3a22b8fa-7d63-4289-9c4d-23d0900a32e6",
"status": "complete"
},
{
"uuid": "d7fd515e-b322-413e-9319-60621b137b1b",
"status": "complete"
},
{
"uuid": "26cfcaac-e061-431e-b88c-44ff66804dbd",
"status": "complete"
},
{
"uuid": "08e9f9c2-6714-4b28-a8e7-7dbbd31bd9a9",
"status": "complete"
},
{
"uuid": "b30d507c-7769-4e1a-adbd-3b80aa1bb9ea",
"status": "complete"
},
{
"uuid": "a31fa9dc-9c8b-4c54-a641-1948b4306df4",
"status": "complete"
},
{
"uuid": "e21ffcb6-007c-410e-b994-ca7977876fe2",
"status": "complete"
},
{
"uuid": "32199589-6447-4878-9cd9-c2f3b957b155",
"status": "complete"
},
{
"uuid": "8e97e610-5147-40ff-8eac-9911458be7ee",
"status": "complete"
},
{
"uuid": "02dcacc5-3061-42a9-8397-1889feb08158",
"status": "complete"
},
{
"uuid": "4cef7a1b-a014-4d06-af63-9db6edc2ce20",
"status": "complete"
},
{
"uuid": "c742ec61-1ee2-48b1-910a-9cb45e07166d",
"status": "complete"
},
{
"uuid": "3c19baa3-57a6-49be-987a-afe65ec7f442",
"status": "complete"
}
]
}
| Property | Required | Details | Location |
|---|---|---|---|
uuid |
Must be a String |
URL |
GET /hr_api/v1/applications/:uuid
200
{
"application": {
"uuid": "b5c798bc-4023-4ce9-87b9-eb999accda11",
"status": "pending_archive",
"submitted_at": "2010-03-29T21:18:54.000+01:00",
"application_reference": "APP-GFD4-9J",
"successful": false,
"successful_at": null,
"completed_at": "2010-04-21T10:20:46.000+01:00",
"ni_flag": null,
"created_at": "2010-03-29T21:18:55.000+01:00",
"application_process_attachments": [
{
"filename": "DummyCV.doc",
"data": "<base64-encoded data will be returned here>",
"content_type": "application/msword",
"source": "upload",
"size": 9216
}
],
"candidate": {
"uuid": "a7f1d9dc-c5bb-4a14-ae49-48c746a13d3b",
"status": "inactive",
"entered_by_type": "applicant",
"transferred_to_vms_at": null,
"vms_transfer_status": null,
"control_data": {
"manual_candidate": {
"publication_scope_name": null,
"create_portal_login": null,
"candidate_supplier_id": null,
"supplier_name": null,
"consultant_name": null,
"position_reference": null
}
},
"vms_account_status": "deleted-by-user",
"person": {
"uuid": "2bbf7ecf-90f9-4c5a-80ec-67d377d2c457",
"status": "inactive",
"formatted_name": "Peter Nash",
"given_name": "Peter",
"family_name": "Nash",
"form_of_address": "Mr",
"middle_name": null,
"preferred_name": null
}
},
"configuration_scope": {
"uuid": "1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28",
"scope_type": "recruitment",
"sort": 10,
"name": "recruitment",
"category_status": "active",
"title": "Recruitment"
},
"position_profile": {
"uuid": "b91637e6-39a9-4dad-b904-8aacc3a88260",
"language": null,
"profile_id": null,
"profile_name": "PCN SA Reading",
"start_as_soon_as_possible": null,
"start_date": null,
"expected_end_date": null,
"maximum_start_date": null,
"maximum_end_date": null,
"distribution_types": [
"external"
],
"hot_job": true,
"hot_job_from": "2010-03-29T00:00:00.000+01:00",
"hot_job_to": "2010-04-16T00:00:00.000+01:00",
"position_opening": {
"uuid": "5a5508fd-b299-44cf-91ec-27ee5e6bb4c5",
"position_reference": "bAvqJ9SPLeZ5hSj-5EA7tf",
"language": null,
"number_to_fill": 1,
"status": "open",
"valid_from": "2010-03-29T00:00:00.000+01:00",
"valid_to": null,
"vms_transfer_status": "complete",
"quota": 20,
"approval_status": "approved",
"description": "",
"applications_owner_type": "position_opening_owner",
"transferred_to_vms_at": "2010-03-30T14:25:09.000+01:00",
"quota_publication_flag": "quota_not_reached",
"publication_status": "published",
"quota_auto_republish": true,
"ni_flag": null,
"ni_exported": null,
"ni_salary": null,
"ni_location": null,
"ni_advertising_method": null,
"ni_status": null,
"ni_department": null,
"ni_advertisment_type": null,
"ni_apprentice_flag": null,
"auto_fill": null,
"enable_alerts": false,
"position_opening_template": {
"uuid": "ba86b865-6246-49ca-983d-c61a7946e5b6",
"title": "Sales Advisor",
"language": null,
"number_to_fill": null,
"quota": null,
"distribution_types": [
"internal",
"external",
"agency"
],
"body": "<p>Template Text</p>",
"data": null,
"description": null,
"applications_owner_type": "position_opening_owner",
"status": "active",
"quota_auto_republish": "",
"default_position_detail_title": "",
"default_remuneration_package_title": "",
"position_form_options": {
"choose_specific_worksites_flag": "",
"require_requisition": "0",
"show_min_max_salary": "0",
"show_other_pay": "1",
"show_position_location": "0",
"show_shift": "0",
"use_hiring_manager": "0"
},
"auto_fill_type": "never_auto_fill",
"use_remuneration_package_keyword": false,
"use_shift_keyword": false,
"restricted_access": false,
"use_job_category_one": true,
"use_job_category_two": true,
"use_job_category_three": true,
"use_contract_type": true,
"position_openings_owner_type": "any_named_user",
"system_flags": 0,
"encoded_body": "<p>Template Text</p>",
"user_group_names": null,
"publication_scope_templates": [
{
"name": "external",
"system_flags": 0
},
{
"name": "internal",
"system_flags": 0
},
{
"name": "agency",
"system_flags": 0
}
],
"custom_fieldset_template": {
"custom_fieldset_templateable_type": "PositionOpeningTemplate",
"available_field_options": [
"text_1",
"text_2",
"text_3"
],
"text_1": "1111",
"text_2": "2222",
"text_3": "3333",
"text_4": null,
"text_5": null,
"text_6": null,
"text_7": null,
"text_8": null,
"text_9": null,
"text_10": null,
"text_11": null,
"text_12": null,
"text_13": null,
"text_14": null,
"datetime_1": null,
"datetime_2": null,
"text_1_editable": true,
"text_1_required": false,
"text_2_editable": true,
"text_2_required": false,
"text_3_editable": true,
"text_3_required": false,
"text_4_editable": null,
"text_4_required": null,
"text_5_editable": null,
"text_5_required": null,
"text_6_editable": null,
"text_6_required": null,
"text_7_editable": null,
"text_7_required": null,
"text_8_editable": null,
"text_8_required": null,
"text_9_editable": null,
"text_9_required": null,
"text_10_editable": null,
"text_10_required": null,
"text_11_editable": null,
"text_11_required": null,
"text_12_editable": null,
"text_12_required": null,
"text_13_editable": null,
"text_13_required": null,
"text_14_editable": null,
"text_14_required": null,
"datetime_1_required": null,
"datetime_2_required": null,
"keyword_1_required": null,
"keyword_2_required": null,
"text_area_1": null,
"text_area_1_editable": null,
"text_area_1_required": null,
"text_15": null,
"text_16": null,
"text_17": null,
"text_18": null,
"text_19": null,
"text_20": null,
"text_15_editable": null,
"text_15_required": null,
"text_16_editable": null,
"text_16_required": null,
"text_17_editable": null,
"text_17_required": null,
"text_18_editable": null,
"text_18_required": null,
"text_19_editable": null,
"text_19_required": null,
"text_20_editable": null,
"text_20_required": null,
"keyword_3_required": null,
"keyword_4_required": null,
"keyword_5_required": null
}
}
}
}
}
}