Перейти к основному содержимому

Расписания API 1.6.0

Расписания доступа и временные интервалы.

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.6.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
GET/schedules/
GET/schedules/{uuid}
POST/schedules/
PUT/schedules/{uuid}
DELETE/schedules/{uuid}

GET /schedules/​

Раздел: Расписания.

Возвращает список всех расписаний профилей доступа с настройками.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/schedules/" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/schedules/" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/schedules/"
  }
}

GET /schedules/{uuid}​

Раздел: Расписания.

Возвращает настройки конкретного расписания.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/schedules/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/schedules/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/schedules/{uuid}"
  }
}

POST /schedules/​

Раздел: Расписания.

Добавляет новое расписание.

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/schedules/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "Рабочее время",
  "intervals": [
    {
      "days": [
        "mon",
        "tue",
        "wed",
        "thu",
        "fri"
      ],
      "from": "09:00",
      "to": "18:00"
    }
  ]
}'

Пример тела запроса​

{
  "name": "Рабочее время",
  "intervals": [
    {
      "days": [
        "mon",
        "tue",
        "wed",
        "thu",
        "fri"
      ],
      "from": "09:00",
      "to": "18:00"
    }
  ]
}

Пример получения ответа​

curl -k -sS -X POST "https://{IP_контроллера}/api/v1/schedules/" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /schedules/{uuid}​

Раздел: Расписания.

Редактирует существующее расписание.

Пример запроса​

curl -k -X PUT "https://{IP_контроллера}/api/v1/schedules/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "Рабочее время",
  "intervals": [
    {
      "days": [
        "mon",
        "tue",
        "wed",
        "thu",
        "fri"
      ],
      "from": "09:00",
      "to": "18:00"
    }
  ]
}'

Пример тела запроса​

{
  "name": "Рабочее время",
  "intervals": [
    {
      "days": [
        "mon",
        "tue",
        "wed",
        "thu",
        "fri"
      ],
      "from": "09:00",
      "to": "18:00"
    }
  ]
}

Пример получения ответа​

curl -k -sS -X PUT "https://{IP_контроллера}/api/v1/schedules/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

DELETE /schedules/{uuid}​

Раздел: Расписания.

Удаляет существующее расписание.

Пример запроса​

curl -k -X DELETE "https://{IP_контроллера}/api/v1/schedules/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/schedules/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "deleted": true
}