Описание API V2 мобильного приложения Д24 V2

• URL продакшн сервера https://ds24.ru/piedpiper
• URL тестового сервера https://s0.ds24.ru/piedpiper
• URL сервера аутентификациии https://auth.ds24.ru/api/
• URL FS API https://ds24.ru/fs

• З_СП Заявка | принята в работуЗ_СО Заявка | открыта повторно
• З_К Заявка | Комментарий к заявке добавлен
• З_Ф Заявка | Фото к заявке добавлено
• З_Н Заявка | Пользователь назначен исполнителем или ответственным
• О_С Оповещение | Оповещение новое об отключениях
• З_СР Заявки | Срочные заявки - открытие приложения с предустановленным фильтром
• З_НП Заявки | Не принятые в работу - открытие приложения с предустановленным фильтром
• З_КА Заявки | Посылается запрос по статусу аварийной заявки с быстрой кнопкой «Авария устранена»

POST https://auth.ds24.ru/api/user/auth

Параметры запроса:

Параметры ответа

Пример:

//Тело запроса
{
    "login" : "someuser",
    "password" : "12345"
}
 
// Ответ
{
    "ok": true,
    "server": "https://ds24.ru/",
    "login": "someuser",
    "hash": "someuserhash",
    "secret": "someusersecret"
}

POST https://auth.ds24.ru/api/user/reg

Параметры запроса:

Параметры ответа:

Пример:

// Тело запроса
{
    "login" : "9125212573"
}
 
// Ответ
{
    "ok": true,
    "server": "https://ds24.ru/"
}

POST http://server.ru/registration

Аутентификация происходит путем отправки запроса на указанный выше метод. Запрос должен включать:

1. Заголовок с названием «authorization»
2. Тело запроса

Первоначальное значение формируется из двух или трех строк, разделенных двоеточием, окруженным пробелами (пробел двоеточие пробел). есть 3 варианта формирования этого значения:

1. из логина и пароля
   В первой строке указывается слово «login», вторая строка - значение логина пользователя, третья строка - его пароль.
   Пример: login : predeinay : myPassword123
   Такой формат заголовка отправляется при аутентификации по логину и паролю
2. из номера телефона
   В первой строке указывается слово «phone», вторая строка - номер телефона пользователя.
   Пример: phone : 9125212573
   Такой формат заголовка отправляется при аутентификации по телефону с последующей проверкой кода из смс.
3. из номера телефона и проверочного кода из смс
   В первой строке указывается слово «phone», вторая строка - номер телефона пользователя, третья строка - проверочный код.
   Пример: phone : 9125212573 : 12345
   Такой формат заголовка отправляется при проверке кода из смс.

После того, как значение было сформировано, полученную строку нужно закодировать в формате base64.
Пример: строка login : predeinay : myPassword123 превращается в bG9naW4gOiBwcmVkZWluYXkgOiBteVBhc3N3b3JkMTIz

В результате получается такой заголовок:
«authorization»: «bG9naW4gOiBwcmVkZWluYXkgOiBteVBhc3N3b3JkMTIz»

Параметры тела запроса:

Параметры ответа

Пример:

// Тело запроса
{
  "devType"   : "android",
  "pushToken" : "klnefkszkjn5lkawelnflkzsdfk"
}
// Ответ
{
    "ok"          : true,
    "credentials" : true,
    "token"       : "someverysecrettoken123123123"
}

Для получения прав доступа к Д24 необходимо с каждым запросом к системе отправлять заголовок authorization, значением которого должен быть полученный в предыдущем пункте токен авторизации, закодированный в формате base64.
Пример:

• Токен - «someverysecrettoken123123123»
• Заголовок - «authorization»:«c29tZXZlcnlzZWNyZXR0b2tlbjEyMzEyMzEyMw==»

! В это описание не входят запросы на получение адреса сервера и аутентификацию

Состояние запроса передается с помощью кодов состояния http.

• 200 - запрос успешно выполнен.
• 401 - Отказ в авторизации
• 404 - Метод запроса не найден или при выполнении запроса произошла ошибка.

!!! В описании методов ниже описываются параметры и тип только успешного ответа (200), если об ином не сказано в самом описании.

Если тип ответа - Массив и данные не были найдены, то в ответ будет успешен (с кодом 200) и в ответе будет пустой массив.

GET http://server.ru/v2/ref/cnt_list

Тип ответа: Массив.

Параметры ответа (объектов массива)

Пример:

// ответ
[
    {
        "cnt": "Жил. трест Кир. р-на (Спартак)",
        "cnt_id": 10983
    }, 
    {
        "cnt": "Жил. трест Кир. р-на (Центр)",
        "cnt_id": 11041
    }, 
    {
        "cnt": "Жил. трест Кир. р-на ООО РЭУ-25 (Рекорд)",
        "cnt_id": 11081
    }
]

GET http://server.ru/v2/ref/street_list?cnt_id=value

