For information about valid value ranges, time constraints, and step increments, query the device's preferenceSettings field which provides bounds and validation rules.

Fields

dayOfWeek : DayOfWeek!


            required

Day of week schedule applies to.

max : Float

Maximum value for the schedule. Usage depends on the targetType and mode - e.g. target state of charge for EVs, or cooling set point for heat pumps.For valid bounds and step increments, see the device's preferenceSettings field.

min : Float

Minimum value for the schedule when applicable. Usage depends on the targetType and mode - e.g. heating set point temperature for heat pumps. May be null for device types that don't require a lower bound. For valid bounds and step increments, see the device's preferenceSettings field.

time : Time!


            required

Time of day the preference applies.

upperLimit : Float

Upper limit value for the schedule when applicable.Usage depends on the targetType - e.g., charge level to never be exceeded for V2G EVs.May be null for device types that don't require an upper bound.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{
  "dayOfWeek": "MONDAY",
  "max": 777.79,
  "min": 345.62,
  "time": "17:49:43.421018",
  "upperLimit": 775.93
}