Skip to content

Commit efc4e63

Browse files
Merge pull request #596 from NHSDigital/APM-003-AMP-941---Add-Errors-section-to-the-spec
API Specs - add Errors section
2 parents b2be5f4 + 5303ab8 commit efc4e63

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

specification/e-referrals-service-api.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,14 @@ info:
238238
239239
In step 14: following receipt, review and acceptance of your signed Connection Agreement, the e-RS FHIR API Partners team will contact you to facilitate production access for your application.
240240
241+
## Errors
242+
We use standard HTTP status codes to show whether an API request succeeded or not. They are usually in the range:
243+
* 200 to 299 if it succeeded, including code 202 if it was accepted by an API that needs to wait for further action
244+
* 400 to 499 if it failed because of a client error by your application
245+
* 500 to 599 if it failed because of an error on our server
246+
247+
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.
248+
241249
242250
contact:
243251
url: 'https://digital.nhs.uk/developer/help-and-support'

0 commit comments

Comments
 (0)