Параметры запроса:

Тип ответа: Массив

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 http://server.ru/v2/ref/street_list?cnt_id=1
*/
 
// Ответ
[
    {
        "street": "Александрова ул"
    }, 
    {
        "street": "Гурьевская ул"
    }, 
    {
        "street": "Инициативная ул"
    }, 
    {
        "street": "Леонова ул"
    }, 
    {
        "street": "Рекордная ул"
    }
]

GET http://server.ru/v2/ref/address_list?cnt_id=value

Параметры запроса:

Тип ответа: Массив с объектами

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 http://server.ru/v2/ref/address_list?cnt_id=11601
*/
 
// Ответ
[
    {
        "address":"Кемерово г, Дружбы ул, дом 1Б",
        "house_id":50136
    },
    {
        "address":"Кемерово г, Дружбы ул, дом 1А",
        "house_id":50135
    },
    ...
]

GET http://server.ru/v2/ref/entrance_list?house_id=value

Параметры запроса:

Тип ответа: Массив c объектами

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 GET http://server.ru/v2/ref/entrance_list?house_id=1251
*/
 
// Ответ
[
    {"entrance":"1"},
    {"entrance":"2"},
    {"entrance":"3"},
    {"entrance":"4"},
    {"entrance":"5"}
]

GET http://server.ru/v2/ref/floor_list?house_id=value

Параметры запроса:

Тип ответа: Массив с объектами

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 http://server.ru/v2/ref/floor_list?house_id=1251
*/
 
// Ответ
[
    {"floor":0},
    {"floor":1},
    {"floor":2},
    {"floor":3},
    {"floor":4},
    {"floor":5}
]

GET http://server.ru/v2/ref/flat_list?house_id=value1&entrance=value2&floor=value3

Параметры запроса:

Тип ответа: Массив с объектами

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 http://server.ru/v2/ref/flat_list?house_id=1251&entrance=2&floor=5
*/
 
// Ответ
[
    {
        "flat": "37",
        "flat_id": 55282,
        "FLAT_TYPE": 1
 
    },
    {
        "flat": "38",
        "flat_id": 55283,
        "FLAT_TYPE": 1
    },
    {
        "flat": "39",
        "flat_id": 55284,
        "FLAT_TYPE": 1
    },
    {
        "flat": "40",
        "flat_id": 55285,
        "FLAT_TYPE": 1
    }
]

GET http://server.ru/v2/ref/type_list

Тип ответа: Массив объектов

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 http://server.ru/v2/ref/type_list
*/
 
// Ответ
[
    {
        "type": "Сантехника",
        "type_id": 23
    }, 
    {
        "type": "Электричество",
        "type_id": 24
    }
]

GET http://server.ru/v2/ref/ess_list?type_ids=value

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 GET http://server.ru/v2/ref/ess_list?type_ids=23:24
*/
 
// Ответ
[
    {
        "ess": "Восстановить освещение в МОП",
        "ess_id": 1561
    },
    {
        "ess": "Восстановить освещение в подвале",
        "ess_id": 4204
    },
    ...
]

GET http://server.ru/v2/ref/ess_list_search?house_id&find

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 GET http://server.ru/v2/ref/ess_list_search?house_id=42243
*/
 
// Ответ
[
    {
        "ess_id": 2923,
        "rtype": " Плановая",
        "type": "Безопасность и СКУД",
        "type_id": 241,
        "ess": "Неисправность ворот / шлагбаума въезд во двор"
    },
    {
        "ess_id": 3078,
        "rtype": " Плановая",
        "type": "Безопасность и СКУД",
        "type_id": 241,
        "ess": "Неисправность ворот паркинга"
    },
    ...
]

GET http://server.ru/v2/ref/emp_list?cnt_id=value

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 GET http://server.ru/v2/ref/emp_list
*/
 
// Ответ
[
    {
        "emp" : "Иванов Иван Иванович",  
        "emp_id" : 23
    },
    {
        "emp" : "Клабуков Александр Витальевич",  
        "emp_id" : 12
    },
    {
        "emp" : "Григорович Сергей Константинович",  
        "emp_id" : 13
    }
]

GET http://server.ru/v2/ref/resp_list?cnt_id=value1&request_id=value2

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 GET http://server.ru/v2/ref/resp_list
*/
 
// Ответ
[
    {
        "resp": "Иванов Иван Иванович",
        "resp_id": 35713
    },
    {
        "resp": "Клабуков Александр Игоревич",
        "resp_id": 35293
    },
    {
        "resp": "Пажитнов Алексей Леонидович",
        "resp_id": 28853
    },
    ...
]

GET http://server.ru/v2/ref/status_list?request_id=value

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 http://server.ru/v2/ref/status_list?request_id=1
*/
 
