Расписания
Параметры manual, delete и remove в POST запросе обрабатываются отдельно и передаются по одиночке. Все остальные параметры используются для создания/редактирования расписаний и передаются совместно.
GET запрос
URL https://api.saures.ru/1.0/object/schedule
Параметры запроса
| sid uuid4 | идентификатор сессии |
| id int | id объекта |
| [...] list | текущий список расписаний:
{id: id расписания,
day: день(0 - каждый день, 32 - последний день месяца),
time: час отправки в формате Ч:00,
type: тип отправки(email, push, sms, telegram, mos_ru, mosobleirc, mvk),
fraction: признак дробной части,
last_dt: дата последней успешной отправки,
personal_account: лицевой счёт(для всех, кроме push),
receiver: получатели уведомлений(для email, push, sms, telegram),
receiver_id: id получателя уведомления внешней системы,
resource_types: список типов устройств} |
Пример
$ http GET https://api.saures.ru/1.0/object/schedule sid=="92104027-908a-43dd-b18b-b06b918f696d" id=="10747" -v
GET /1.0/object/schedule?sid=92104027-908a-43dd-b18b-b06b918f696d&id=10747
HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Host: api.saures.ru
User-Agent: HTTPie/0.9.8
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 223
Content-Type: application/json; charset=utf-8
Strict-Transport-Security: max-age=31536000
{
"data": [
{
"day": 25,
"fraction": true,
"id": 7309,
"last_dt": null,
"personal_account": "1234567890",
"receiver": "newuser@saures.ru",
"resource_types": [
1
],
"time": "9:00",
"type": "email"
}
],
"errors": [],
"status": "ok"
}
POST запрос
URL https://api.saures.ru/1.0/object/schedule
Параметры запроса
| sid uuid4 | идентификатор сессии |
| id int | id расписания(Используется только при редактировании) |
| type email|push|sms|telegram|mos_ru|mosobleirc|mvk | тип отправки |
| day 0...32 | 0 - каждый день 32 - последний день месяца |
| time 00:00...23:59 | время |
| personal_account str | лицевой счёт для mos_ru, mosobleirc, email, telegram и sms |
| fraction 0|1 | передача показаний с дробной частью |
| receiver email|login|phone | получатель расписания: - адрес эл.почты для email - логин пользователя для push и telegram - телефон в формате +7XXXXXXXXXX для sms |
| template int | идентификатор шаблона для отравки(1 - по умолчанию) |
| new_template str | новый индивидуальный шаблон(Используется только при template = 0) Описание синтаксиса |
| new_template_title str | новый индивидуальный шаблон заголовка(Используется только при template = 0, type = email) |
| resource int | типы ресурсов, которые необходимо отправлять(Каждый вид ресурса необходимо отправлять в отдельном поле): 1 - Счетчики холодной воды, 2 - Счетчики горячей воды, 3 - Счетчики газа, 7 - Счетчики тепла, 8 - Счетчики электричества, 6 - Краны/реле/состояния, 9 - Датчики, 1000 - Виртуальные |
| delete int | id расписания, которое необходимо удалить |
| manual int | id расписания для тестовой и ручной отправки |
| remove int | id расписания, по которому необходимо удалить переданные показания(только для mos_ru) |
| object_id int | id объекта, в котором необходимо создать расписание(Используется только при создании) |
Генератор HTTPie запроса (документация)
$ http --form POST https://api.saures.ru/1.0/object/schedule -v
Пример
$ http --form POST https://api.saures.ru/1.0/object/schedule sid="92104027-908a-43dd-b18b-b06b918f696d" type="email" day="25" time="9:00" personal_account="1234567890" fraction="1" receiver="newuser@saures.ru" resource="1" object_id="10747" -v
POST /1.0/object/schedule HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 165
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Host: api.saures.ru
User-Agent: HTTPie/0.9.8
sid=92104027-908a-43dd-b18b-b06b918f696d&type=email&day=25&time=9%3A00&personal_account=1234567890&fraction=1&receiver=newuser%40saures.ru&resource=1&object_id=10747
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 42
Content-Type: application/json; charset=utf-8
Strict-Transport-Security: max-age=31536000
{
"data": {},
"errors": [],
"status": "ok"
}