The Energy Hub Alliance uses error codes to indicate success or failure of API requests. HTTP status codes are used to indicate where things went wrong.Documentation Index
Fetch the complete documentation index at: https://developer.energy-hub.io/llms.txt
Use this file to discover all available pages before exploring further.
- 2XX: indicates success
- 4XX: indicates an invalid request (e.g. a required variable is missing from the request body)
- 5XX: indicates that somethings went wrong on Energy Hub Alliance side (e.g. device is not capable of fulfilling a request).
Common error codes
| Error code | Reason | HTTP status |
|---|---|---|
| BAD_REQUEST | Bad request | 400 |
| VARIABLE_MUST_NOT_BE_BLANK | Path variable is not present | 400 |
| METHOD_ARGUMENT_TYPE_MISMATCH | Failed to convert value to required type | 400 |
| MISSING_REQUEST_PARAMETER | Required request parameter is not present | 400 |
| MISSING_REQUEST_PART | Required request part is not present | 400 |
| MAXIMUM_UPLOAD_SIZE_EXCEEDED | Maximum upload size exceeded | 400 |
| UNAUTHORIZED | Unauthorized | 401 |
| VENDOR_ACCOUNT_NOT_FOUND | Requested vendor account is not found. | 404 |
| METHOD_NOT_ALLOWED | Request HTTP method is not supported | 405 |
| UNSUPPORTED_MEDIA_TYPE | Media type is not supported | 415 |
| TOO_MANY_REQUESTS | Too many requests | 429 |
| INTERNAL_SERVER_ERROR | An error occurred | 500 |
| NOT_IMPLEMENTED | Work in progress | 501 |
| VENDOR_IMPLEMENTATION_IN_PROGRESS | Vendor feature implementation in progress | 501 |
| VENDOR_CONNECTION_ERROR | Connection cannot be established with Vendor API | 503 |
| VENDOR_AUTHENTICATION_ERROR | Authentication error with Vendor API | 503 |
| VENDOR_COMMUNICATION_ERROR | Communication error with Vendor API | 503 |
| VENDOR_ACCOUNT_IS_DISCONNECTED | Vendor account is disconnected | 503 |
| TOO_MANY_REQUESTS | Too many requests | 429 |
| DEVICE_LIMIT_REACHED | Device limit reached | 402 |
| DEVICE_IS_DISCONNECTED | Device disconnected | 503 |
| DEVICE_IMAGE_NOT_FOUND | Device image not found | 404 |
| USER_ACTION_NEEDED | A vendor-specific user action is needed in order to execute this request | 403 |
Service specific error codes
| Error code | Reason | Device Type | HTTP status |
|---|---|---|---|
| USER_LINK_NOT_FOUND | User link not found. | CONNECT | 404 |
| REDIRECT_URL_NOT_MATCHING | Provided redirect url does not match partner management redirect url. | CONNECT | 409 |
| VENDOR_DISABLED | Provided vendor has been disabled and is no longer valid. | CONNECT | 400 |
| TELEMATICS_NOT_SUPPORTED | Vehicle does not support telematics | CONNECT | 422 |
| VENDOR_NOT_SUPPORTED | Provided vendor is not supported for partner | CONNECT | 403 |
| LOCATION_NOT_FOUND | Requested Location not found | LOCATION | 404 |
| TARIFF_NOT_FOUND | Tariff not found. | TARIFF | 404 |
| VEHICLE_NOT_FOUND | Requested Vehicle not found | VEHICLE | 404 |
| VEHICLE_IMAGE_NOT_FOUND | Vehicle image not found | VEHICLE | 404 |
| VIN_NOT_FOUND | VIN not found | VEHICLE | 404 |
| COMMAND_REQUEST_NOT_IMPLEMENTED | Submitting command request is not implemented | VEHICLE | 501 |
| COMMAND_NOT_FOUND | Vehicle command not found | VEHICLE | 404 |
| COMMAND_TYPE_NOT_ALLOWED | Command type for this vehicle is not allowed | VEHICLE | 409 |
| ONLY_ONE_SCHEDULE_ALLOWED | Only one schedule allowed | VEHICLE | 400 |
| SCHEDULE_DAYS_NOT_SUPPORTED | Scheduling days not supported | VEHICLE | 400 |
| COMMANDS_CURRENTLY_NOT_AVAILABLE | Commands are not available, possibly due to vehicle not being at the specified home address | VEHICLE | 400 |
| COMMAND_ALREADY_SUBMITTED | Command has already been submitted | VEHICLE | 409 |
| COMMAND_NOT_SUPPORTED | Submitting command is not supported | VEHICLE | 501 |
| HVAC_NOT_FOUND | HVAC not found | HVAC | 404 |
| HVAC_SCHEDULES_NOT_AVAILABLE | HVAC schedules not available | HVAC | 404 |
| HVAC_IMAGE_NOT_FOUND | Hvac image not found | HVAC | 409 |
| COMMAND_REQUEST_NOT_IMPLEMENTED | Submitting command request is not implemented | HVAC | 501 |
| COMMAND_NOT_FOUND | HVAC command not found | HVAC | 404 |
| COMMAND_TYPE_NOT_ALLOWED | Command type for this HVAC is not allowed | HVAC | 409 |
| INVALID_VENDOR_COMMAND_VALUES | Values given for the command are invalid for this vendor | HVAC | 409 |
| UNSUPPORTED_MODE | Specified vendor does not support this operation mode | HVAC | 400 |
| INVALID_COMMAND_DEVICE | This command is not supported for this type of device | HVAC | 400 |
| COMMAND_ALREADY_SUBMITTED | Command has already been submitted | HVAC | 409 |
| CHARGER_NOT_FOUND | Requested Charger not found | CHARGER | 404 |
| COMMAND_REQUEST_NOT_IMPLEMENTED | Submitting command request is not implemented | CHARGER | 501 |
| COMMAND_NOT_FOUND | Charger command not found | CHARGER | 404 |
| COMMAND_TYPE_NOT_ALLOWED | Command type for this charger is not allowed | CHARGER | 409 |
| INVALID_VENDOR_COMMAND_VALUES | Values given for the command are invalid | CHARGER | 400 |
| COMMAND_ALREADY_SUBMITTED | Command has already been submitted | CHARGER | 409 |
| PV_INVERTER_NOT_FOUND | Requested PV inverter not found | HOME_POWER | 404 |
| BATTERY_NOT_FOUND | Battery not found | HOME_POWER | 404 |
| METER_NOT_FOUND | Meter not found | HOME_POWER | 404 |