Datahub Messages

Supported Formats: json

GET | GET /hr_api/v1/datahub/publisher/queues/:queue_uuid/messages

Returns a list of unprocessed Datahub Messages

Params

Property Required Details Location

queue_uuid

Must be a String

URL

count

Results to return per #index request. Defaults to 1. Maximum 10.

Must be a Integer

URL

Examples

GET /hr_api/v1/datahub/publisher/queues/:queue_uuid/messages
200
{
  "messages": [
    {
      "id": "be10e18f-f92b-4354-a6d9-8cd7f599efb3",
      "entity": {
        "name": "Access.aCloud.Recruitment.Candidate",
        "version": 1
      },
      "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\"}}}}"
    }
  ]
}

POST | POST /hr_api/v1/datahub/publisher/queues/:queue_uuid/messages/:message_uuid/acknowledgement

Sets the status of a Message to acknowledged

Params

Property Required Details Location

queue_uuid

Must be a String

URL

message_uuid

Must be a String

URL

reason

Must be a String

JSON

Examples

POST /hr_api/v1/datahub/publisher/queues/:queue_uuid/messages/:message_uuid/acknowledgement
{}
201
{}

POST | POST /hr_api/v1/datahub/publisher/queues/:queue_uuid/messages/:message_uuid/rejection

Sets the status of a Message to rejected

Params

Property Required Details Location

queue_uuid

Must be a String

URL

message_uuid

Must be a String

URL

reason

Must be a String

JSON

Examples

POST /hr_api/v1/datahub/publisher/queues/:queue_uuid/messages/:message_uuid/rejection
{}
201
{}