// Ответ
[
    {
        "status": "Принята в работу",
        "status_id": 2,
        "reasons": 0,
        "need_comment": 0
    },
    {
        "status": "Отложена",
        "status_id": 4,
        "reasons": 14,
        "need_comment": 0
    },
    {
        "status": "Открыта повторно",
        "status_id": 5,
        "reasons": 3,
        "need_comment": 0
    },
    {
        "status": "Выполнена",
        "status_id": 3,
        "reasons": 0,
        "need_comment": 1
    }
]

DEPRECATED GET http://server.ru/v2/ref/status_tree_list

Тип ответа: Массив объектов

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 http://server.ru/v2/ref/status_tree_list
*/
 
// Ответ
[
    {
        "status": "Открытые заявки",
        "status_id": "1:65:70:5:2:23:4"
    },
    {
        "status": "...Новые",
        "status_id": "1:65:70:5"
    },
    {
        "status": ".....|Зарегистрирована",
        "status_id": "1"
    }
]

GET http://server.ru/v2/ref/req_type_list

Тип ответа: Массив объектов

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 http://server.ru/v2/ref/req_type_list
*/
 
// Ответ
[
    {
        "rtype_id": 1,
        "rtype": "Обычные"
    },
    {
        "rtype_id": 2,
        "rtype": "Аварийные"
    },
    {
        "rtype_id": 3,
        "rtype": "Платные"
    }
]

GET http://server.ru/v2/ref/status_reason_list?status_id=value

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива)

Пример:

//Запрос
/*
 http://server.ru/v2/ref/status_reason_list?status_id=25
*/
 
// Ответ
[
    {
        "reason_id": 7164,
        "reason": "Сделал сам"
    },
    {
        "reason_id": 7,
        "reason": "заявитель доволен"
    },
    {
        "reason_id": 8,
        "reason": "невозможно проверить"
    },
    {
        "reason_id": 9,
        "reason": "автоматически"
    },
    ...
]

GET http://server.ru/v2/ref/request_refuse_reason_list?is_emergency=value

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива)

Пример:

//Запрос для аварийной заявки
/*
http://server.ru/v2/ref/request_refuse_reason_list?is_emergency=1
*/
 
// Ответ
[
    {
        "reject_reason": "Сегодня не работаю",
        "refuse_id": "5"
    },
    {
        "reject_reason": "До конца смены менее 30 минут",
        "refuse_id": "6"
    },
    {
        "reject_reason": "Не мой профиль",
        "refuse_id": "7"
    },
    {
        "reject_reason": "Не аварийный случай",
        "refuse_id": "8"
    }
]
 
//Запрос для НЕ аварийной заявки
/*
http://server.ru/v2/ref/request_refuse_reason_list?is_emergency=0
*/
 
//Ответ
[
    {
        "reject_reason": "Не мой профиль",
        "refuse_id": "1"
    },
    {
        "reject_reason": "Не мой участок",
        "refuse_id": "2"
    },
    {
        "reject_reason": "Я на больничном",
        "refuse_id": "3"
    },
    {
        "reject_reason": "У меня выходной / отпуск",
        "refuse_id": "4"
    }
]

POST http://server.ru/v2/oi

Параметры тела запроса:

Описание возможных значений параметров:

Тип оповещения:

• Утечка У
• Опрессовка Р
• Отключение услуг О
• Подвоз воды В
• Подпоры П
• Прочее Д
• Акция А

Услуги:

• ХВС Х
• ГВС Г
• Канализация К
• Отопление О
• Электричество Э
• Газ З
• Лифт Л

Зона отвественности:

• Управляющая компания У
• Ресурсоснабжающая организация Р
• Неизвестно Н

Причина (одиночный выбор):

• Авария А
• Плановые работы П
• Задолженность за оплату З
• Неизвестно Н

Объект

• Несколько домов М
• Весь дом Д
• Подъезд П
• Стояк С
• Несколько квартир К
• Неизвестно Н

Тип ответа: Объект

Параметры ответа

Примечания:

Если дома находятся в разных УК, то для каждой УК будет создано свое оповещение. В этом случае affected_rows будет больше 1 а info_id идентификатором последнего созданного оповещения.

Пример:

//Тело запроса
{
    "house_ids": "34021:42243",
    "type": "О",
    "start_at": "22.01.2016 10:40",
    "end_at": "22.01.2016 18:30",
    "service_list": "Э:О",
    "resp": "Р",
    "reason": "П",
    "what": "М",
    "note": "Тест создания"
}
 
// Ответ
{
    "affected_rows": 1,
    "info_id": 139284
}

PUT http://server.ru/v2/oi/:info_id

Переменные URL:

Параметры тела запроса:

Тип ответа: Объект

Параметры ответа:

Пример:

//Запрос
/*
http://server.ru/v2/oi/139245
*/
 
//Тело запроса
{
    "status": "A",
    "comment": "Комментарий для теста"
}
 
// Ответ
{
    "affected_rows": 2
}

