Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Application Confirmation type

View file
nameApplicant Confirmation schema.json

Properties


Delivery mode:2

Type: "Application" (Message type)

Content type: "application/json" (Use to restrict content types and for WAF)

Correlation ID: "123e4567-e89b-12d3-a456-426655440000"  (Used to identify message and responses etc…)

AppID: "ESR" (For now likely to be ESR only)

Source file: DE_TIS_APC_20180625_0000142.DAT

Deanery: ABC

Body Example


Body Mandatory Fields Example

{ "loadStatusCode": "SUCCESS" }

Schema for Body

Application Confirmation Schema Body

Code Block
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "description": "Applicant Confirmation File (NHS Interface Hub -> Deanery/HEE Local Office System)",
    "type": "object",
    "properties": {
        "esrVacancyId": {
            "description": "Unique identifier for a vacancy internally created by ESR.  This ID should be used by external systems when send applicant details to ESR that should be linked to a vacancy.",
            "$comment": "Design note: The vacancy ID will not be populated in the Applicant file received from TIS. However in the Applicant Target file that NHS hub prepares for ESR, the vacancy ID field will be populated with a number. This is the relative position of the applicant in the inbound applicant file from TIS/ HICOM. It will be populated in the outbound Applicant Confirmation file that is sent to TIS/ HICOM within the ‘ESR_VACANCY_ID’ field. It will assist in the process of troubleshooting especially in situations where more than one individual are assigned to a DPN.",
            "type": "number",
            "minimum": 0,
            "maximum": 999999999999999
        },
        "vacancyRefNumber": {
            "description": "Unchanged “vacancy_ref_number” as sent by ESR with the vacancy.  Must match existing open vacancy by Name in the ESR database.",
            "type": "string",
            "minLength": 1,
            "maxLength": 30
        },
        "deaneryNumber": {
            "description": "Unchanged “deanery_number” as sent by ESR with the vacancy.  Must match existing open vacancy by Name in the ESR database.",
            "type": "string",
            "minLength": 1,
            "maxLength": 30
        },
        "loadStatusCode": {
            "description": "Describes the status of the attempt to load the application into ESR.",
            "$comment": "The element takes a value of\r\n    • SUCCESS\r\n    • FAIL",
            "type": "string",
            "enum": [
                "SUCCESS",
                "FAIL"
            ]
        },
        "messageText": {
            "description": "Provides additional narrative(s) of the state of the attempted load of applicant details into ESR.",
            "type": "string",
            "minLength": 1,
            "maxLength": 200
        },
        "messageType": {
            "description": "The severity of the status message.",
            "$comment": "Valid values are ‘ERROR’, ‘WARNING’  or ‘INFO’",
            "type": "string",
            "enum": [
                "ERROR",
                "WARNING",
                "INFO"
            ]
        },
        "applicantNumber": {
            "description": "Applicant number for the newly created applicant in ESR.",
            "$comment": "Will only be supplied where the load was successful.",
            "type": "string",
            "minLength": 1,
            "maxLength": 30
        },
        "assignmentId": {
            "description": "Assignment ID for the newly created assignment in ESR",
            "$comment": "Will only be supplied where the load was successful",
            "type": "number",
            "minimum": 0,
            "maximum": 9999999999
        },
        "positionId": {
            "description": "ESR Position ID",
            "$comment": "Will only be supplied where this was supplied in the inbound file",
            "type": "number",
            "minimum": 0,
            "maximum": 9999999999
        },
        "positionNumber": {
            "description": "ESR Position Number",
            "$comment": "Will only be supplied where this was supplied in the inbound file",
            "type": "number",
            "minimum": 0,
            "maximum": 9999999999
        }
    },
    "required": [
        "loadStatusCode"
    ],
    "additionalProperties": false
}

Mapping Document

 

View file
nameApplicantJsonConfirmationCsvMapping.ods