v1

latestOpenAPI 3.0.02026-07-148098.2 KB

Get deletion notices

Overview

Use this endpoint to check for any full record or partial record deletions. As these occur infrequently a full List of deletions will be provided. There are four Lists which provide details of deletions that have occured within the ODS Data

  • Organization-deletion
  • OrganizationAffiliation-deletion
  • Organization-role-deletion
  • Organization-succession-deletion

Organization-deletion

From time to time it is posible that we create or receive orgnisations which are created in error and removed from the source data. when this occurs there is no updates to the record, it is simply no longer available. to inform users when Organisations have been deleted, we have used the List resource to provide the ODS Code of the records which have been deleted so that you may removed them from any local copies you may be maintaining.

OrganizationAffilliation-deletion

in the unlikely event that a relationship must be deleted rather then given an end date, the RelationshipID will be provided in this List resource.

Organization-role-deletion

In the unlikely event that a role is deleted, rather than given an end date, the roleID will be provided in this list resource. As the role forms part of the Organization Resource you may not need to take action other than to verify the role was intentionally removed.

Organization-succession-deletion

In the unlikely event that the succession is removed from an organisation, the Organisation's ODS Code and that of it's successor will be published in this list resource. As the successor and predecessor are properties of the ods-organization-code CodeSystem, you may not need to take action if you are maintaining a local copy of the CodeSystem other than to verify the succession was intentionally removed.

get/List{id}

Path parameters

idstring required
Example:Organization-deletion

the business name for the List which contains details of deleted records

Response

a valid List resource containing details of deleted records