GET http://server.ru/v2/oi?cnt_id=value1&status=value2&house_id=value3&type=value4&service_list=value5&custom_filter=value6&start=value7&count=value8

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива):

Параметры массива object_list (список домов оповещения):

Пример:

//запрос
 
http://server.ru/v2/oi?start=1&count=50
 
// Ответ
[
    {
        "info_id": 139284,
        "type": "О",
        "type_str": "Отключение ",
        "start_at": "22.01.2016 10:40",
        "end_at": "22.01.2016 18:30",
        "created_at": "15.11.2021 16:32",
        "note": "Тест создания",
        "status": "А",
        "status_str": "Активно",
        "service_list": "О:Э",
        "all_flags": "ННДДННН",
        "service_list_str": "Отопление, Электричество",
        "object_list": [
            {
                "street": "Апрельская ул",
                "houses": "15"
            },
            {
                "street": "Ленина ул",
                "houses": "1"
            }
        ]
    },
    ...
]

GET http://server.ru/v2/oi/:info_id

переменные URL:

Тип ответа: Объект

Параметры ответа Параметры ответа:

Пример:

//Запрос
/*
 http://server.ru/v2/oi/66776
*/
 
// Ответ
{
    "info_id": 66776,
    "type": "О",
    "type_str": "Отключение ",
    "start_at": "22.01.2016 08:40",
    "end_at": "22.01.2016 16:30",
    "created_at": "21.01.2016 09:19",
    "note": "плановые работы на подстанции 292 отключение 2 секции шин.",
    "status": "З",
    "status_str": "Закрыто",
    "service_list": "Э",
    "service_list_str": "Электричество",
    "reason": "П",
    "reason_str": "Плановые работы",
    "resp": "Р",
    "resp_str": "РСО",
    "svc_id": 6,
    "svc": "Электросети"
}

GET http://server.ru/v2/oi/:info_id/houses

переменные URL:

Тип ответа: Массив объектов

Параметры ответа (объектов массива):

Пример:

//Запрос
/*
http://server.ru/v2/oi/139246/houses
*/
 
// Ответ
[
    {
        "street": "Апрельская ул",
        "houses": "15"
    },
    {
        "street": "Ленина ул",
        "houses": "1"
    }
]

GET http://server.ru/v2/oi/:info_id/feed?start=value1&count=value2

переменные URL:

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа

Пример:

//Запрос
/*
http://server.ru/v2/oi/66776/feed?start=1&count=50
*/
 
// Ответ
[
    {
        "created_at": "29.01.2016 23:00",
        "type": 1,
        "note": "Статус оповещения изменился с \"Активное\" на \"Архивное\".\r\n",
        "created_by": "Системный пользователь"
    },
    {
        "created_at": "23.01.2016 09:28",
        "type": 1,
        "note": "Статус оповещения изменился с \"Плановое\" на \"Активное\".\r\n",
        "created_by": "Лукашевич Светлана"
    }
]

GET https://server.ru/v2/meter?start=value1&count=value2&cnt_id=value3&house_id=value4&flat=value5&term_ids=value6

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива):

Примеры:

//Запрос
 
/*
  https://server.ru/meter?/v2/meter?start=1&count=3&cnt_id=10401&house_id=40783&flat=3&term_ids=1:5
*/
 
//Ответ
 
[
    {
        "description": "ХВС",
        "house": "Курган г, Бурова-Петрова ул, дом 78",
        "flat": "3",
        "value": null,
        "date": null,
        "prev_value": ".087",
        "prev_date": "25.06.2021",
        "meter_id": 4075904,
        "meter_id_ext": "3672939",
        "term": "Холодная вода"
    }
]

GET https://server.ru/v2/meter/flat_list?house_id=value

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива):

Примеры:

//Запрос
 
/*
 https://server.ru/meter/flat_list?house_id=40783
*/
 
//Ответ
[
    {
        "flat": "1"
    },
    {
        "flat": "2"
    },
    {
        "flat": "3"
    },
    {
        "flat": "4"
    },
    {
        "flat": "5"
    },
    {
        "flat": "6"
    }
]

GET https://server.ru/v2/meter/term_list

Тип ответа: Массив объектов

Параметры ответа (объектов массива):

Примеры:

//Запрос
 
/*
 https://server.ru/meter/term_list
*/
 
//Ответ
 
[
    {
        "term_id": 6,
        "term": "Газ"
    },
    {
        "term_id": 5,
        "term": "Горячая вода"
    },
    {
        "term_id": 7,
        "term": "Отопление"
    },
    {
        "term_id": 1,
        "term": "Холодная вода"
    },
    {
        "term_id": 3,
        "term": "Электроэнергия"
    },
    {
        "term_id": 221,
        "term": "Электроэнергия ночь"
    }
]

PUT https://server.ru/v2/meter/:meter_id

Переменные URL:

Тело запроса:

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 
/*
  https://server.ru/meter/121281
*/
 
