Skip to content

Commit 0051695

Browse files
authored
APM-000 AMP-941 API Specs - add Errors section
1 parent a597f6e commit 0051695

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

specification/mesh-api.yaml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,8 +267,16 @@ info:
267267
For more details, and to get started, see [digital onboarding](https://digital.nhs.uk/developer/guides-and-documentation/digital-onboarding#using-the-digital-onboarding-portal).
268268
269269
For any other queries, contact our support mailbox [ssd.nationalservicedesk@nhs.net](mailto:ssd.nationalservicedesk@nhs.net).
270-
271270
271+
## Errors
272+
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
273+
274+
* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
275+
* 400 to 499 if it failed because of a client error by your application
276+
* 500 to 599 if it failed because of an error on our server
277+
278+
Errors specific to each API are shown in the Endpoints section, under Response. See our [reference guide](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#http-status-codes) for more on errors.
279+
272280
title: Message Exchange for Social Care and Health - REST API
273281
version: v1.0.168-alpha
274282
openapi: 3.0.2

0 commit comments

Comments
 (0)