Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

Application Confirmation type

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",

“positionId”: 12345678,

“positionNumber”: 12345678 }

Schema for Body

Application Confirmation Schema Body

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "description": "Applicant Confirmation File (NHS Interface Hub -> Deanery/HEE Local Office System)",
    "type": "object",
    "properties": {
        "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", "positionId", "positionNumber"
    ],
    "additionalProperties": false
}

Mapping Document

 

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.