// Тело запроса
{
    "value": "150",
    "image_url" : "https://ds24.ru/fs/static/2017/08/14/some_test.jpg",
    "image_name" : "image"
}
 
//Ответ
 
{
    "affected_rows": 2
}

GET https://server.ru/v2/contact?start=value1&count=value2&cnt_id=value3&phone=value4&house_id=value5&flat_id=value6&floor=value7&entrance=value8

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива):

Примеры:

//Запрос
 
/*
 https://server.ru/contact?cnt_id=10401&house_id=40783&start=1&count=5
*/
 
//Ответ
[
    {
        "phone": "9223223223",
        "house": "Курган г, Бурова-Петрова ул, дом 78",
        "flat": "тест-24",
        "entrance": "2",
        "floor": 3
    },
    {
        "phone": "9223223224",
        "house": "Курган г, Бурова-Петрова ул, дом 78",
        "flat": "тест-25",
        "entrance": null,
        "floor": null
    },
    ...
]

POST https://server.ru/v2/request

Тело запроса:

Тип ответа: Объект

Параметры ответа:

Примеры:

//Тело запроса
 
{
    "house_id" : 34021,
    "ess_id" : 1533,
    "type_id" : 23,
    "note" : "Тест ppostman",
    "contphone" : "9125212573",
    "flat" : "123",
    "entr" : "1",
    "floor" : "9",
    "email" : "predeinay@gmail.com",
    "flat_type": 1
}
 
//Ответ
 
{
    "request_id": 1298371
}

PUT https://server.ru/v2/request/:request_id

Переменные URL:

Тело запроса:

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 
/*
   https://server.ru/v2/request/1298371
*/
 
// Тело запроса
 
{
    "status_id"   : 2,
    "reason_id"   : 9,
    "emp_id"      : 123,
    "resp_id"     : 123,
    "deadline_at" : "01.01.2017",
    "tag_ids"     : "1,2,3,4,5",
    "emp_note"    : "типа скрытый от операторов текст",
    "comment"     : "Типа коммент от исполнителя",
    "image_url"   : "https://ds24.ru/fs/static/2017/08/14/some_test.jpg",
    "image_name"  : "some test",
    "appointed_at": null,
    "local_at"    : "12.12.2020 12:12",
    "material_price" : 333,
    "price": 100.2,
    "what_was_done": "что-то сделано",
    "paid": 100.3
}
 
//Ответ
{
    "affected_rows": 3
}

GET https://server.ru/v2/request?start&count&cnt_id&street&house_id&flat_id&type_id&type_ids&ess_id&ess_ids&emp_id&resp_id&status_ids&rtype_id &rtype_ids&request_id&date_start&date_end&keywords&custom_filter&is_only_my&custom_order&house_ids&flat_ids&emp_ids&resp_ids&search_phone &house_group_ids&period_exec&exec_time_start&exec_time_end

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива):

Примеры:

//Запрос
 
/*
 https://server.ru/v2/request/?start=1&count=5
*/
 
//Ответ
 
[
    {
        "rn": 1,
        "request_id": 1298931,
        "flag_emergency": "Н",
        "note": "Химчистка домашнего текстиля",
        "house": "Луначарского ул, дом 240",
        "flat": "кв 100",
        "status": "Зарегистрирована",
        "created_at": "17.03.2022 15:26",
        "updated_at": null,
        "execution_time": "21.03.2022 15:26",
        "price": null,
        "material_price": null,
        "tags": "<span style=\"background-color:#FFA366\">сайт</span>",
        "uploads_count": 0,
        "appointed_str": null,
        "appointed_at": null,
        "emp": null,
        "deadline_str": -14,
        "reason": null,
        "status_id": 1,
        "emp_id": null,
        "local_at": null,
        "house_id": 54696,
        "flat_type": 1,
        "flat_num": "100",
        "contphone": "9826171613",
        "autophone": null,
        "ess_id": 3263,
        "type_id": 21
    },
    {
        "rn": 2,
        "request_id": 1298930,
        "flag_emergency": "Н",
        "note": "Химчистка домашнего текстиля",
        "house": "Луначарского ул, дом 240",
        "flat": "кв 100",
        "status": "Зарегистрирована",
        "created_at": "17.03.2022 15:26",
        "updated_at": "31.03.2022 13:28",
        "execution_time": "21.03.2022 15:26",
        "price": null,
        "material_price": null,
        "tags": "<span style=\"background-color:#FFA366\">сайт</span>",
        "uploads_count": 0,
        "appointed_str": null,
        "appointed_at": null,
        "emp": "dev",
        "deadline_str": -14,
        "reason": null,
        "status_id": 1,
        "emp_id": 35753,
        "local_at": null,
        "house_id": 54696,
        "flat_type": 1,
        "flat_num": "100",
        "contphone": "9826171613",
        "autophone": null,
        "ess_id": 3263,
        "type_id": 21
    },
    ...
]

