Отримати розклад

GET 
/schedules/:id

Отримати інформацію про розклад

Request

Path Parameters

id integerrequired

Ідентифікатор розкладу

Responses

200

Отримайте конкретний розклад

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

activeboolean

Is schedule active

type

string

required

Possible values: [thermostat, actionCall, sceneInvoke]

Schedule type

thermostat

schedule_periods

object[]

Array of schedule periods

Array [

daystring

День

Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]

timepoints

object[]

.schedules.period.thermostat.timepoints.description

Array [

timestring

.schedules.period.timepoints.time.description

Example: 12:00

setpointnumber

.schedules.period.thermostat.timepoints.setpoint.description

Example: 20.5

modestring

.schedules.period.thermostat.timepoints.mode.description

Possible values: [Off, Heat, Cool, Auto]

Example: Heat

]

]

actionCall

action_namestring

name of action to call

schedule_periods

object[]

Array of schedule periods

Array [

daystring

День

Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]

timepoints

object[]

Array [

timestring

.schedules.period.timepoints.time.description

Example: 12:00

arguments

.schedules.period.timepoints.action_call.arguments.description

]

]

sceneInvoke

scene_idinteger

id of scene to call

schedule_periods

object[]

Array of schedule periods

Array [

daystring

День

Possible values: [monday, tuesday, wednesday, thursday, friday, saturday, sunday]

timepoints

object[]

Array [

timestring

.schedules.period.timepoints.time.description

Example: 12:00

]

]

target_typestring

Possible values: [device, room]

target_idsinteger[]

IDs of targets

period_typestring

Schedule repeat period

Possible values: [yearly, monthly, weekly, daily, hourly, interval]

idinteger

Schedule ID

Example (from schema)

{
  "success": true,
  "active": true,
  "type": "thermostat",
  "target_type": "device",
  "target_ids": [
    0
  ],
  "period_type": "yearly",
  "id": 0
}

401

Користувач не має дозволу.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4131,
  "errorMessage": "User not authorized",
  "errorParameters": "Not authorized"
}

404

Розклад не знайдено

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4128,
  "errorMessage": "Not found",
  "errorParameters": {
    "type": "schedule",
    "id": 11
  }
}