API error codes and responses
The Homepass API returns the following status codes and error responses:
HTTP Status Codes
Each API response will return with one of the following HTTP status codes
Code | Text | Description |
---|---|---|
200 | Success | The request is valid. |
400 | Bad Request | The request is invalid. |
401 | Unauthorized | Authentication details are invalid |
403 | Forbidden | Request is understood, but access is refused. |
404 | Not Found | The requested URI is invalid or the requested resource does not exist. |
500 | Internal Server Error | Something is broken on the backend. Contact the Homepass team for details |
502 | Bad Gateway | Homepass API is down. |
503 | Service Unavailable | Homepass API is overloaded with requests or being upgraded |
Error Messages
Homepass APIs will return error messages in the following format:
{
"statusCode": 400
"error": "Bad Request"
"messages": "Invalid page number"
}