Различия
Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия Следующая версия Следующая версия справа и слева | ||
d24:develop:v2:backend:v2 [2022/04/04 10:28] klabukovai [Константы] |
d24:develop:v2:backend:v2 [2024/03/29 05:49] anton |
||
---|---|---|---|
Строка 9: | Строка 9: | ||
===== Виды push-уведомлений ===== | ===== Виды push-уведомлений ===== | ||
- | * З_СП Заявка | принята в работуЗ_СО Заявка | открыта повторно | + | * З_СП Заявка | принята в работу (переход в заявку с ид object_id при наличии) |
- | * З_К Заявка | Комментарий к заявке добавлен | + | * З_СО Заявка | открыта повторно (переход в заявку с ид object_id при наличии) |
- | * З_Ф Заявка | Фото к заявке добавлено | + | * З_К Заявка | Комментарий к заявке добавлен (переход в заявку с ид object_id при наличии) |
- | * З_Н Заявка | Пользователь назначен исполнителем или ответственным | + | * З_Ф Заявка | Фото к заявке добавлено (переход в заявку с ид object_id при наличии) |
- | * О_С Оповещение | Оповещение новое об отключениях | + | * З_Н Заявка | Пользователь назначен исполнителем или ответственным (переход в заявку с ид object_id при наличии) |
- | * З_СР Заявки | Срочные заявки - открытие приложения с предустановленным фильтром | + | * О_С Оповещение | Оповещение новое об отключениях (переход в оповещение с ид object_id при наличии) |
- | * З_НП Заявки | Не принятые в работу - открытие приложения с предустановленным фильтром | + | * З_СР Заявки | Срочные заявки - открытие приложения с предустановленным фильтром ?????????????? DEPRECATED |
- | * З_КА Заявки | Посылается запрос по статусу аварийной заявки с быстрой кнопкой «Авария устранена» | + | * З_НП Заявки | Не принятые в работу - открытие приложения с предустановленным фильтром (например "1 заявок требуют вашего внимания") (фильтры - Мои + Непринятые в работу) |
+ | * З_КА Заявки | Посылается запрос по статусу аварийной заявки с быстрой кнопкой «Авария устранена» (переход в заявку с ид object_id при наличии) | ||
+ | * Ч_Н Чек-лист | Пользователь назначен проверяющим (переход в чек-лист с ид object_id при наличии) | ||
+ | * Ч_НП Чек-лист | Находящиеся в работе чек листы | ||
+ | * Без вида / с видом не определнным - открытие текста пуша в модалке | ||
+ | apple | ||
+ | <code> | ||
+ | let push = { | ||
+ | aps : { | ||
+ | sound : "default", | ||
+ | alert : { | ||
+ | title : "Диспетчер24", | ||
+ | body : MESSAGE, | ||
+ | object_id : OBJECT_ID, | ||
+ | object : OBJECT_TYPE, | ||
+ | msg_id : PUSH_ID | ||
+ | } | ||
+ | } | ||
+ | }; | ||
+ | |||
+ | if (OBJECT_TYPE == 'З_Н'){ | ||
+ | Object.assign(push['aps'], {category : "RequestStatus"}); | ||
+ | } | ||
+ | </code> | ||
===== Константы ===== | ===== Константы ===== | ||
Строка 46: | Строка 69: | ||
|IMPOSSIBLE| Невозможно выполнить| | |IMPOSSIBLE| Невозможно выполнить| | ||
|FAILED| Не выполнено| | |FAILED| Не выполнено| | ||
+ | |FORCIBLY|Принудительно завершено| | ||
+ | |||
+ | === статусы работ чек-листа === | ||
+ | ^Код статуса^описание^ | ||
+ | |0|в ожидании выполнения| | ||
+ | |1|успешно выполнено | | ||
+ | |2| есть нарушения | | ||
+ | |3| невозможно выполнить | | ||
===== Определение адреса сервера ===== | ===== Определение адреса сервера ===== | ||
Строка 132: | Строка 163: | ||
Параметры тела запроса: | Параметры тела запроса: | ||
^ Название ^ Тип ^ Обязательно ^ Описание ^ | ^ Название ^ Тип ^ Обязательно ^ Описание ^ | ||
- | | devType | string | да | android / ios Тип устройства, чтобы система понимала как отправлять push-уведомления т.п.| | + | | devType | string | да | android / ios Тип устройства, если интеграция с системой то указывать необходимо int| |
|pushToken | string | да | Токен для push-уведомлений | | |pushToken | string | да | Токен для push-уведомлений | | ||
Строка 146: | Строка 177: | ||
// Тело запроса | // Тело запроса | ||
{ | { | ||
- | "devType" : "android", | + | "devType" : "int", |
- | "pushToken" : "klnefkszkjn5lkawelnflkzsdfk" | + | "pushToken" : "" |
} | } | ||
+ | // в pushToken необходимо писать уникальный тект, например "uk_pravii_bereg" | ||
// Ответ | // Ответ | ||
{ | { | ||
Строка 188: | Строка 220: | ||
| cnt | string | да | Название юридического лица | | | cnt | string | да | Название юридического лица | | ||
| cnt_id | number | да | Идентификатор юр. лица в базе данных Д24 | | | cnt_id | number | да | Идентификатор юр. лица в базе данных Д24 | | ||
+ | | account_id | number | да | ИД аккаунта | | ||
+ | | callback_phone | string | да | Тел. юр. лица | | ||
+ | | support_phone | string | да | Тел. поддержки юр. лица | | ||
**Пример:** | **Пример:** | ||
Строка 195: | Строка 230: | ||
{ | { | ||
"cnt": "Жил. трест Кир. р-на (Спартак)", | "cnt": "Жил. трест Кир. р-на (Спартак)", | ||
- | "cnt_id": 10983 | + | "cnt_id": 10983, |
+ | "account_id": 2621, | ||
+ | "callback_phone": "283-05-21", | ||
+ | "support_phone": "328-7100" | ||
}, | }, | ||
{ | { | ||
"cnt": "Жил. трест Кир. р-на (Центр)", | "cnt": "Жил. трест Кир. р-на (Центр)", | ||
- | "cnt_id": 11041 | + | "cnt_id": 11041, |
+ | "account_id": 2621, | ||
+ | "callback_phone": "283-05-21", | ||
+ | "support_phone": "328-7100" | ||
}, | }, | ||
{ | { | ||
"cnt": "Жил. трест Кир. р-на ООО РЭУ-25 (Рекорд)", | "cnt": "Жил. трест Кир. р-на ООО РЭУ-25 (Рекорд)", | ||
- | "cnt_id": 11081 | + | "cnt_id": 11081, |
+ | "account_id": 2621, | ||
+ | "callback_phone": "283-05-21", | ||
+ | "support_phone": "328-7100" | ||
+ | } | ||
+ | ] | ||
+ | </code> | ||
+ | |||
+ | |||
+ | ==== Получение списка доступных городов ==== | ||
+ | GET http://server.ru/v2/ref/city_list?cnt_id=value | ||
+ | |||
+ | Параметры запроса: | ||
+ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
+ | |cnt_id | number | нет | Идентификатор юр. лица в базе данных Д24 | | ||
+ | |||
+ | Тип ответа: Массив. | ||
+ | |||
+ | Параметры ответа (объектов массива) | ||
+ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
+ | | city_text | string | да | Название города | | ||
+ | |||
+ | **Пример:** | ||
+ | <code javascript> | ||
+ | // ответ | ||
+ | [ | ||
+ | { | ||
+ | city_text:"Курган г" | ||
} | } | ||
] | ] | ||
Строка 209: | Строка 277: | ||
==== Получение списка доступных улиц / населенных пунктов ==== | ==== Получение списка доступных улиц / населенных пунктов ==== | ||
- | GET http://server.ru/v2/ref/street_list?cnt_id=value | + | GET http://server.ru/v2/ref/street_list?cnt_id=value&city_text=value |
Параметры запроса: | Параметры запроса: | ||
^ Название ^ Тип ^ Обязательно ^ Описание^ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
|cnt_id | number | да | Идентификатор юр. лица в базе данных Д24 | | |cnt_id | number | да | Идентификатор юр. лица в базе данных Д24 | | ||
+ | |city_text | strng | нет | Название города | | ||
+ | |||
Тип ответа: Массив | Тип ответа: Массив | ||
Строка 255: | Строка 325: | ||
^ Название ^ Тип ^ Обязательно ^ Описание^ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
| cnt_id | number | нет | идентификатор юр. лица в системе. Если при запросе отсутствует, то в ответе будут все улицы/нас. пункты по доступным юр. лицам| | | cnt_id | number | нет | идентификатор юр. лица в системе. Если при запросе отсутствует, то в ответе будут все улицы/нас. пункты по доступным юр. лицам| | ||
+ | | city_text | string | нет | название города| | ||
+ | | street_text | string | нет | название улицы| | ||
Тип ответа: Массив с объектами | Тип ответа: Массив с объектами | ||
Строка 262: | Строка 334: | ||
| address | string | да | полный адрес дома| | | address | string | да | полный адрес дома| | ||
| house_id | number | да | идентификатор дома в системе| | | house_id | number | да | идентификатор дома в системе| | ||
+ | | fias | string | нет | идентификатор fias| | ||
+ | | flag_active | string | да | активен ли дом Д/Н| | ||
+ | | city_text | string | да | город дома| | ||
+ | | street_text | string | нет | улица дома| | ||
+ | | house_num | string | да | номер дома| | ||
+ | | corp | string | нет | корпус дома| | ||
+ | | struct | string | нет | строение дома| | ||
+ | | is_flat | string | нет | разрешено ли создавать квартиры| | ||
+ | | is_office | string | нет | разрешено ли создавать офисы| | ||
+ | | is_parking| string | нет | разрешено ли создавать парковки| | ||
+ | | is_larder | string | нет | разрешено ли создавать кладовки| | ||
+ | | is_section | string | нет | разрешено ли создавать секции| | ||
+ | | is_apart | string | нет | разрешено ли создавать апартаменты| | ||
+ | | is_alone | string | нет | разрешено ли создавать типы без помещений| | ||
+ | | is_moto_parking | string | нет | разрешено ли создавать мотоместа| | ||
+ | | is_bike_parking | string | нет | разрешено ли создавать веломеста| | ||
+ | | is_non_residential | string | нет | разрешено ли создавать нежилые помещения| | ||
+ | | is_strict_flat_select | string | нет | разрешено ли создавать новые flat| | ||
+ | |||
+ | |||
+ | |||
**Пример:** | **Пример:** | ||
<code javascript> | <code javascript> | ||
Строка 274: | Строка 367: | ||
{ | { | ||
"address":"Кемерово г, Дружбы ул, дом 1Б", | "address":"Кемерово г, Дружбы ул, дом 1Б", | ||
- | "house_id":50136 | + | "house_id":50136, |
+ | "fias": null, | ||
+ | "flag_active": "Д", | ||
+ | "city_text": "Кемерово г", | ||
+ | "street_text": "Дружбы ул", | ||
+ | "house_num": "1Б", | ||
+ | "corp": null, | ||
+ | "struct": null, | ||
+ | "is_flat": "Н", | ||
+ | "is_office": "Н", | ||
+ | "is_parking": "Н", | ||
+ | "is_larder": "Н", | ||
+ | "is_section": "Н", | ||
+ | "is_apart": "Н", | ||
+ | "is_alone": "Н", | ||
+ | "is_moto_parking": "Н", | ||
+ | "is_bike_parking": "Н", | ||
+ | "is_non_residential": "Н", | ||
+ | "is_strict_flat_select": "Н" | ||
}, | }, | ||
{ | { | ||
"address":"Кемерово г, Дружбы ул, дом 1А", | "address":"Кемерово г, Дружбы ул, дом 1А", | ||
- | "house_id":50135 | + | "house_id":50135, |
+ | "fias": null, | ||
+ | "flag_active": "Н", | ||
+ | "city_text": "Кемерово г", | ||
+ | "street_text": "Дружбы ул", | ||
+ | "house_num": "1А", | ||
+ | "corp": null, | ||
+ | "struct": null, | ||
+ | "is_flat": "Н", | ||
+ | "is_office": "Н", | ||
+ | "is_parking": "Н", | ||
+ | "is_larder": "Н", | ||
+ | "is_section": "Н", | ||
+ | "is_apart": "Н", | ||
+ | "is_alone": "Н", | ||
+ | "is_moto_parking": "Н", | ||
+ | "is_bike_parking": "Н", | ||
+ | "is_non_residential": "Н", | ||
+ | "is_strict_flat_select": "Н" | ||
+ | }, | ||
+ | ... | ||
+ | ] | ||
+ | </code> | ||
+ | |||
+ | ==== Получение списка групп домов ==== | ||
+ | GET http://server.ru/v2/ref/group_obj_list?cnt_id=value | ||
+ | |||
+ | Параметры запроса: | ||
+ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
+ | | cnt_id | number | да | идентификатор юр. лица в системе.| | ||
+ | |||
+ | Тип ответа: Массив с объектами | ||
+ | |||
+ | Параметры ответа (объектов массива) | ||
+ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
+ | | description | string | да | название группы | | ||
+ | | group_obj_id | number | да | идентификатор группы| | ||
+ | |||
+ | |||
+ | |||
+ | **Пример:** | ||
+ | <code javascript> | ||
+ | |||
+ | //Запрос | ||
+ | /* | ||
+ | http://server.ru/v2/ref/group_obj_list?cnt_id=11601 | ||
+ | */ | ||
+ | |||
+ | // Ответ | ||
+ | [ | ||
+ | { | ||
+ | "group_obj_id": 234, | ||
+ | "description": "Луначарского" | ||
+ | }, | ||
+ | { | ||
+ | "group_obj_id": 235, | ||
+ | "description": "Нелуначарского" | ||
}, | }, | ||
... | ... | ||
Строка 365: | Строка 532: | ||
|flat_id| number|да|идентификатор квартиры в системе| | |flat_id| number|да|идентификатор квартиры в системе| | ||
|FLAT_TYPE|number|да|тип помещения. Смотреть [[d24:develop:v2:backend:v2#типы_помещений|описание типов помещений]]| | |FLAT_TYPE|number|да|тип помещения. Смотреть [[d24:develop:v2:backend:v2#типы_помещений|описание типов помещений]]| | ||
+ | |entrance|string|нет|номер подъезда| | ||
+ | |floor|number|нет|номер этажа| | ||
**Пример:** | **Пример:** | ||
Строка 379: | Строка 548: | ||
"flat": "37", | "flat": "37", | ||
"flat_id": 55282, | "flat_id": 55282, | ||
- | "FLAT_TYPE": 1 | + | "flat_type": 1, |
+ | "entrance": null, | ||
+ | "floor": null | ||
+ | | ||
| | ||
}, | }, | ||
Строка 385: | Строка 557: | ||
"flat": "38", | "flat": "38", | ||
"flat_id": 55283, | "flat_id": 55283, | ||
- | "FLAT_TYPE": 1 | + | "FLAT_TYPE": 1, |
+ | "entrance": "2", | ||
+ | "floor": 3 | ||
}, | }, | ||
{ | { | ||
"flat": "39", | "flat": "39", | ||
"flat_id": 55284, | "flat_id": 55284, | ||
- | "FLAT_TYPE": 1 | + | "FLAT_TYPE": 1, |
+ | "entrance": "1", | ||
+ | "floor": 4 | ||
}, | }, | ||
{ | { | ||
"flat": "40", | "flat": "40", | ||
"flat_id": 55285, | "flat_id": 55285, | ||
- | "FLAT_TYPE": 1 | + | "FLAT_TYPE": 1, |
+ | "entrance": null, | ||
+ | "floor": null | ||
} | } | ||
] | ] | ||
Строка 663: | Строка 841: | ||
|status| string|да|-| | |status| string|да|-| | ||
|status_id|string|да|-| | |status_id|string|да|-| | ||
+ | |reasons_count|number|да|-| | ||
**Пример:** | **Пример:** | ||
Строка 676: | Строка 855: | ||
{ | { | ||
"status": "Открытые заявки", | "status": "Открытые заявки", | ||
- | "status_id": "1:65:70:5:2:23:4" | + | "status_id": "1:65:70:5:2:23:4", |
+ | "reasons_count": 0 | ||
}, | }, | ||
{ | { | ||
"status": "...Новые", | "status": "...Новые", | ||
- | "status_id": "1:65:70:5" | + | "status_id": "1:65:70:5", |
+ | "reasons_count": 0 | ||
}, | }, | ||
{ | { | ||
"status": ".....|Зарегистрирована", | "status": ".....|Зарегистрирована", | ||
- | "status_id": "1" | + | "status_id": "1", |
+ | "reasons_count": 0 | ||
} | } | ||
] | ] | ||
Строка 690: | Строка 872: | ||
- | ==== Получение списка типов заявок ==== | + | ==== Получение типов заявок ==== |
GET http://server.ru/v2/ref/req_type_list | GET http://server.ru/v2/ref/req_type_list | ||
Строка 976: | Строка 1158: | ||
|cnt_id|number|нет|идентификатор юр. лица| | |cnt_id|number|нет|идентификатор юр. лица| | ||
|house_id|number|нет|идентификатор дома| | |house_id|number|нет|идентификатор дома| | ||
- | |status|string|нет|статус оповещения| | + | |status|string|нет|статус оповещения "А" - активно "З" - закрыто| |
- | |type|string|нет|типы оповещения через двоеточие| | + | |type|string|нет|тип оповещения| |
|service|string|нет|список услуг через двоеточие| | |service|string|нет|список услуг через двоеточие| | ||
|custom_filter|string|нет|отменяет все прочие фильтры| | |custom_filter|string|нет|отменяет все прочие фильтры| | ||
+ | |date_start|string|нет|дата и время начала в ISO формате| | ||
+ | |date_end|string|нет|дата и время конца в ISO формате| | ||
+ | |city_text|string|нет|фильтр по городу| | ||
+ | |street_text|string|нет|фильтр по улице| | ||
+ | |reason|string|нет|причина оповещения| | ||
+ | |resp|string|нет|зона ответственности| | ||
+ | |svc_id|string|нет|РСО оповещения| | ||
+ | |moderation_needed|string|нет|статус модерации| | ||
+ | |||
+ | |||
+ | |||
**Тип ответа:** Массив объектов | **Тип ответа:** Массив объектов | ||
Строка 990: | Строка 1183: | ||
|start_at|string|да|дата и время начала в часовом поясе пользователя. Формат DD.MM.YYYY hh24:mi| | |start_at|string|да|дата и время начала в часовом поясе пользователя. Формат DD.MM.YYYY hh24:mi| | ||
|end_at|string|может быть null|дата и время конца в часовом поясе пользователя. Формат DD.MM.YYYY hh24:mi| | |end_at|string|может быть null|дата и время конца в часовом поясе пользователя. Формат DD.MM.YYYY hh24:mi| | ||
- | |created_at|string|да| дата и время создания оповещения| | + | |created_at|string|да|дата и время создания оповещения. Формат DD.MM.YYYY hh24:mi| |
+ | |start_at_tz|string|да|дата и время начала в ISO формате| | ||
+ | |end_at_tz|string|может быть null|дата и время конца в ISO формате| | ||
+ | |created_on_tz|string|да|дата и время создания оповещения в ISO формате| | ||
+ | |updated_on_tz|string|может быть null|дата и время изменения оповещения в ISO формате| | ||
|note|string|да|текст оповещения| | |note|string|да|текст оповещения| | ||
- | |status|string|да|статус оповещения| | + | |last_comments|array|да|список последних комментариев| |
+ | |reason|string|да|причина оповещения| | ||
+ | |reason_str|string|да|текстовое описание причины оповещения| | ||
+ | |resp|string|да|зона ответственности| | ||
+ | |status|string|да|статус оповещения статус оповещения "А" - активно "З" - закрыто| | ||
|status_str|string|да|текстовое описание статуса оповещения| | |status_str|string|да|текстовое описание статуса оповещения| | ||
- | |service_list|string|может быть null|код услуги, к которой относится оповещение| | + | |service_list|string|может быть null|список услуг через двоеточие| |
- | |service_list_str|string|может быть null|услуга, к которой относится оповещение| | + | |service_list_str|string|может быть null|текстовое описание услуг оповещения через запятую| |
|all_flags|string|-|-| | |all_flags|string|-|-| | ||
|object_list|array|да|список домов оповещения| | |object_list|array|да|список домов оповещения| | ||
+ | |||
+ | **Параметры массива last_comments (список последних комментариев):** | ||
+ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
+ | |note|string|да|текст комментария| | ||
**Параметры массива object_list (список домов оповещения):** | **Параметры массива object_list (список домов оповещения):** | ||
Строка 1060: | Строка 1265: | ||
|created_at|string|да| дата и время создания оповещения| | |created_at|string|да| дата и время создания оповещения| | ||
|note|string|да|текст оповещения| | |note|string|да|текст оповещения| | ||
- | |status|string|да|статус оповещения| | + | |status|string|да|статус оповещения статус оповещения "А" - активно "З" - закрыто| |
|status_str|string|да|текстовое описание статуса оповещения| | |status_str|string|да|текстовое описание статуса оповещения| | ||
|service_list|string|может быть null|код услуги, к которой относится оповещение| | |service_list|string|может быть null|код услуги, к которой относится оповещение| | ||
Строка 1100: | Строка 1305: | ||
} | } | ||
</code> | </code> | ||
+ | ==== Получение списка домов, на которые распространяется оповещение в виде списка состояний по каждому дому ==== | ||
+ | GET http://server.ru/v2/oi/:info_id/house_state | ||
- | ==== Получение списка домов, на которые распространяется оповещение ==== | + | **переменные URL:** |
+ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
+ | |info_id|number|да|идентификатор оповещения, для которого нужно получить список домов| | ||
+ | |||
+ | **Тип ответа:** Массив объектов | ||
+ | |||
+ | **Параметры ответа (объектов массива):** | ||
+ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
+ | |status_id|string|да|id записи состояния| | ||
+ | |house_id|string|да|id дома| | ||
+ | |status|string|да|статус состояния дома "А" - активно "З" - закрыто| | ||
+ | |date_start_tz|string|да|Временная метка по UTC даты начала| | ||
+ | |date_end_tz|string|да|Временная метка по UTC даты окончания| | ||
+ | |address|string|да|Текстовое представление адреса| | ||
+ | |||
+ | **Пример:** | ||
+ | <code javascript> | ||
+ | |||
+ | //Запрос | ||
+ | /* | ||
+ | http://server.ru/v2/oi/139246/house_state | ||
+ | */ | ||
+ | |||
+ | // Ответ | ||
+ | [ | ||
+ | { | ||
+ | "status_id": 4981824, | ||
+ | "house_id": 40783, | ||
+ | "status": "З", | ||
+ | "date_start_tz": "2024-01-15T10:18:00.000Z", | ||
+ | "date_end_tz": null, | ||
+ | "address": "Курган г, Бурова-Петрова ул, дом 78" | ||
+ | }, | ||
+ | { | ||
+ | "status_id": 4981825, | ||
+ | "house_id": 49396, | ||
+ | "status": "З", | ||
+ | "date_start_tz": "2024-01-15T10:18:00.000Z", | ||
+ | "date_end_tz": null, | ||
+ | "address": "Курган г, Куртамышская ул, дом 18 К1" | ||
+ | } | ||
+ | ] | ||
+ | </code> | ||
+ | |||
+ | ==== Получение списка домов, на которые распространяется оповещение в виде группировки по улицами ==== | ||
GET http://server.ru/v2/oi/:info_id/houses | GET http://server.ru/v2/oi/:info_id/houses | ||
Строка 1507: | Строка 1758: | ||
|what_was_done|string|нет| - | | |what_was_done|string|нет| - | | ||
|paid|number|нет| - | | |paid|number|нет| - | | ||
+ | |is_favorites|string|нет| Добавить/убрать из избранного (Д/Н) | | ||
+ | |phone_contact|string|нет| Контактный номер телефона жителя | | ||
+ | |flag_payment|string|нет| Оплачена ли заявка (Д/Н) | | ||
**Тип ответа:** Объект | **Тип ответа:** Объект | ||
Строка 1541: | Строка 1795: | ||
"price": 100.2, | "price": 100.2, | ||
"what_was_done": "что-то сделано", | "what_was_done": "что-то сделано", | ||
- | "paid": 100.3 | + | "paid": 100.3, |
+ | "is_favorites" : "Д", | ||
+ | "phone_contact": "9754936397", | ||
+ | "flag_payment" : "Д" | ||
} | } | ||
Строка 1552: | Строка 1809: | ||
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 | 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 | + | &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 | ||
**Параметры запроса:** | **Параметры запроса:** | ||
Строка 1559: | Строка 1817: | ||
|count|number|да|Сколько заявок получить| | |count|number|да|Сколько заявок получить| | ||
|cnt_id|number|нет| идентификатор юр. лица| | |cnt_id|number|нет| идентификатор юр. лица| | ||
+ | |city|string|нет| Название города| | ||
|street|string|нет|улица| | |street|string|нет|улица| | ||
|house_id|number|нет|идентификатор дома| | |house_id|number|нет|идентификатор дома| | ||
Строка 1577: | Строка 1836: | ||
|custom_filter|string|нет|возможные значения фильтра: new / in_work / on_hold / deadline / finished . Mожет быть передано несколько значений через двоеточие (:).| | |custom_filter|string|нет|возможные значения фильтра: new / in_work / on_hold / deadline / finished . Mожет быть передано несколько значений через двоеточие (:).| | ||
|is_only_my|number|нет|фильтр, определяющий необходимо ли показывать все заявки или только те, у которых пользователь - ответственный / исполнитель ( 0 - все / 1 - пользователя)| | |is_only_my|number|нет|фильтр, определяющий необходимо ли показывать все заявки или только те, у которых пользователь - ответственный / исполнитель ( 0 - все / 1 - пользователя)| | ||
- | |custom_order|string|нет|тип сортировки заявок ( EXEC_TIME / CREATED_TIME - по сроку выполнения / дате создания) EXEC_TIME по умолчанию если не указано иное.| | + | |custom_order|string|нет|тип сортировки заявок ( По дате изменения: update; По дате создания: create; По сроку выполнения: execution; По дате выполнения: closing| |
+ | |sort|string|нет|Направление сортировки. по возрастанию(asc): A; по убыванию(desc): D;| | ||
+ | |house_ids|string|нет|список идентификаторов домов через двоеточие. Пример: "1:2:3"| | ||
+ | |flat_ids|string|нет|список идентификаторов помещений через двоеточие. Пример: "1:2:3"| | ||
+ | |emp_ids|string|нет|список идентификаторов ответственных через двоеточие. Пример: "1:2:3"| | ||
+ | |resp_ids|string|нет|список идентификаторов исполнителей через двоеточие. Пример: "1:2:3"| | ||
+ | |search_phone|string|нет|фильтр по номеру телефона.| | ||
+ | |house_group_ids|string|нет|список идентификаторов групп домов через двоеточие. Пример: "1:2:3"| | ||
+ | |period_exec|string|нет|фильтр по срокам выполнения. Просроченные: П,На сегодня: С,На завтра: З,На ближайшие 3 дня: Т,На неделю: Н,Выполненные: И, Все: В| | ||
+ | |exec_time_start|string|нет|начало срока выполнения| | ||
+ | |exec_time_end|string|нет|конец срока выполнения| | ||
+ | |is_favorites|number|нет|фильтр, определяющий необходимо ли показывать все заявки или только те, которые у пользователя в избранном ( 0 - все / 1 - избранные)| | ||
+ | |add_type|string|нет|фильтр SLA. Тип фильтра. значения: RSFAT - первое принятие в работу; RSFT - время до выполнения| | ||
+ | |add_more_than|number|нет|фильтр SLA. Больше чем. указывается в количестве секунд. Не будет работать, если не указан add_type| | ||
+ | |add_less_than|number|нет|фильтр SLA. Меньше чем. указывается в количестве секунд. Не будет работать, если не указан add_type| | ||
**Тип ответа:** Массив объектов | **Тип ответа:** Массив объектов | ||
Строка 1589: | Строка 1862: | ||
|house|string|да|Адрес дома| | |house|string|да|Адрес дома| | ||
|flat|string|может быть null|номер квартиры| | |flat|string|может быть null|номер квартиры| | ||
+ | |entr|string|обозначение подъезда| | ||
|status|string|да|текстовое описание статуса| | |status|string|да|текстовое описание статуса| | ||
|status_id|number|да|идентификатор статуса| | |status_id|number|да|идентификатор статуса| | ||
|created_at|string|да|дата и время создания заявки в часовом поясе пользователя| | |created_at|string|да|дата и время создания заявки в часовом поясе пользователя| | ||
+ | |updated_at|string|нет| дата и время обновления заявки| | ||
+ | |execution_time|string|нет|дата и время выполнения заявки| | ||
|price|number|может быть null| Цена заявки. Определена, если заявка платная, если нет, то null| | |price|number|может быть null| Цена заявки. Определена, если заявка платная, если нет, то null| | ||
|material_price|number|-|-| | |material_price|number|-|-| | ||
Строка 1603: | Строка 1879: | ||
|reason|string|может быть null|текстовое описание причины статуса| | |reason|string|может быть null|текстовое описание причины статуса| | ||
|local_at|-|может быть null|-| | |local_at|-|может быть null|-| | ||
+ | |contphone|string|да|Номер телефона клиента обратившегося с заявкой| | ||
+ | |house_id|number|нет|идентификатор дома| | ||
+ | |flat_type|number|нет|тип помещения. Смотреть [[d24:develop:v2:backend:v2#типы_помещений|описание типов помещений]] | ||
+ | |flat_num|string|нет|номер помещения| | ||
+ | |autophone|string|нет|-| | ||
+ | |ess_id|number|нет|идентификатор причины обращения| | ||
+ | |type_id|number|нет|идентификатор типа заявки| | ||
+ | |is_favorites|string|да|добавлена ли заявка в избранное Д/Н| | ||
Строка 1619: | Строка 1903: | ||
{ | { | ||
"rn": 1, | "rn": 1, | ||
- | "request_id": 1298309, | + | "request_id": 1298931, |
"flag_emergency": "Н", | "flag_emergency": "Н", | ||
- | "note": "Не работает освещение в пом 13. Этаж 1", | + | "note": "Химчистка домашнего текстиля", |
- | "house": "Бакинских комиссаров, дом 3", | + | "house": "Луначарского ул, дом 240", |
- | "flat": null, | + | "flat": "кв 100", |
- | "status": "Закрыта", | + | "entr": "2", |
- | "created_at": "28.10.2021 11:02", | + | "status": "Зарегистрирована", |
+ | "created_at": "17.03.2022 15:26", | ||
+ | "updated_at": null, | ||
+ | "execution_time": "21.03.2022 15:26", | ||
"price": null, | "price": null, | ||
"material_price": null, | "material_price": null, | ||
- | "tags": null, | + | "tags": "<span style=\"background-color:#FFA366\">сайт</span>", |
"uploads_count": 0, | "uploads_count": 0, | ||
"appointed_str": null, | "appointed_str": null, | ||
"appointed_at": null, | "appointed_at": null, | ||
"emp": null, | "emp": null, | ||
- | "deadline_str": null, | + | "deadline_str": -14, |
- | "reason": "принудительно модератором", | + | "reason": null, |
- | "status_id": 25, | + | "status_id": 1, |
"emp_id": null, | "emp_id": null, | ||
- | "local_at": null | + | "local_at": null, |
+ | "house_id": 54696, | ||
+ | "flat_type": 1, | ||
+ | "flat_num": "100", | ||
+ | "contphone": "9826171613", | ||
+ | "autophone": null, | ||
+ | "ess_id": 3263, | ||
+ | "type_id": 21, | ||
+ | "is_favorites" :"Д" | ||
}, | }, | ||
{ | { | ||
"rn": 2, | "rn": 2, | ||
- | "request_id": 1298250, | + | "request_id": 1298930, |
"flag_emergency": "Н", | "flag_emergency": "Н", | ||
- | "note": "фыывафыаыфы", | + | "note": "Химчистка домашнего текстиля", |
- | "house": "Бакинских комиссаров, дом 3", | + | "house": "Луначарского ул, дом 240", |
- | "flat": null, | + | "flat": "кв 100", |
+ | "entr": null, | ||
"status": "Зарегистрирована", | "status": "Зарегистрирована", | ||
- | "created_at": "14.10.2021 09:59", | + | "created_at": "17.03.2022 15:26", |
- | "price": 10000, | + | "updated_at": "31.03.2022 13:28", |
- | "material_price": 500, | + | "execution_time": "21.03.2022 15:26", |
- | "tags": null, | + | "price": null, |
+ | "material_price": null, | ||
+ | "tags": "<span style=\"background-color:#FFA366\">сайт</span>", | ||
"uploads_count": 0, | "uploads_count": 0, | ||
"appointed_str": null, | "appointed_str": null, | ||
"appointed_at": null, | "appointed_at": null, | ||
- | "emp": null, | + | "emp": "dev", |
- | "deadline_str": -28, | + | "deadline_str": -14, |
"reason": null, | "reason": null, | ||
"status_id": 1, | "status_id": 1, | ||
- | "emp_id": null, | + | "emp_id": 35753, |
- | "local_at": null | + | "local_at": null, |
+ | "house_id": 54696, | ||
+ | "flat_type": 1, | ||
+ | "flat_num": "100", | ||
+ | "contphone": "9826171613", | ||
+ | "autophone": null, | ||
+ | "ess_id": 3263, | ||
+ | "type_id": 21, | ||
+ | "is_favorites" :"Н" | ||
}, | }, | ||
... | ... | ||
Строка 1766: | Строка 2072: | ||
|what_was_done|string| что было сделано | | |what_was_done|string| что было сделано | | ||
|cnt_callback_phone| string|телефон для обращения в кц в десятизначном формате| | |cnt_callback_phone| string|телефон для обращения в кц в десятизначном формате| | ||
+ | |is_favorites|string|добавлена ли заявка в избранное Д/Н| | ||
+ | |ext_pay_system_id|string|код платежной системы из ойко| | ||
+ | |inn|string|инн юр лица| | ||
+ | |is_oico_account|number|Есть ли у собственника приложение oico, варианты ответа 0 - нет приложения/1 нет приложения - есть приложение) | | ||
+ | |fio|string| ФИО заявителя | | ||
**Примеры:** | **Примеры:** | ||
Строка 1823: | Строка 2134: | ||
"what_was_done": null, | "what_was_done": null, | ||
"cnt_callback_phone": "3522222888", | "cnt_callback_phone": "3522222888", | ||
- | "check_id": null | + | "check_id": null, |
+ | "is_favorites" : "Н", | ||
+ | "ext_pay_system_id" : "7241689124", | ||
+ | "inn" : "123142114114", | ||
+ | "is_oico_account" : 1, | ||
+ | "fio": null | ||
} | } | ||
</code> | </code> | ||
Строка 2037: | Строка 2353: | ||
^ Название ^ Тип ^ Обязательно ^ Описание^ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
|created_at|string|да|Дата создания| | |created_at|string|да|Дата создания| | ||
+ | |created_on_tz|string|да| Zulu Временная метка события по utc | | ||
|type|number|да|Тип события 0 - комментарий, 1 - активность, 2 - файлы, 3 - изображения с превью, 4 - запись разговора| | |type|number|да|Тип события 0 - комментарий, 1 - активность, 2 - файлы, 3 - изображения с превью, 4 - запись разговора| | ||
|note|string|да|текст события| | |note|string|да|текст события| | ||
Строка 2042: | Строка 2359: | ||
|id|number|да|идентификатор события| | |id|number|да|идентификатор события| | ||
|flag_webhook|string|да| Статус публикации события. Д - опубликовано / Н - не опубликовано"| | |flag_webhook|string|да| Статус публикации события. Д - опубликовано / Н - не опубликовано"| | ||
- | |creator_type|number|да|-| | + | |creator_type|number|да|0 - событие внутри системы, 1 - событие от собственника ч/з мп| |
+ | |creator_id|number|да|id пользователя создавшего событие в ленте| | ||
**Примеры:** | **Примеры:** | ||
Строка 2056: | Строка 2374: | ||
[ | [ | ||
{ | { | ||
- | "created_at":"17.07.2017 18:58", | + | "created_at": "12.03.2024 01:16", |
- | "type":1, | + | "created_on_tz": "2024-03-11T20:16:44.842Z", |
- | "note":"Смена исполнителя ->> Башкирев Эдуард Олегович\r\n...", | + | "type": 0, |
- | "created_by":"Журавлева Марина Сергеевна", | + | "note": "прот", |
- | "id": 12345, | + | "created_by": "кто-то очень умный", |
- | "flag_webhook": "Д", | + | "flag_webhook": "Н", |
- | "creator_type": 0 | + | "id": 27072208, |
+ | "creator_type": 0, | ||
+ | "creator_id": 33 | ||
}, | }, | ||
{ | { | ||
- | "created_at":"17.07.2017 18:03", | + | "created_at": "12.03.2024 01:16", |
- | "type":3, | + | "created_on_tz": "2024-03-11T20:16:44.840Z", |
- | "note":"https://pultdoma.ru/front/uploads/img/17-07-2017/3196190_549_2_596c99ab73ae0.jpg", | + | "type": 1, |
- | "created_by":"Пользователь личного кабинета", | + | "note": "Статус сменился с Принята в работу на Выполнена", |
- | "id": 123456, | + | "created_by": "кто-то очень умный", |
+ | "flag_webhook": null, | ||
+ | "id": 59487612, | ||
+ | "creator_type": 0, | ||
+ | "creator_id": 33 | ||
+ | }, | ||
+ | { | ||
+ | "created_at": "11.03.2024 16:08", | ||
+ | "created_on_tz": "2024-03-11T11:08:51.999Z", | ||
+ | "type": 0, | ||
+ | "note": "фывафыва", | ||
+ | "created_by": "кто-то очень умный", | ||
"flag_webhook": "Н", | "flag_webhook": "Н", | ||
- | "creator_type": 0 | + | "id": 27067540, |
+ | "creator_type": 0, | ||
+ | "creator_id": 278794 | ||
+ | }, | ||
+ | { | ||
+ | "created_at": "11.03.2024 16:08", | ||
+ | "created_on_tz": "2024-03-11T11:08:51.979Z", | ||
+ | "type": 1, | ||
+ | "note": "Статус сменился с Зарегистрирована на Принята в работу", | ||
+ | "created_by": "кто-то очень умный", | ||
+ | "flag_webhook": null, | ||
+ | "id": 59470759, | ||
+ | "creator_type": 0, | ||
+ | "creator_id": 278794 | ||
} | } | ||
] | ] | ||
Строка 2224: | Строка 2568: | ||
"type_description": "Новая заявка", | "type_description": "Новая заявка", | ||
"created_at": "22.12.2021 10:37" | "created_at": "22.12.2021 10:37" | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | |||
+ | ==== Пометить прочитанными все push-уведомления у пользователя ==== | ||
+ | |||
+ | POST https://server.ru/v2/push/readall | ||
+ | |||
+ | |||
+ | **Тип ответа:** Объект | ||
+ | |||
+ | **Параметры ответа:** | ||
+ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
+ | |affected_rows|number|да|количество затронутых обновлением строк| | ||
+ | |||
+ | **Примеры:** | ||
+ | |||
+ | <code javascript> | ||
+ | //Запрос | ||
+ | |||
+ | /* | ||
+ | https://server.ru/v2/push/readall | ||
+ | */ | ||
+ | |||
+ | //Ответ code: 200 | ||
+ | |||
+ | { | ||
+ | affected_rows: 167 | ||
} | } | ||
</code> | </code> | ||
Строка 2248: | Строка 2620: | ||
|token_id| number |да| -|, | |token_id| number |да| -|, | ||
|can_access_material_price|boolean |да| - | | |can_access_material_price|boolean |да| - | | ||
+ | |sip|array|да|Массив с объектами. Тип объектов см. ниже| | ||
+ | |access_status_list|string|да|Идентификаторы разрешенных статусов для изменения через двоеточие. Пример: 2:5:21:3:25:47| | ||
+ | |ref_users|object|да|Объект со всеми полями в юзере. см ниже| | ||
+ | |||
+ | **sip**: | ||
+ | ^название^тип^описание^ | ||
+ | |queue_num|string|-| | ||
+ | |queue_name|string|-| | ||
+ | |||
+ | **ref_users** | ||
+ | ^название^тип^обязательно^описание^ | ||
+ | |ALLOWED_CLOSED_REASON|string|нет|Идентификаторы разрешенных причин закрытия заявки для изменения через двоеточие. Пример: 7164:7:8| | ||
+ | ||||| | ||
**Примеры:** | **Примеры:** | ||
Строка 2261: | Строка 2646: | ||
{ | { | ||
- | "username": "Предеин Анатолий", | + | "username": "dev", |
- | "can_close_request": true, | + | "can_close_request": false, |
"can_access_meters": true, | "can_access_meters": true, | ||
"can_access_contacts": true, | "can_access_contacts": true, | ||
- | "account_name": "Не активен", | + | "can_access_checklist": true, |
- | "phone": "9898004862", | + | "can_access_settings": true, |
- | "emp_id": 22055, | + | "account_name": "Лучшая", |
- | "not_read_push_count": 10, | + | "phone": null, |
- | "can_comment_to_ext_system": 1, // варианты 0/1 | + | "emp_id": 35753, |
- | "token_id": 12345, | + | "not_read_push_count": 82, |
- | "can_access_material_price": true | + | "can_comment_to_ext_system": 1, |
+ | "token_id": 5626, | ||
+ | "can_access_material_price": false, | ||
+ | "access_status_list": "2:5:21:3:25:47", | ||
+ | "ref_users": { | ||
+ | "EMPLOYEE_ID": 35753, | ||
+ | "LOGIN": "dev", | ||
+ | "POSITION": null, | ||
+ | "PHONES": null, | ||
+ | "ACCOUNT_ID": 2621, | ||
+ | "EMAIL": null, | ||
+ | "USERNAME": "dev", | ||
+ | "access": "А", | ||
+ | "STATUS": "Р", | ||
+ | "CC_EMP_ID": null, | ||
+ | "FLAG_LOGIN": "Д", | ||
+ | "POSITION_ID": 7, | ||
+ | "PROFILE_ID": null, | ||
+ | "VERIFIED": "Д", | ||
+ | "FLAG_OI_SMS": "Д", | ||
+ | "FLAG_NOTICE_DEBT": "Н", | ||
+ | "VAC_DATE_START": "2021-08-23T13:26:00.000Z", | ||
+ | "VAC_DATE_END": "2021-09-06T00:00:00.000Z", | ||
+ | "VAC_EMPLOYEE_ID": null, | ||
+ | "FLAG_DASHBOARD": "Д", | ||
+ | "FLAG_NIGHT_SERVICE": "Н", | ||
+ | "FLAG_SMS_SEND": "Д", | ||
+ | "SMS_CHARSET_TYPE": "Р", | ||
+ | "FLAG_METERS": "Д", | ||
+ | "TOKEN": null, | ||
+ | "VAC_COMMENT": null, | ||
+ | "FLAG_REQ_CONTROL": "Д", | ||
+ | "TIME_TO_CONTROL": null, | ||
+ | "FLAG_CONTACT": "Д", | ||
+ | "FLAG_UPLOAD_DEBT": "Н", | ||
+ | "FLAG_SHOW_DEBT": "Н", | ||
+ | "GCM_ID": null, | ||
+ | "ANDROID_VERSION": null, | ||
+ | "ANDROID_ACTIVITY_TZ": null, | ||
+ | "FLAG_PP_SMS_SEND": "Н", | ||
+ | "FLAG_PP_CALL_SEND": "Н", | ||
+ | "TIMETABLE": null, | ||
+ | "TELEGRAM_CHAT_ID": null, | ||
+ | "PHONES_OTHER": null, | ||
+ | "NOTIFY_COUNT": 183, | ||
+ | "NOTIFY_CLICK": 0, | ||
+ | "NOTIFY_PARAMS": "О;К", | ||
+ | "FLAG_CAN_CLOSE": "Н", | ||
+ | "FLAG_CURATOR": "Д", | ||
+ | "FLAG_RESP_TLGRM": "Д", | ||
+ | "FLAG_PP_CUSTOM_PROFILE": "Н", | ||
+ | "FLAG_CONTRACTOR": "Н", | ||
+ | "FLAG_CURATOR_TAKE_OFF": "Н", | ||
+ | "PUSH_CONFIG": "З_Н:З_К:З_Ф:З_СО:З_СП:on", | ||
+ | "FLAG_CAN_CHANGE_DEADLINE": "Д", | ||
+ | "CHIEF_EMPLOYEE_ID": null, | ||
+ | "FLAG_PP_EMAIL_SEND": "Н", | ||
+ | "FLAG_CAN_COMMENT_TO_EXT_SYSTEM": "Д", | ||
+ | "FLAG_KEY_EMPLOYEE": "Н", | ||
+ | "PP_CALL_PASS_DELAY": null, | ||
+ | "BLOCKED_STATUSES": null, | ||
+ | "ALLOWED_STATUSES": "2:5:21:3:25:47", | ||
+ | "FLAG_CHECK_LIST": "Д", | ||
+ | "FLAG_MATERIAL_PRICE": "Н", | ||
+ | "ALLOWED_CLOSED_REASON": null, | ||
+ | "IS_NEW_UI_REQUESTS": "Y", | ||
+ | "FLAG_SUPPORT": "Н", | ||
+ | "FLAG_VOIP_CALL": "Д", | ||
+ | "flag_check_list": "Д", | ||
+ | "employee_id": 35753, | ||
+ | "username": "dev", | ||
+ | "allowed_statuses": "2:5:21:3:25:47", | ||
+ | "accessToken": "9]J!5bzQ3B$__R|_*k.C!x3<nZ4XA3Eo1BE7371E7797CA4A5F6F651AA9C6EB43" | ||
+ | }, | ||
+ | "sip": [ | ||
+ | { | ||
+ | "queue_num": "maincc1998", | ||
+ | "queue_name": "Общий КЦ" | ||
+ | } | ||
+ | ] | ||
} | } | ||
Строка 2328: | Строка 2792: | ||
|push_config|string|нет|какие пуши юзеру необходимы| | |push_config|string|нет|какие пуши юзеру необходимы| | ||
|start_app|string|нет|выполняется каждый раз 1 раз при запуске АПП чтобы вести статистику использования апп| | |start_app|string|нет|выполняется каждый раз 1 раз при запуске АПП чтобы вести статистику использования апп| | ||
+ | |voip_token|string|нет|Если вдруг voip_token для sip звонилки изменился на девайсе или был получен позже| | ||
+ | |brand_code|string|нет|бренд код заложенный для WL | | ||
**Тип ответа:** Объект | **Тип ответа:** Объект | ||
Строка 2344: | Строка 2810: | ||
"fcm_token": "NEWTOKEN123", | "fcm_token": "NEWTOKEN123", | ||
"push_config": "З_Ф:З_Н:З_К", | "push_config": "З_Ф:З_Н:З_К", | ||
- | "start_app" : "im started!!" | + | "start_app" : "im started!!", |
+ | "brand_code" : "EASYSOLUTION" | ||
} | } | ||
//Ответ | //Ответ | ||
Строка 2404: | Строка 2871: | ||
^ Название ^ Тип ^ Обязательно ^ Описание^ | ^ Название ^ Тип ^ Обязательно ^ Описание^ | ||
|start|number|да|Позиция, с которой получить данные| | |start|number|да|Позиция, с которой получить данные| | ||
- | |count|number|да|Количество получаемых данных| | + | |count|number|да|количество получаемых данных| |
- | |statuses|string|нет|Фильтр по статусам. Отправляется список статусов в формате STATUS1:STATUS2:STATUS3. Пример: "PENDING:INWORK"| | + | |statuses|string|нет|фильтр по статусам. Отправляется список статусов в формате STATUS1:STATUS2:STATUS3. Пример: "PENDING:INWORK".\\ Смотреть [[d24:develop:v2:backend:v2#статусы_чек-листа|описание статусов чек-листа.]]| |
|employee_id|number|нет|фильтр по исполнителю| | |employee_id|number|нет|фильтр по исполнителю| | ||
|cnt_id|number|нет|идентификатор юр. лица| | |cnt_id|number|нет|идентификатор юр. лица| | ||
- | |house_id|number|нет|идентификатор дома| | + | |house_id|number|нет|фильтр по дому| |
+ | |check_id|number|нет|фильтр по идентификатору чек-листа| | ||
+ | |date_start|string|нет|дата и время начала в ISO формате| | ||
+ | |date_end|string|нет|дата и время конца в ISO формате| | ||
**Тип ответа:** Массив с объектами | **Тип ответа:** Массив с объектами | ||
Строка 2417: | Строка 2887: | ||
|name|string|да| название чек-листа | | |name|string|да| название чек-листа | | ||
|check_on_tz|string|да| дата выполнения чек-листа в ISO формате | | |check_on_tz|string|да| дата выполнения чек-листа в ISO формате | | ||
- | |status|string|да| код статуса | | + | |status|string|да| код статуса Смотреть [[d24:develop:v2:backend:v2#статусы_чек-листа|описание статусов чек-листа.]] | |
|days_count|number|да| количество оставшихся дней до выполнения чек-листа| | |days_count|number|да| количество оставшихся дней до выполнения чек-листа| | ||
|house_text|string|да|один из домов, отмеченных в чек-листе| | |house_text|string|да|один из домов, отмеченных в чек-листе| | ||
Строка 2443: | Строка 2913: | ||
"status": "INWORK", | "status": "INWORK", | ||
"days_count": 2, | "days_count": 2, | ||
- | "house": "Бурова-Петрова ул, дом 78", | + | "house_text": "Бурова-Петрова ул, дом 78", |
"houses_count": 5, | "houses_count": 5, | ||
"username": "Предеин Анатолий", | "username": "Предеин Анатолий", | ||
Строка 2468: | Строка 2938: | ||
| note | string| да | описание чек-листа | | | note | string| да | описание чек-листа | | ||
| check_on_tz | string| да | дата выполнения чек-листа в ISO формате | | | check_on_tz | string| да | дата выполнения чек-листа в ISO формате | | ||
- | |status|string|да| код статуса | | + | |status|string|да| код статуса. Смотреть [[d24:develop:v2:backend:v2#статусы_чек-листа|описание статусов чек-листа.]]| |
| username | string| да | исполнитель | | | username | string| да | исполнитель | | ||
| success_count | number | да | количество успешно выполненных работ по чек-листу | | | success_count | number | да | количество успешно выполненных работ по чек-листу | | ||
Строка 2474: | Строка 2944: | ||
| all_works_count | number | да | количество всех работ | | | all_works_count | number | да | количество всех работ | | ||
| requests_count | number | да | количество созданных заявок для работ| | | requests_count | number | да | количество созданных заявок для работ| | ||
+ | |employee_id|number|да|идентификатор исполнителя| | ||
**Примеры:** | **Примеры:** | ||
Строка 2496: | Строка 2967: | ||
"all_works_count": 5, | "all_works_count": 5, | ||
"requests_count": 1, | "requests_count": 1, | ||
- | "status": "INWORK" | + | "status": "INWORK", |
+ | "employee_id": 33 | ||
} | } | ||
Строка 2551: | Строка 3023: | ||
|work_group_id|number|нет|идентификатор группы работ (если работа находится в группе) | | |work_group_id|number|нет|идентификатор группы работ (если работа находится в группе) | | ||
|check_id|number|да|идентификатор чек-листа, к которому привязана работа| | |check_id|number|да|идентификатор чек-листа, к которому привязана работа| | ||
- | |status|number|да| код статуса работы | | + | |status|number|да| код статуса работы. [[d24:develop:v2:backend:v2#статусы_работ_чек-листа|описание статусов работ чеклиста]]| |
- | + | ||
- | **Описание статусов работы:** | + | |
- | ^Код статуса^описание^ | + | |
- | |0|в ожидании выполнения| | + | |
- | |1|успешно выполнено | | + | |
- | |2| есть нарушения | | + | |
- | |3| невозможно выполнить | | + | |
Строка 2623: | Строка 3088: | ||
|note|string|да|описание работы| | |note|string|да|описание работы| | ||
|check_id|number|да|идентификатор чек-листа, к которому привязана работа| | |check_id|number|да|идентификатор чек-листа, к которому привязана работа| | ||
- | |check_status|string|да|Код статуса чеклиста, к которому привязана работа| | + | |check_status|string|да|Код статуса чеклиста, к которому привязана работа. [[d24:develop:v2:backend:v2#статусы_чек-листа|Описание статусов чеклиста]]| |
- | |status|number|да| код статуса работы | | + | |status|number|да| код статуса работы. [[d24:develop:v2:backend:v2#статусы_работ_чек-листа|Описание статуса работ чеклиста]] | |
|criteria|string|нет| критерии. Текст в виде списка(с символами переноса строки) | | |criteria|string|нет| критерии. Текст в виде списка(с символами переноса строки) | | ||
|ess_id|number|да| ИД причина обращения для создания заявки | | |ess_id|number|да| ИД причина обращения для создания заявки | | ||
|ess|string|да| Текст причины обращения для создания заявки | | |ess|string|да| Текст причины обращения для создания заявки | | ||
|type_id|number|да|идентификатор типа работы| | |type_id|number|да|идентификатор типа работы| | ||
+ | |required_action_list |string|нет|Перечень действий необходимых при выполнении работы| | ||
**Примеры:** | **Примеры:** | ||
Строка 2651: | Строка 3117: | ||
"ess_id" : 123, | "ess_id" : 123, | ||
"ess" : "Какая то причина обращения для создания заявки", | "ess" : "Какая то причина обращения для создания заявки", | ||
- | "type_id: 24 | + | "type_id: 24, |
+ | "required_action_list" : "Y_P:Y_R:I_P:I_C:I_R" | ||
} | } | ||
+ | |||
+ | правила и особенности формирования "required_action_list" | ||
+ | Y_ / N_ / I_ - это действия (Есть нарушения / Нет нарушений / Невозможно выполонить) | ||
+ | P / C / R - это необходимая сущность (Фото/ Коммент / Заявка) | ||
+ | Как пример Y_P:Y_R:I_P:I_C:I_R - если есть нарушения надо фото и заявку, если невозможно выполнить то и фото и коммент и заявку | ||
+ | |||
</code> | </code> | ||
Строка 2671: | Строка 3144: | ||
|created_on_tz|string|да| когда создан | | |created_on_tz|string|да| когда создан | | ||
|created_by|string|да| кем создан | | |created_by|string|да| кем создан | | ||
+ | |flag_webhook|string|да|Y или N| | ||
**Описание типов элемента ленты (type):** | **Описание типов элемента ленты (type):** | ||
Строка 2857: | Строка 3331: | ||
</code> | </code> | ||
+ | |||
+ | |||
+ | ===== Сохраненные настройки фильтров ===== | ||
+ | |||
+ | ==== создание настроек фильтров ==== | ||
+ | POST https://server.ru/v2/request_filter | ||
+ | |||
+ | **Тело запроса:** | ||
+ | ^Название^тип^обязательно^описание^ | ||
+ | |cnt_id|number|нет|id Организации | | ||
+ | |note|string|да|Описание настройки фильтров| | ||
+ | |filter_data|string|да|Настройки фильтров в виде строки в формате JSON| | ||
+ | |||
+ | **Тип ответа:** Объект | ||
+ | |||
+ | **Параметры ответа** | ||
+ | ^Название^тип^обязательно^описание^ | ||
+ | |filter_id|number|да| id сохраненных настроек| | ||
+ | |cnt_id|number|нет|id организации| | ||
+ | |employee_id|number|да|id сотрудника| | ||
+ | |note|string|да|описание настроек фильтра| | ||
+ | |filter_data|string|да|Данные настроек фильтра в виде строки в формате JSON. см пример| | ||
+ | |||
+ | |||
+ | **Примеры:** | ||
+ | |||
+ | <code javascript> | ||
+ | |||
+ | // Запрос | ||
+ | /* | ||
+ | https://server.ru/v2/request_filter | ||
+ | */ | ||
+ | |||
+ | //тело запроса | ||
+ | |||
+ | { | ||
+ | cnt_id: 10401, | ||
+ | filter_data: "{\"period_exec\":-1,\"street\":\"Агатовая ул\",\"city\":\"all\",\"is_only_my\":0,\"period\":\"all\",\"custom_order\":\"create\",\"group_obj_id\":\"notSel\",\"resp_ids\":[],\"emp_ids\": [],\"rtype_ids\":[],\"status_ids\":[],\"type_ids\":[],\"ess_ids\":[],\"tag_ids\":[],\"house_ids\":[],\"flat_ids\": | ||
+ | [],\"sort\":\"D\",\"search_phone\":\"\",\"keywords\":\"\",\"request_id\":\"\",\"add_type\":\"notSel\",\"add_less_than\":0,\"add_more_than\":0,\"add_more_less_select\":\"more\"}", | ||
+ | note: "Тестовый фильтр" | ||
+ | } | ||
+ | |||
+ | //Ответ | ||
+ | { | ||
+ | "filter_id": 13261, | ||
+ | "cnt_id": 10401, | ||
+ | "note": "Тестовый фильтр", | ||
+ | "filter_data": "{\"period_exec\":-1,\"street\":\"Агатовая ул\",\"city\":\"all\",\"is_only_my\":0,\"period\":\"all\",\"custom_order\":\"create\",\"group_obj_id\":\"notSel\",\"resp_ids\":[],\"emp_ids\":[],\"rtype_ids\":[],\"status_ids\":[],\"type_ids\":[],\"ess_ids\":[],\"tag_ids\":[],\"house_ids\":[],\"flat_ids\":[],\"sort\":\"D\",\"search_phone\":\"\",\"keywords\":\"\",\"request_id\":\"\",\"add_type\":\"notSel\",\"add_less_than\":0,\"add_more_than\":0,\"add_more_less_select\":\"more\"}", | ||
+ | "employee_id": 127853 | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | ==== Обновление настроек фильтров ==== | ||
+ | PUT https://server.ru/v2/request_filter/:filter_id | ||
+ | |||
+ | **Тело запроса:** | ||
+ | ^Название^тип^обязательно^описание^ | ||
+ | |note|string|да|Описание настройки фильтров| | ||
+ | |||
+ | **Тип ответа:** Объект | ||
+ | |||
+ | **Параметры ответа** | ||
+ | ^Название^тип^обязательно^описание^ | ||
+ | |filter_id|number|да| id сохраненных настроек| | ||
+ | |note|string|да|описание настроек фильтра| | ||
+ | |||
+ | |||
+ | **Примеры:** | ||
+ | |||
+ | <code javascript> | ||
+ | |||
+ | // Запрос | ||
+ | /* | ||
+ | PUT https://server.ru/v2/request_filter/13261 | ||
+ | */ | ||
+ | |||
+ | //тело запроса | ||
+ | |||
+ | { | ||
+ | note: "Тестовый фильтр" | ||
+ | } | ||
+ | |||
+ | //Ответ | ||
+ | { | ||
+ | "filter_id": 13261, | ||
+ | "note": "Тестовый фильтр", | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | ==== Удаление настроек фильтров ==== | ||
+ | DELETE https://server.ru/v2/request_filter/:filter_id | ||
+ | |||
+ | **Тип ответа:** Объект | ||
+ | |||
+ | **Параметры ответа** | ||
+ | ^Название^тип^обязательно^описание^ | ||
+ | |filter_id|number|да| id удаленных настроек| | ||
+ | |||
+ | |||
+ | **Примеры:** | ||
+ | |||
+ | <code javascript> | ||
+ | |||
+ | // Запрос | ||
+ | /* | ||
+ | DELETE https://server.ru/v2/request_filter/13261 | ||
+ | */ | ||
+ | |||
+ | //Ответ | ||
+ | { | ||
+ | "filter_id": 13261 | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | |||
+ | ==== получение настроек фильтров ==== | ||
+ | GET https://server.ru/v2/request_filter?cnt_id=value | ||
+ | |||
+ | **query параметры:** | ||
+ | ^Название^тип^обязательно^описание^ | ||
+ | |cnt_id|number|нет|id Организации | | ||
+ | |||
+ | **Тип ответа:** Массив | ||
+ | |||
+ | **Параметры ответа** | ||
+ | ^Название^тип^обязательно^описание^ | ||
+ | |filter_id|number|да| id сохраненных настроек| | ||
+ | |cnt_id|number|да|id организации| | ||
+ | |employee_id|number|да|id сотрудника| | ||
+ | |note|string|да|описание настроек фильтра| | ||
+ | |filter_data|string|да|Данные настроек фильтра в виде строки в формате JSON. см пример| | ||
+ | |||
+ | |||
+ | **Примеры:** | ||
+ | |||
+ | <code javascript> | ||
+ | |||
+ | // Запрос | ||
+ | /* | ||
+ | GET https://server.ru/v2/request_filter/10401 | ||
+ | */ | ||
+ | |||
+ | //Ответ | ||
+ | [ | ||
+ | { | ||
+ | "filter_id": 13261, | ||
+ | "cnt_id": 10401, | ||
+ | "note": "Тестовый фильтр", | ||
+ | "employee_id": 127853, | ||
+ | "filter_data": "{\"period_exec\":-1,\"street\":\"Агатовая ул\",\"city\":\"all\",\"is_only_my\":0,\"period\":\"all\",\"custom_order\":\"create\",\"group_obj_id\":\"notSel\",\"resp_ids\":[],\"emp_ids\":[],\"rtype_ids\":[],\"status_ids\":[],\"type_ids\":[],\"ess_ids\":[],\"tag_ids\":[],\"house_ids\":[],\"flat_ids\":[],\"sort\":\"D\",\"search_phone\":\"\",\"keywords\":\"\",\"request_id\":\"\",\"add_type\":\"notSel\",\"add_less_than\":0,\"add_more_than\":0,\"add_more_less_select\":\"more\"}" | ||
+ | } | ||
+ | ] | ||
+ | </code> | ||
+ | |||
+ | ==== описание filter_data ==== | ||
+ | |||
+ | посмотреть описание полей можно тут: [[d24:develop:v2:backend:v2#получение_списка_заявок|]] | ||
+ | |||
+ | ^название^значение по дефолту | ||
+ | |period_exec|-1| | ||
+ | |street|"all"| | ||
+ | |city|"all"| | ||
+ | |is_only_my |0| | ||
+ | |period |"all" (обозначает все)| | ||
+ | |custom_order |"create"| | ||
+ | |group_obj_id |"notSel" (обозначает не выбрано)| | ||
+ | |resp_ids |[] (пустой массив)| | ||
+ | |emp_ids |[] (пустой массив)| | ||
+ | |rtype_ids |[] (пустой массив)| | ||
+ | |status_ids |[] (пустой массив)| | ||
+ | |type_ids |[] (пустой массив)| | ||
+ | |ess_ids |[] (пустой массив)| | ||
+ | |tag_ids |[] (пустой массив)| | ||
+ | |house_ids |[] (пустой массив)| | ||
+ | |flat_ids |[] (пустой массив)| | ||
+ | |sort |"D"| | ||
+ | |search_phone |"" (пустая строка)| | ||
+ | |keywords |""(пустая строка)| | ||
+ | |request_id |""(пустая строка)| | ||
+ | |add_type |"notSel" (обозначает не выбрано)| | ||
+ | |add_less_than |0| | ||
+ | |add_more_than |0| | ||
+ | |add_more_less_select |"more"| | ||
+ | |||
+ | **нужно добавить is_favorites в disp_front** |