API Error Codes

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

Gateway Error Codes

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

CM Error Codes (WIP)

Code	Description	Explanation
1401	Invalid Token	Token is invalid or expired

HIU Bridge/Health-Repository Error Codes (WIP)

Code	Description	Explanation
3401	Invalid Token	Token is invalid or expired

HIP Bridge/Health-Repository Error Codes (WIP)

Code	Description	Explanation
4400	Bad Request	Required attributes not provided or Request information is not as expected