-
Notifications
You must be signed in to change notification settings - Fork 7
API Error Codes
Dheeraj Pundir edited this page Nov 4, 2020
·
11 revisions
This page documents the error codes that are used in the reference system.
- All codes are 4 digit codes.
- CM ranges - 1xxx
- Gateway ranges - 2xxx
- HIP Bridge/Health-Repository - 3xxx
- HIU Bridge/Health-Repository - 4xxx
- 1st Digit denotes the System
- 2nd Digit denotes the type of errors (e.g. x4xx - typically for client errors, x5xx - for internal errors)
- Some error codes are intentionally kept similar to bring synergy with HTTP Status codes (e.g x401, x500)
- Some error codes are also maintained so as to keep same numbers in the other systems for similar error
| Code | Description | Explanation |
|---|---|---|
| 2401 | Invalid Token | |
| 2429 | Too many attempts | Usually in case of replay attacks, where the same requestId+timestamp have been repeated |
| 2500 | Unknown Error | Server side error that was unexpected |
| 2503 | Service down | One or more internal service is down |
| 2504 | External resource unavailable | Database or other network resource is not available |
| 2505 | Invalid Bridge Registry Request | |
| 2506 | Invalid Bridge Service Request | |
| 2507 | Invalid CM Service Request | |
| 2508 | Invalid CM Registration Entry |
| Code | Description | Explanation |
|---|---|---|
| 1401 | Token is invalid or expired | Token is invalid or expired |
| 1402 | Care Context Not Found | |
| 1403 | Incorrect Refresh Token | |
| 1404 | No patient Found | |
| 1405 | Invalid OTP | |
| 1406 | OTP Expired | |
| 1407 | OTP request limit exceeded | |
| 1408 | Invalid OTP attempts exceeded | |
| 1409 | Duplicate discovery request | |
| 1410 | Consent Artefact Expired | |
| 1411 | Invalid State | |
| 1412 | Request Already Exists | |
| 1413 | Invalid Link Reference | |
| 1414 | User not found | |
| 1415 | Consent Request not found | |
| 1416 | Consent Artefact not found | |
| 1417 | Invalid Requester | |
| 1418 | Invalid Date Range | |
| 1419 | Invalid HI Type | |
| 1420 | Invalid Purpose of Use | |
| 1421 | Invalid Provider or Care-Context | |
| 1422 | Can not process response from Gateway | |
| 1423 | User temporarily blocked | |
| 1424 | Transaction PIN is already created | |
| 1425 | Invalid Transaction PIN | |
| 1427 | Transaction ID not found | |
| 1428 | Consent not granted | |
| 1429 | PIN Attempts exceeded | |
| 1430 | Invalid Session | |
| 1431 | Invalid Scope | |
| 1432 | Invalid Recovery Request | |
| 1433 | Username or password incorrect | |
| 1434 | User already exists | |
| 1435 | Consent Request expired | |
| 1436 | Invalid Auth Method | |
| 1437 | Account not found | |
| 1438 | Invalid Discovery | |
| 1500 | Unknown error occurred | |
| 1501 | Queue not found | |
| 1502 | Database operation failed | |
| 1503 | Unable to connect to provider registry | |
| 1504 | No result from Gateway | |
| 1505 | Provider not found | |
| 1506 | Invalid callback resp id | |
| 1507 | Failed to get linked care contexts | |
| 1508 | Consent Artefact forbidden | |
| 1509 | Transaction PIN does not exist | |
| 1510 | Bad request from Gateway | |
| 1511 | Network Service Error | |
| 1503 | Service is down | |
| 1512 | Discovery request not found | |
| 1513 | Invalid Request | |
| 1514 | Unable to fetch last resource date | |
| 1439 | Care context already linked |
| Code | Description | Explanation |
|---|---|---|
| 3401 | Invalid Token for link Confirmation | Token is invalid or expired |
| 3402 | Care Context Not found | |
| 3403 | Multiple patients found | |
| 3404 | No Patients Found | |
| 3405 | Invalid OTP | |
| 3406 | OTP Expired | |
| 3407 | Discovery Request Not Found | |
| 3408 | Link Expired | |
| 3409 | Duplicate Discovery Request | |
| 3410 | Expired Key Pair | |
| 3413 | No Link Request Found | |
| 3416 | Consent Artefact Not Found | |
| 3417 | Invalid Consent Status | |
| 3429 | Duplicate Request | |
| 3500 | Internal Server Error | |
| 3501 | OTP Generation Failed | |
| 3502 | Health Information Not Found | |
| 3507 | Failed to Get Linked Care-Contexts |
| Code | Description | Explanation |
|---|---|---|
| 4400 | Bad Request | Required attributes not provided or Request information is not as expected |
| 4401 | Unauthorized request | |
| 4404 | Consent request not found | |
| 4406 | Invalid Data Flow Entry | |
| 4407 | Patient Not Found | |
| 4420 | Invalid Purpose of Use | |
| 4422 | Invalid Data from Gateway | |
| 4450 | Invalid Username or password | |
| 4500 | Unknown error occurred | |
| 4504 | No result from Gateway | |
| 4550 | Undefined queue | |
| 4551 | Consent Artefact not found | |
| 4552 | Validation failed | |
| 4553 | Failed to Notify Consent Manager | |
| 4503 | SERVICE_DOWN |