GET https://server.ru/v2/request/tag_list?request_id&cnt_id

Параметры запроса:

Параметры ответа:

Пример:

// запрос
 
/*
  https://server.ru/v2/request/tag_list
*/
 
// ответ:
 
[
    {
        "tag_id": 8,
        "title": "ГЖИ",
        "color": "#E9DFFA",
        "is_set": "N"
    },
    {
        "tag_id": 841,
        "title": "Чат",
        "color": "#FF00FF",
        "is_set": "N"
    },
    ...
]

GET https://server.ru/v2/request/:request_id

Переменные URL:

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 
/*
 https://server.ru/v2/request/1298309
*/
 
//Ответ
 
{
    "request_id": 1298309,
    "rtype": "Плановая",
    "flag_emergency": "Н",
    "note": "Не работает освещение в пом 13. Этаж 1",
    "house": "Бакинских комиссаров, дом 3",
    "flat": null,
    "status": "Закрыта",
    "reason": "принудительно модератором",
    "created_at": "28.10.2021 11:02",
    "updated_at": "01.11.2021 15:15",
    "floor": null,
    "entr": null,
    "autophone": null,
    "contphone": null,
    "email": null,
    "tags": "<span style=\"background-color:#8BC4F7\">метка</span>",
    "type": "Электричество",
    "ess": "Восстановить освещение в МОП",
    "emp": null,
    "resp": "Предеин Анатолий",
    "created_by": "Беллендир Наталья",
    "deadline_at": "01.11.2021",
    "emp_note": null,
    "appointed_at": null,
    "emp_phone": null,
    "resp_phone": "9616161616",
    "status_id": 25,
    "reason_id": 4884,
    "type_id": 24,
    "ess_id": 1561,
    "emp_id": null,
    "resp_id": 33,
    "cnt_id": 10401,
    "deadline_str": null,
    "price": null,
    "paid": null,
    "material_price": null,
    "is_paid": "Н",
    "appointed_str": null,
    "uploads_count": 0,
    "is_local_need": "Н",
    "local_at": null,
    "what_was_done": null,
    "cnt_callback_phone": "3522222888",
    "check_id": null
}

GET https://server.ru/v2/request/custom/new

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 
/*
 https://server.ru/v2/request/custom/new
*/
 
//Ответ
{
    "request_count": 0,
    "request_emerg_count": 0
}

POST https://server.ru/v2/request/custom/new/apply

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 https://server.ru/v2/request/custom/new/apply
/*
 https://server.ru/v2/request
*/
 
//Ответ
 
{
    "request_count": 0
}

POST https://server.ru/v2/request/:request_id/refuse

Переменные URL:

Тело запроса:

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 
/*
 https://server.ru/v2/request/1298309/refuse
*/
 
//Тело запроса
 
{
    "refuse_id": "2"
}
 
//Ответ
 
{
    "request_id": 1298309
}

POST https://server.ru/v2/request/:request_id/flashback

Переменные URL:

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 
/*
 https://server.ru/v2/request/1298309/flashback
*/
 
//Ответ
 
{
    "request_id": 1298309
}

POST https://server.ru/v2/request/:request_id/tocurrentrepair

Переменные URL

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 
/*
 https://server.ru/v2/request/1298309/tocurrentrepair
*/
 
//Ответ
 
{
    "request_count": 0 
}

POST https://server.ru/v2/request/:request_id/feed/:id

Переменные URL:

Тело запроса:

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 
/*
 https://server.ru/v2/request/:1298309/feed/124657
*/
 
//Тело запроса:
 
{
    "mtype": 0,
    "webhook_flag": "Д"
}
 
//Ответ
{
    "affected_rows": 1
}

GET https://server.ru/v2/request/:request_id/feed

Переменные URL:

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива):

Примеры:

//Запрос
 
/*
 https://server.ru/v2/request/964825/feed
*/
 
//Ответ
[
    {
        "created_at":"17.07.2017 18:58",
        "type":1,
        "note":"Смена исполнителя  ->> Башкирев Эдуард Олегович\r\n...",
        "created_by":"Журавлева Марина Сергеевна",
        "id": 12345,
        "flag_webhook": "Д",
        "creator_type": 0
    },
    {
        "created_at":"17.07.2017 18:03",
        "type":3,
        "note":"https://pultdoma.ru/front/uploads/img/17-07-2017/3196190_549_2_596c99ab73ae0.jpg",
        "created_by":"Пользователь личного кабинета",
        "id": 123456,
        "flag_webhook": "Н",
        "creator_type": 0
    }
]

POST https://server.ru/v2/request/:request_id/add_images

Переменные URL:

Параметры запроса:

Параметры ответа:

Примеры:

//Запрос
 
/*
 https://server.ru/v2/request/964825/add_images
*/
 
// тело запроса
 
