Drs® Enterprise - FHIR®© API Documentation

Drs® FHIR Service Error Messages

Errors are returned as a string type containing a standard HTTP message code.
The following error handling scenarios have been implemented:

1. Any attempt to use HTTP methods other than GET will result in the following:

HTTP 501: Not Implemented

2. If no (or incorrect) credentials have been supplied upon making an initial API request, the following message will be returned:

HTTP 401: Unauthorized

3. If a session has expired, the client will receive the following message:

HTTP 401: Not Authorized: Session Ended or Does Not Exist.

4. If the maximum concurrent sessions of the service has been reached, the client will receive the following message:

HTTP 503: Service Unavailable. Maximum session count has been reached. Please try again later.

5. If the user does not have a REST command token returned to them, the client will receive the following message:

HTTP 400: Bad Request.

6. If the user attempts to spam the server by issueing multiple instances of the same command, the client will receive the following message:

HTTP 429: Too Many Requests.

7. If the user session is dropped whilst sill active, the client will receive the following message:

HTTP 400: Bad Request. Session Not Found.

8. If the server encounters an error whilst the user is logging out, the client will receive the following message:

HTTP 500: Internal Server Error. Logout.

9. If the user issues a bad or unused command, the client will receive the following message:

HTTP 501: Not Implemented

10. Any other exception is handled with the client receving the following general message:

HTTP 500: Internal Server Error.