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 2 Next »

Properties


Delivery mode:2

Type: "Reconciliation" (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: example.dat

Deanery: ABC


Body Example


{"positionID": 123456789123456, T_POR02 Position ID

"changeDeleteIndicator": "D", T_POR04 Delete/Change Indicator

"positionNumber": 1234567890, T_POR05 Position Number

"positionTitle": "test", T_POR06 Position Title

"deaneryNumber": "NTH/RTFED/040/STR/210", T_POR07 Deanery Number

"managingOffice": "Northern", T_POR08 Managing Deanery/HEE Local Office(former Deanery Body)

"odsCode": "CodingCode", T_POR10 ODS Employer Code

"hostLeadIndicator": "Host Employer", T_POR09 Host/Lead Employer Indicator

"employingOrgVPDCode": 0234, T_POR11 Employing Organisation VPD Code

"esrOrganisation": "Happy Org", T_POR12 ESR Organisation

"esrLocation": "there"}


Body Mandatory Fields Example

{"positionID": 123456789123456,

"deaneryNumber": "NTH/RTFED/040/STR/210"}

 

 

Schema for body


{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"type": "object",
	"minProperties": 1,
	"properties": {
		"positionID": {
			"type": "integer",
			"minLength": 1,
			"maxLength": 15
		},
		"changeDeleteIndicator": {
			"type": "string",
			"enum": [
				"C",
				"D"
			]
		},
		"positionNumber": {
			"type": "integer",
			"maxLength": 10
		},
		"positionTitle": {
			"type": "string",
			"maxLength": 60
		},
		"deaneryNumber": {
			"type": "string",
			"minLength": 1,
			"maxLength": 30
		},
		"managingOffice": {
			"type": "string",
			"maxLength": 10
		},
		"odsCode": {
			"type": "string",
			"maxLength": 30
		},
		"hostLeadIndicator": {
			"type": "string",
			"enum": [
				"Host Employer",
				"Lead Employer"
			]
		},
		"employingOrgVPDCode": {
			"type": "integer",
			"maxLength": 4
		},
		"esrOrganisation": {
			"type": "string",
			"maxLength": 240
		},
		"esrLocation": {
			"type": "string",
			"maxLength": 240
		}
	},
	"required": [
		"positionID",
		"deaneryNumber"
	],
	"additionalProperties": false
}


{

    "$schema": "http://json-schema.org/draft-07/schema#",

 "type": "object",

 "minProperties": 1,


 "properties": {

"positionID": {"type": "integer", "minLength":1, "maxLength": 15},

"changeDeleteIndicator": {"type": "string", "enum":["C","D"]},

"positionNumber": {"type": "integer", "maxLength": 10},

"positionTitle": {"type": "string", "maxLength": 60},

"deaneryNumber": {"type": "string", "minLength":1, "maxLength": 30},

"managingOffice": {"type": "string", "maxLength": 10},

"odsCode": {"type": "string", "maxLength": 30},

  • No labels