{
    "images": [
        {
            "image_name": "996780_img.jpg",
            "image_url": "https://ds24.ru/fs/static/2021/11/25/996780_img.jpg"
        },
        {
            "image_name": "some_test.jpg",
            "image_url": "https://ds24.ru/fs/static/2017/08/14/some_test.jpg"
        },
        {
            "image_name": "ios_img",
            "image_url": "https://ds24.ru/fs/static/2021/12/16/feed_img_NzE0.jpg"
        }
    ]
}
 
//Ответ
{
    "affected_rows": 3
}

GET https://server.ru/v2/push/?start&count

Параметры запроса:

Тип ответа: Массив объектов

Параметры ответа (объектов массива):

Примеры:

//Запрос
 
/*
 https://server.ru/v2/push/?start=1&count=2
*/
 
//Ответ
 
[
    {
        "rn": 1,
        "push_id": 25536,
        "message": "blabla",
        "object_id": 321,
        "object_type": "З_Н",
        "status": 1,
        "type_description": "Новая заявка",
        "created_at": "09.12.2021 14:33"
    },
    {
        "rn": 2,
        "push_id": 25535,
        "message": "Комментарий к #1298471: комментарий",
        "object_id": 1298471,
        "object_type": "З_К",
        "status": 0,
        "type_description": "Новый комментарий к заявке",
        "created_at": "09.12.2021 14:33"
    }
]

GET https://server.ru/v2/push/:push_id

Переменные URL:

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 
/*
https://server.ru/v2/push/25536
*/
 
//Ответ
 
{
    "push_id": 25536,
    "message": "blabla",
    "object_id": 321,
    "object_type": "З_Н",
    "status": 2,
    "type_description": "Новая заявка",
    "created_at": "22.12.2021 10:37"
}

GET https://server.ru/v2/profile/detail

Тип ответа: Объект

Параметры ответа:

Примеры:

//Запрос
 
/*
 https://server.ru/v2/profile/detail
*/
 
//Ответ
 
{
    "username": "Предеин Анатолий",
    "can_close_request": true,
    "can_access_meters": true,
    "can_access_contacts": true,
    "account_name": "Не активен",
    "phone": "9898004862",
    "emp_id": 22055,
    "not_read_push_count": 10,
    "can_comment_to_ext_system": 1,  // варианты 0/1
    "token_id": 12345,
    "can_access_material_price": true
}

GET https://server.ru/v2/profile/settings_push

Тип ответа: Массив объектов

Параметры ответа (объектов массива):

Примеры:

//Запрос
 
/*
 https://server.ru/v2/profile/settings_push
*/
 
//Ответ
 
[
    {
        "descr": "Назначен исп/отв в заявке",
        "value": "З_Н",
        "is_set": "1"
    },
    {
        "descr": "Добавлен комментарий к заявке",
        "value": "З_К",
        "is_set": "1"
    },
    {
        "descr": "Добавлен файл к заявке",
        "value": "З_Ф",
        "is_set": "1"
    },
    ...
]

POST https://server.ru/v2/profile/update

Тело запроса:

Тип ответа: Объект

Параметры ответа:

Примеры:

//Тело запроса
 
{
    "fcm_token": "NEWTOKEN123",
    "push_config": "З_Ф:З_Н:З_К",
    "start_app" : "im started!!"
}
//Ответ
 
{
    "affected_rows": 3
}

POST https://ds24.ru/fs

// Загрузка фото test.jpg на ds24.ru/fs
curl -v -H "filename: test.jpg" -X POST --data-binary "@test.jpg" https://ds24.ru/fs/
Ответ:
{
    "ok":true,
    "file":"https://ds24.ru/fs/static/2017/08/11/test_OTA4.jpg",
    "thumbnail":"https://ds24.ru/fs/static/2017/08/11/test_OTA4_th.jpg"
}

GET https://server.ru/v2/test/push?message&object_id&object_type

Параметры запроса:

Примеры:

// Запрос
/*
 https://server.ru/v2/test/push?message=blablabla&object_id=123&object_type=З_Н
*/
 
//Ответ
 
{ 1 }

GET https://server.ru/v2/checklist?start&count&statuses&employee_id&cnt_id&house_id

Параметры запроса:

Тип ответа: Массив с объектами

Параметры ответа (объектов массива):

Примеры:

// Запрос
/*
 https://server.ru/v2/checklist
*/
 
//Ответ
 
[
    {
        "check_id": 6849,
        "name": "PAU_чеклист 1",
        "check_on_tz": "2021-10-17T04:00:00.000Z",
        "status": "INWORK",
        "days_count": 2,
        "house_text": "Бурова-Петрова ул, дом 78",
        "houses_count": 5,
        "username": "Предеин Анатолий",
        "employee_id": 33,
        "count_all": 20
    }
]

GET https://server.ru/v2/checklist/:check_id

Переменные URL:

Тип ответа: Объект

Параметры ответа:

Примеры:

// Запрос
/*
 https://server.ru/v2/checklist/6849
*/
 
