API Errors
When performing operations on Bosch smart home devices, services and scenarios via the IoT Things messages endpoints, certain errors may occur. These errors are reported to the caller in form of AdvancedError JSON object as described in the API Specification. The error responses are generated either by the Bosch IoT Things platform or by Bosch smart home devices, services and scenarios. Following errors may be encountered:
Bosch smart home errors
| HTTP status code | Error code | Entity type | Description |
|---|---|---|---|
| 400 | sh:request.invalid | * | Provided request is invalid for the operation. |
| 400 | sh:value.outofrange | Climate Control Shutter Control Radiator Thermostat |
Given value is out of allowed range. |
| 400 | sh:value.wronggranularity | Climate Control | Given value does not have the correct granularity. |
| 400 | sh:notsupported.in.currentmode | Climate Control | Entity is in a mode where this operation is not supported. |
| 400 | sh:valvetappet.instartposition | Radiator Thermostat | The Valve is in start position and not operable. |
| 400 | sh:valvetappet.valvetootight | Radiator Thermostat | The Valve is too tight and not operable. |
| 400 | sh:valvetappet.error | Radiator Thermostat | Entity is in a general error mode. |
| 401 | sh:jwt.token.invalid | * | Provided JWT token is missing or invalid. |
| 403 | sh:cloud.notactivated | * | Smart home cloud has not been activated by the user. |
| 404 | sh:entity.notfound | * | Entity such as a device, service or scenario not found. |
| 408 | sh:request.timeout | * | Provided request timed out. |
| 409 | sh:conflict | Camera | Conflict. |
| 417 | sh:expectation.failed | Camera | Expectation failed. |
| 429 | sh:too.many.requests | Camera | Too many requests. |
| 441 | sh:not.commissioned | Camera | Not commissioned. |
| 442 | sh:hardware.not.supported | Camera | Operation is not supported. |
| 443 | sh:camera.in.privacy.mode | Camera | Camera is in privacy mode. |
| 444 | sh:camera.unavailable | Camera | Camera is offline or unavailable for this operation. |
| 445 | sh:camera.not.upright.positioned | Camera | Camera is not upright positioned. |
| 446 | sh:camera.panning.blocked | Camera | Camera panning blocked. |
| 446 | sh:firmware.not.supported | Camera | Firmware is not supported. |
| 456 | sh:toomany.commissioning.cameras | Camera | Too many commissioning cameras. |
| 459 | sh:pre.maintenance.mode | Camera | Pre-maintenance mode, retry later after maintenance is completed. |
| 470 | sh:generic.error | Camera | Generic error. |
| 500 | sh:internal.error | * | Internal server error. |
| 503 | sh:entity.unavailable | * | Entity such as a device, service or scenario is currently unavailable. |
| 503 | sh:maintenance.mode | Camera | Maintenance mode. |
Bosch IoT Things errors
| HTTP status code | Error code | Entity type | Description |
|---|---|---|---|
| 401 | gateway:authentication.failed | * | The request could not be completed due to missing authentication. |
| 403 | messages:send.notallowed | * | The message cannot be send because the affected thing does not exist |
| 404 | things:thing.notfound | * | The message cannot be send because the affected thing cannot be found with the given id |
| 404 | things:feature.notfound | * | The message cannot be send because the affected feature cannot be found with the given id |
Cloud API Scopes
In addition to the errors defined above, the caller may encounter further errors which are not part of the API. Upon encountering errors with unspecified HTTP status code or error codes, the user may be advised to contact support.