Alexa.ThermostatController.Schedule.ErrorResponse Interface 3.2

If Alexa sends an Alexa.ThermostatController.Schedule directive to your smart home add-on and you can’t handle it successfully, respond with an Alexa.ThermostatController.Schedule.ErrorResponse event. For details, see Alexa.ThermostatController.Schedule.

ErrorResponse event

In the payload for the Alexa.ThermostatController.Schedule.ErrorResponse, specify the type of the error and include a message with information about the error. For the list of Alexa.ThermostatController.Schedule error types, see Error type values. You can send the error response in a synchronous or asynchronous response. For more details, see Alexa.ErrorResponse.

ErrorResponse event format

{
"event": {
    "header": {
      "namespace": "Alexa.ThermostatController.Schedule",
      "name": "ErrorResponse",
      "messageId": "Unique identifier, preferably a version 4 UUID",
      "correlationToken": "Opaque correlation token that matches the request",
      "payloadVersion": "3"
    },
    "endpoint":{
      "endpointId": "Endpoint ID"
    },
    "payload": {
      "type": "Error type",
      "message": "Error message"
    }
  }
}

ErrorResponse event payload properties

Field	Description	Type	Required
`type`	The type of error. Alexa shares this with the customer.	String	Yes
`message`	The error message for the error. Alexa doesn’t share this with the customer.	String	Yes

Error type values

The following table shows the valid Alexa.ThermostatController.Schedule error types.

Error Type	Description
`INSUFFICIENT_SPACE`	Thermostat has insufficient space. This error might occur when the user set too many schedules and exceeded the device limit.

In addition to the Alexa.ThermostatController.Schedule.ErrorResponse error types, you can also use Alexa error types, such as INVALID_VALUE or TEMPERATURE_VALUE_OUT_OF_RANGE. For details, see Alexa.ErrorResponse error type values.

Alexa.ThermostatController.Schedule.ErrorResponse examples

The following examples show the payload for different error types.

INSUFFICIENT_SPACE

The following is an example error response for the INSUFFICIENT_SPACE error type.

{
  "event": {
    "header": {
      "namespace": "Alexa.ThermostatController.Schedule",
      "name": "ErrorResponse",
      "messageId": "Unique identifier, preferably a version 4 UUID",
      "correlationToken": "Opaque correlation token that matches the request",
      "payloadVersion": "3.2"
    },
    "endpoint":{
      "endpointId": "Endpoint id"
    },
    "payload": {
      "type": "INSUFFICIENT_SPACE",
      "message": "User exceeded limit for number of schedule entries."
      }
  }
}

Get Started

Connect Your Device to Alexa

Certify Your Device

Developer Reference

Alexa.ThermostatController.Schedule.ErrorResponse Interface 3.2

ErrorResponse event

ErrorResponse event format

ErrorResponse event payload properties

Error type values

Alexa.ThermostatController.Schedule.ErrorResponse examples

INSUFFICIENT_SPACE

​ErrorResponse event

​ErrorResponse event format

​ErrorResponse event payload properties

​Error type values

​Alexa.ThermostatController.Schedule.ErrorResponse examples

​INSUFFICIENT_SPACE

​Related topics

ErrorResponse event

ErrorResponse event format

ErrorResponse event payload properties

Error type values

Alexa.ThermostatController.Schedule.ErrorResponse examples

INSUFFICIENT_SPACE

Related topics