Skip to main content

Notifications endpoint

This page includes the Notifications endpoint description and an example.

Page contents

https://directory.spineservices.nhs.uk/ORD/2-0-0/notifications

Description

It is extremely rare, but on occasion, ODS are required to delete/remove records from publication. The ORD Notification endpoint allows us to confirm to users when a record has been deleted from the ORD API.

Querying the ORD Notifications endpoint downloads a JSON file to your machine. This file will contain details of any Organisation or Site records deleted from Organisation Reference Data in the last 185 days. The endpoint is updated daily.

Example

If records have been deleted from the ORD API within the last 185 days, the content of the JSON file, generated by the Notifications endpoint, will contain information as indicated in the example below:

{
	"DeletedOrganisations": [
		{
			"OrgID": "I8M8X",
			"PrimaryRoleId": "RO96",
			"reason": {
				"code": 3,
				"description": "HUMAN ERROR"
			},
			"time": "2023-09-01 00:00:00",
			"type": {
				"code": 1,
				"description": "Machine"
			}
		},
		{
			"OrgID": "F3W7C",
			"PrimaryRoleId": "RO280",
			"reason": {
				"code": 3,
				"description": "HUMAN ERROR"
			},
			"time": "2023-09-01 00:00:00",
			"type": {
				"code": 1,
				"description": "Machine"
			}
		}
	]
}

Record delete 'reason' codes and descriptions:

Code Description
1 THIRD PARTY ERROR
2 ORG DOES NOT EXIST
3 HUMAN ERROR

Record delete 'type' code and description:

Code Description
1 MACHINE

Last edited: 17 July 2024 3:51 pm