Skip to main content
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.
  • 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 codeReasonHTTP status
BAD_REQUESTBad request400
VARIABLE_MUST_NOT_BE_BLANKPath variable is not present400
METHOD_ARGUMENT_TYPE_MISMATCHFailed to convert value to required type400
MISSING_REQUEST_PARAMETERRequired request parameter is not present400
MISSING_REQUEST_PARTRequired request part is not present400
MAXIMUM_UPLOAD_SIZE_EXCEEDEDMaximum upload size exceeded400
UNAUTHORIZEDUnauthorized401
VENDOR_ACCOUNT_NOT_FOUNDRequested vendor account is not found.404
METHOD_NOT_ALLOWEDRequest HTTP method is not supported405
UNSUPPORTED_MEDIA_TYPEMedia type is not supported415
TOO_MANY_REQUESTSToo many requests429
INTERNAL_SERVER_ERRORAn error occurred500
NOT_IMPLEMENTEDWork in progress501
VENDOR_IMPLEMENTATION_IN_PROGRESSVendor feature implementation in progress501
VENDOR_CONNECTION_ERRORConnection cannot be established with Vendor API503
VENDOR_AUTHENTICATION_ERRORAuthentication error with Vendor API503
VENDOR_COMMUNICATION_ERRORCommunication error with Vendor API503
VENDOR_ACCOUNT_IS_DISCONNECTEDVendor account is disconnected503
TOO_MANY_REQUESTSToo many requests429
DEVICE_LIMIT_REACHEDDevice limit reached402
DEVICE_IS_DISCONNECTEDDevice disconnected503
DEVICE_IMAGE_NOT_FOUNDDevice image not found404
The response with the error code BAD_REQUEST may contain the field validationErrors. This field includes the list of fields that failed the validation check with the error message for each field.

​
Service specific error codes

Error codeReasonDevice TypeHTTP status
USER_LINK_NOT_FOUNDUser link not found.CONNECT404
REDIRECT_URL_NOT_MATCHINGProvided redirect url does not match partner management redirect url.CONNECT409
VENDOR_DISABLEDProvided vendor has been disabled and is no longer valid.CONNECT400
TELEMATICS_NOT_SUPPORTEDVehicle does not support telematicsCONNECT422
VENDOR_NOT_SUPPORTEDProvided vendor is not supported for partnerCONNECT403
LOCATION_NOT_FOUNDRequested Location not foundLOCATION404
TARIFF_NOT_FOUNDTariff not found.TARIFF404
VEHICLE_NOT_FOUNDRequested Vehicle not foundVEHICLE404
VEHICLE_IMAGE_NOT_FOUNDVehicle image not foundVEHICLE404
VIN_NOT_FOUNDVIN not foundVEHICLE404
COMMAND_REQUEST_NOT_IMPLEMENTEDSubmitting command request is not implementedVEHICLE501
COMMAND_NOT_FOUNDVehicle command not foundVEHICLE404
COMMAND_TYPE_NOT_ALLOWEDCommand type for this vehicle is not allowedVEHICLE409
ONLY_ONE_SCHEDULE_ALLOWEDOnly one schedule allowedVEHICLE400
SCHEDULE_DAYS_NOT_SUPPORTEDScheduling days not supportedVEHICLE400
COMMANDS_CURRENTLY_NOT_AVAILABLECommands are not available, possibly due to vehicle not being at the specified home addressVEHICLE400
COMMAND_ALREADY_SUBMITTEDCommand has already been submittedVEHICLE409
COMMAND_NOT_SUPPORTEDSubmitting command is not supportedVEHICLE501
HVAC_NOT_FOUNDHVAC not foundHVAC404
HVAC_SCHEDULES_NOT_AVAILABLEHVAC schedules not availableHVAC404
HVAC_IMAGE_NOT_FOUNDHvac image not foundHVAC409
COMMAND_REQUEST_NOT_IMPLEMENTEDSubmitting command request is not implementedHVAC501
COMMAND_NOT_FOUNDHVAC command not foundHVAC404
COMMAND_TYPE_NOT_ALLOWEDCommand type for this HVAC is not allowedHVAC409
INVALID_VENDOR_COMMAND_VALUESValues given for the command are invalid for this vendorHVAC409
UNSUPPORTED_MODESpecified vendor does not support this operation modeHVAC400
INVALID_COMMAND_DEVICEThis command is not supported for this type of deviceHVAC400
COMMAND_ALREADY_SUBMITTEDCommand has already been submittedHVAC409
CHARGER_NOT_FOUNDRequested Charger not foundCHARGER404
COMMAND_REQUEST_NOT_IMPLEMENTEDSubmitting command request is not implementedCHARGER501
COMMAND_NOT_FOUNDCharger command not foundCHARGER404
COMMAND_TYPE_NOT_ALLOWEDCommand type for this charger is not allowedCHARGER409
INVALID_VENDOR_COMMAND_VALUESValues given for the command are invalidCHARGER400
COMMAND_ALREADY_SUBMITTEDCommand has already been submittedCHARGER409
PV_INVERTER_NOT_FOUNDRequested PV inverter not foundHOME_POWER404
BATTERY_NOT_FOUNDBattery not foundHOME_POWER404
METER_NOT_FOUNDMeter not foundHOME_POWER404