GET /hr_api/v1/applications/:uuid

Return details of an existing Application

Params

Property Required Details Location

uuid

Must be a String

URL

Examples

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": "&lt;p&gt;Template Text&lt;/p&gt;",
          "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
          }
        }
      }
    }
  }
}