//Ответ
 
{
    "check_id": 6849,
    "name": "PAU_чеклист 1",
    "note": "описание PAU_чеклист 1",
    "check_on_tz": "2021-10-17T04:00:00.000Z",
    "username": "Предеин Анатолий",
    "success_count": 1,
    "with_violations_count": 1,
    "all_works_count": 5,
    "requests_count": 1,
    "status": "INWORK",
    "employee_id": 33
}

GET https://server.ru/v2/checklist/:check_id/house

Переменные URL

Тип ответа: Массив с объектами

Параметры ответа

Примеры:

// Запрос
/*
 https://server.ru/v2/checklist/6849/house
*/
 
//Ответ
 
[
    {
        "house_id": 40783,
        "house_text": "Бурова-Петрова ул, 78"
    },
    ...
]

GET https://server.ru/v2/checklist/:check_id/work

Переменные URL

Тип ответа: Массив с объектами

Параметры ответа

Примеры:

// Запрос
/*
 https://server.ru/v2/checklist/6849/work
*/
 
//Ответ
 
[
    {
        "check_work_id": 23365,
        "name": "PAU_работа 1",
        "work_group_name": "PAU_группа 1",
        "work_group_id": 101,
        "check_id": 6849,
        "status": 0
    },
    {
        "check_work_id": 23366,
        "name": "PAU_работа 2",
        "work_group_name": "PAU_группа 1",
        "work_group_id": 101,
        "check_id": 6849,
        "status": 1
    },
    {
        "check_work_id": 23367,
        "name": "PAU_работы 3",
        "work_group_name": null,
        "work_group_id": null,
        "check_id": 6849,
        "status": 0
    },
    {
        "check_work_id": 23368,
        "name": "PAU_работа 4",
        "work_group_name": null,
        "work_group_id": null,
        "check_id": 6849,
        "status": 2
    }
]

GET https://server.ru/v2/checklist/work/:check_work_id

Переменные URL

Тип ответа: Объект

Параметры ответа

Примеры:

// Запрос
/*
 https://server.ru/v2/checklist/work/23365
*/
 
//Ответ
 
{
    "check_work_id": 23365,
    "check_id": 6849,
    "check_status": "INWORK",
    "status": 0,
    "name": "PAU_работа 1",
    "note": "описание работы 1",
    "criteria": "- все ли хорошо 1\r\n- все ли хорошо 2\r\n?",
    "ess_id" : 123,
    "ess" : "Какая то причина обращения для создания заявки",
    "type_id: 24
}

GET https://server.ru/v2/checklist/work/:check_work_id/feed

Переменные URL

Тип ответа: Массив с объектами

Параметры ответа

Описание типов элемента ленты (type):

Примеры:

// Запрос
/*
 https://server.ru/v2/checklist/work/23410/feed
*/
 
//Ответ
 
[
    {
        "note": "https://ds24.ru/fs/static/2021/11/25/996780_img.jpg",
        "type": 3,
        "check_work_id": 23410,
        "created_on_tz": "2021-12-06T13:08:11.142Z",
        "created_by": "dev",
        "flag_webhook": "N"
    },
    {
        "note": "Были нарушения",
        "type": 0,
        "check_work_id": 23410,
        "created_on_tz": "2021-12-06T13:00:55.673Z",
        "created_by": "dev",
        "flag_webhook": "N"
    },
    ...
]

POST https://server.ru/v2/checklist/:check_id/start

Переменные URL

Тип ответа: Объект

Параметры ответа

Примеры:

// Запрос
/*
 https://server.ru/v2/checklist/6882/start
*/
 
//Ответ
 
{
    "affected_rows": 1
}

POST https://server.ru/v2/checklist/:check_id/finish

Переменные URL

Тип ответа: Объект

Параметры ответа

Примеры:

// Запрос
/*
 https://server.ru/v2/checklist/6882/finish
*/
 
//Ответ
 
{
    "affected_rows": 1
}

POST https://server.ru/v2/checklist/work/:check_work_id

Переменные URL

Тело запроса:

Тип ответа: Объект

Параметры ответа

Примеры:

// Запрос
/*
 https://server.ru/v2/checklist/work/23410
*/
 
//тело запроса
 
{
    "status": 3,
    "comment": "тест изменения статуса с комментарием"
}
 
//Ответ
 
{
    "affected_rows": 2
}

POST https://server.ru/v2/checklist/work/:check_work_id/feed

Переменные URL

Тело запроса:

Тип ответа: Объект

Параметры ответа

Примеры:

// Запрос
/*
 https://server.ru/v2/checklist/work/23410/feed
*/
 
//тело запроса
 
{
    "comment": null,   // если поле null, то можно не указывать его в теле запроса
    "image_name": "some_test.jpg",
    "image_url": "https://ds24.ru/fs/static/2017/08/14/some_test.jpg"
}
 
//Ответ
 
{
    "affected_rows": 1
}