API Errors

The Home Connect API returns appropriate HTTP status codes for every request.

Code Short Description Long Description
200 OK The request was successful. Typically returned for successful GET requests.
204 No Content The request was successful. Typically returned for successful PUT/DELETE requests with no payload.
400 Bad Request Error occurred (e.g. validation error - value is out of range)
401 Unauthorized No or invalid access token
403 Forbidden Scope has not been granted or home appliance is not assigned to HC account
404 Not Found This resource is not available (e.g. no images on washing machine)
405 Method not allowed The HTTP Method is not allowed for this resource
406 Not Acceptable The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
408 Request Timeout API Server failed to produce an answer or has no connection to backend service
409 Conflict Command/Query cannot be executed for the home appliance, the error response contains the error details
415 Unsupported Media Type The request's Content-Type is not supported
429 Too Many Requests E.g. the number of requests for a specific endpoint exceeded the quota of the client
500 Internal Server Error E.g. in case of a server configuration error or any errors in resource files
503 Service Unavailable E.g. if a required backend service is not available

 

Errors may have a JSON payload with the following structure:


{ // API Response Object
    "error": { // API Error Object
        "key": "...", // A system wide per error unique key
        "description": "..." // A human readable, English description about the reasons of the error
    }
}

 

Error Cases

Code Error Key Error Description
401 401 Authentication is possible but has failed or not yet been provided.
401 invalid_token The access token is malformed
401 invalid_token The access token expired
401 invalid_token The access token is revoked
404 404 The requested resource could not be found but may be available again in the future.
405 405 HTTP method not allowed, supported methods: {list of supported methods}
404 SDK.Error.NotInSimulator This endpoint / method is not implemented on the simulator, but may be valid for real home appliances.
429 429 The user has sent too many requests in a given amount of time.
403 insufficient_scope Insufficient scope for this resource
403 insufficient_scope Not allowed to access this HomeAppliance
403 insufficient_scope Action not supported for HomeAppliance type {HA type}
403 insufficient_scope Insufficient permissions for this resource
409 SDK.Error.UnsupportedOperation Operation not supported for HomeAppliance type {HA type}
406 406 Resource representation is only available with these types: {list of supported types}
415 415 The request's Content-Type is not supported. Expected: {list of supported types}
400 400 The request content was malformed: {error description} 
400 400 data.key does not match path
409 SDK.Error.HomeAppliance.
Connection.Initialization.Timeout
HomeAppliance did not respond to connection initialization requests in time, it might be offline
409 SDK.Error.UnsupportedProgram Unknown program feature key: {featurekey}
404 SDK.Error.UnsupportedProgram Program not supported
409 SDK.Error.UnsupportedOption
  • Unknown option feature key: {featurekey}
  • Program option not supported
409 SDK.Error.UnsupportedStatus Status not supported
409 SDK.Error.UnsupportedSetting
  • Setting not supported
  • Setting not found for HomeAppliance
409 SDK.Error.UnsupportedUnit Unknown unit {unit} for feature key: {featurekey}
409 BSH.Common.Error.
RemoteControlNotActive
RemoteControl is not enabled
409 BSH.Common.Error.
RemoteStartNotActive
RemoteStart is not enabled
409 SDK.Error.WrongOperationState
  • Request cannot be performed since OperationState is not {list of expected operation state}; Request cannot be performed since an active program is set; {featurekey} validation failed with NotAvailable
  • Request cannot be performed since OperationState is not {list of expected operation state}; Program cannot be aborted; Request cannot be performed since no active program is set
409 BSH.Common.Error.
LockedByLocalControl
Request cannot be performed temporarily! due to local actuated user intervention
409 SDK.Error.Cooking.Oven.
Status.FrontPanelOpen
FrontPanelOpen is open
409 SDK.Error.WrongDoorState Request cannot be performed since door is not closed
409 SDK.Error.Cooking.Oven.
Status.MeatprobePlugged
Meatprobe is plugged
409 SDK.Error.BatteryLevelTooLow
  • Request cannot be performed since the battery level is lower than 10%
  • Request cannot be performed since the battery level is lower than 20%
409 SDK.Error.ConsumerProducts.CleaningRobot.
Status.Lifted
Request cannot performed since the robot is lifted
409 SDK.Error.ConsumerProducts.CleaningRobot.
Status.DustBoxNotInserted
Request cannot performed since the dust box is not inserted
409 SDK.Error.ConsumerProducts.CleaningRobot.
Status.AlreadyAtHome
Device is already connected to charging station.
409 SDK.Error.SelectedProgramNotSet Request cannot be performed since no program is selected
404 SDK.Error.ActiveProgramSet Request cannot be performed since an active program is set
409 SDK.Error.ActiveProgramSet  
409 SDK.Error.ActiveProgramNotSet Request cannot be performed since no active program is set
409 SDK.Error.WrongProgramState Program cannot be aborted
409 SDK.Error.ProgramNotAvailable Program currently not available
409 SDK.Error.ProgramNotWritable Program can currently not be written
409 SDK.Error.InvalidOptionState
  • {featurekey} validation failed with NotAvailable
  • {featurekey} validation failed with NotWritable
404 SDK.Error.NoProgramSelected There is no program selected
404 SDK.Error.NoProgramActive There is no program active
409 SDK.Error.MissingOptionValue {featurekey} is missing
409 SDK.Error.InvalidOptionValue
  • Program option {featurekey} value {value} is below the minimum {min value}
  • Program option {featurekey} value {value} exceeds {max value}
  • Program option {featurekey} has unexpected type or value true
  • {featurekey} validation failed with OutOfBounds
  • {featurekey} validation failed with NotWritable
  • {featurekey} validation failed with InvalidOption
  • Program option {featurekey} value {value} does not match stepsize {stepsize} 
409 SDK.Error.InvalidOptionCombination If SteamAssistLevel is enabled THEN FastPreHeat must be switched off
409 SDK.Error.InvalidSettingState {featurekey} validation failed with NotWritable
409 SDK.Error.InvalidSettingValue Setting {featurekey} has unexpected type or value