Details of the API Codes used in the responses.
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully implement the National Opt-Out API. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis.
Warning: This site is provided for information only and is intended for those engaged with NHS Digital and the implementation of the National Opt-Out API. It is advised not to develop against these specifications until a formal announcement has been made.
1. API Codes
1.1. 2xx Http Success
200 OK
Successful Operation
201 Created
The resource was created.
1.2. 4xx Http Client Errors
405 Method Not Allowed
An attempt was made to create a resource using a PUT rather than a POST
Spine operationOutcome: MSG_RESOURCE_ID_FAIL - Client is not permitted to assign an id
422 Unprocessable Entity
A resource already exists for the patient
Spine operationOutcome: DUPLICATE_REJECTED - Create would lead to creation of a duplicate resource
