Last modified by Андрей Калиновский on 2025/08/08 13:28
<
From version < 213.1 >
edited by Андрей Калиновский
on 2025/03/19 13:51
To version < 254.1 >
edited by Андрей Калиновский
on 2025/07/29 15:51
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -13,12 +13,10 @@
13 13  
14 14  (% class="box infomessage" %)
15 15  (((
16 -**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в пользовательских настройках.
16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
17 17  )))
18 18  
19 -При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
20 -
21 -
22 22  **Содержание страницы:**
23 23  )))
24 24  
... ... @@ -125,29 +125,41 @@
125 125  Запрос должен содержать данные параметра "**agentId**"
126 126  
127 127  (% style="color:#000000" %)Ответ:
126 +
127 +(((
128 128  {
129 - "agentId": "",  (%%)
130 - "parentId": "",
131 - "parentName": "string",
132 - "name": "string",
133 - "fullName": "string",
134 - "agentInfoType": 0,
135 - "isForeign": true/false,
136 - "district": "string", 
137 - "region": "string",
138 - "city": "string",
139 - "inn": "string",
140 - "kpp": "string",
141 - "address": "string",
142 - "addressFact": "string",
143 - "email": "string",
144 - "director": "string",
145 - "bankName": "string",
146 - "bankBIK": "string",
147 - "bankRS": "string",
148 - "bankKS": "string"
149 - }
129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
131 + "parentName": "string", ~/~/ Наименование агента
132 + "name": "string", ~/~/ Имя клиента
133 + "fullName": "string", ~/~/ ФИО клиента
134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
136 + "district": "string", ~/~/ Район
137 + "region": "string", ~/~/ Область
138 + "city": "string", ~/~/ Город
139 + "email": "string", ~/~/ Email
140 + "director": "string", ~/~/ Руководитель
141 + "RegionalData": [ ~/~/ Определяет региональные сведения.
142 + {
143 + "Country": 0, ~/~/ Страна
144 + "groups": [ ~/~/ Список групп
145 + {
146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 
147 + "fields": [ ~/~/ Список значений полей
148 + {
149 + "name": "string", ~/~/ Имя поля формы
150 + "value": "string" ~/~/ Значение поля формы
151 + }
152 + ]
153 + }
154 + ]
155 + }
156 + ]
157 +}
158 +)))
150 150  
160 +
151 151  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
152 152  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
153 153  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
... ... @@ -277,28 +277,6 @@
277 277   "bankKS": "string" ~/~/ корр. счёт
278 278  }
279 279  
280 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
281 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
282 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
283 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
284 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
285 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
286 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
287 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
288 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
289 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
290 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
291 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
292 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
293 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
294 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
295 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
296 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
297 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
298 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
299 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
300 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
301 -
302 302  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
303 303  
304 304  (% class="box warningmessage" %)
... ... @@ -444,7 +444,7 @@
444 444   [
445 445   "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
446 446   ],
447 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
448 448  }
449 449  {
450 450   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -756,6 +756,11 @@
756 756  (% style="text-align:left" %)
757 757  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
758 758  
747 +(% class="wikigeneratedid" id="H" %)
748 +(((
749 +
750 +)))
751 +
759 759  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
760 760  
761 761  == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
... ... @@ -867,7 +867,7 @@
867 867  {
868 868   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
869 869   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
870 - "deleted": true,
863 + "deleted": false,
871 871   "extId": "string",
872 872   "name": "string",
873 873   "picture": "string",
... ... @@ -886,7 +886,7 @@
886 886  {
887 887   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
888 888   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
889 - "deleted": true,
882 + "deleted": false,
890 890   "extId": "string",
891 891   "name": "string",
892 892   "picture": "string",
... ... @@ -920,7 +920,7 @@
920 920  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
921 921  )))
922 922  
923 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
924 924  
925 925  (% style="color:#000000" %)Метод запроса: **PUT**
926 926  
... ... @@ -987,7 +987,7 @@
987 987  (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
988 988  )))
989 989  
990 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
991 991  
992 992  (% style="color:#000000" %)Метод запроса: **DELETE**
993 993  
... ... @@ -1618,77 +1618,6 @@
1618 1618  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1619 1619  
1620 1620  
1621 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1622 -
1623 -(% class="box successmessage" %)
1624 -(((
1625 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1626 -)))
1627 -
1628 -Метод запроса: **POST**
1629 -
1630 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1631 -
1632 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1633 -
1634 -
1635 -Ответ:
1636 -
1637 -{
1638 -
1639 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1640 -
1641 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1642 -
1643 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1644 -
1645 - "Message": "string", ~/~/ Информация о выполнении запроса
1646 -
1647 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1648 -
1649 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1650 -
1651 - "Data": "string" ~/~/ Данные
1652 -
1653 -}
1654 -
1655 -
1656 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1657 -
1658 -(% class="box infomessage" %)
1659 -(((
1660 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1661 -)))
1662 -
1663 -Метод запроса: **GET**
1664 -
1665 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1666 -
1667 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1668 -
1669 -
1670 -Ответ:
1671 -
1672 -{
1673 -
1674 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1675 -
1676 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1677 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1678 -
1679 - "Message": "string", ~/~/ Информация о выполнении запроса
1680 -
1681 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1682 -
1683 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1684 -
1685 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1686 -
1687 - "Data": "string" ~/~/ Данные
1688 -
1689 -}
1690 -
1691 -
1692 1692  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1693 1693  
1694 1694  (% class="box infomessage" %)
... ... @@ -1834,7 +1834,6 @@
1834 1834   "stage": "", ~/~/ Состояние
1835 1835  (% style="color:#000000" %) }
1836 1836  
1837 -== ==
1838 1838  
1839 1839  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1840 1840  
... ... @@ -2451,7 +2451,7 @@
2451 2451  Тело запроса:
2452 2452  
2453 2453  {
2454 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2455 2455   "vehicleIds": [0], ~/~/ Список ID объектов
2456 2456   "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2457 2457   "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
... ... @@ -2498,7 +2498,7 @@
2498 2498  Тело запроса:
2499 2499  
2500 2500  {
2501 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2422 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2502 2502   "vehicleIds": [0], ~/~/ Список ID объектов
2503 2503   "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2504 2504   "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
... ... @@ -2517,8 +2517,12 @@
2517 2517   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2518 2518   "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2519 2519   "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2441 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2442 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2520 2520   "fuelConsumption": 0, ~/~/ Расход топлива
2521 2521   "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2445 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2446 +
2522 2522   }
2523 2523   ]
2524 2524   }
... ... @@ -2564,7 +2564,8 @@
2564 2564   "model": "string", ~/~/ Модель объекта
2565 2565   "fuels": [ ~/~/ Массив данным по заправкам и сливам
2566 2566   {
2567 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2492 + "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling
2493 +
2568 2568   "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2569 2569   "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2570 2570   "valueFuel": 0, ~/~/ Количество
... ... @@ -2643,26 +2643,50 @@
2643 2643  В заголовках запроса: X-Auth: Токен авторизации
2644 2644  
2645 2645  
2646 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2572 +В массиве указываем id объектов через запятую
2647 2647  
2648 2648  Ответ:
2575 +
2576 +[
2649 2649   {
2650 - "vehicleId": 0, ~/~/Идентификатор объекта.
2651 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2652 - "vehicleNumber": "string",~/~/Номер объекта.
2653 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2654 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2655 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2656 - "speed": 0,~/~/Скорость объекта.
2657 - "course": 0,~/~/Курс движения [0;360]
2658 - "latitude": 0,~/~/Широта [-90°;90°].
2659 - "longitude": 0,~/~/Долгота [-180°;180°].
2660 - "address": "string",~/~/Адрес.
2661 - "geozones": [ ~/~/Сведения по геозонам.
2578 + "vehicleId": 55728, ~/~/ Идентификатор объекта 
2579 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 
2580 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 
2581 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 
2582 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 
2583 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2584 + "speed": 31, ~/~/ Скорость объекта 
2585 + "course": 116, ~/~/ Курс движения [0;360]
2586 + "latitude": 45.722128, ~/~/ Широта [-90°;90°].
2587 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
2588 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 
2589 + "geozones": [ ~/~/ Сведения по геозонам. 
2662 2662   {
2663 - "id": 0,
2664 - "name": "string"
2591 + "id": 10225647, ~/~/ ID Геозоны 
2592 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2593 + },
2594 + {
2595 + "id": 10282875, ~/~/ ID Геозоны 
2596 + "name": "Ё2" ~/~/ Наименование геозоны 
2597 + },
2598 + {
2599 + "id": 10226240, ~/~/ ID Геозоны 
2600 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2601 + },
2602 + {
2603 + "id": 9747869, ~/~/ ID Геозоны 
2604 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2605 + },
2606 + {
2607 + "id": 10221123, ~/~/ ID Геозоны 
2608 + "name": "53r" ~/~/ Наименование геозоны 
2609 + },
2610 + {
2611 + "id": 10197638, ~/~/ ID Геозоны 
2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2665 2665   }
2614 + ]
2615 + }
2666 2666  
2667 2667  
2668 2668  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
... ... @@ -2793,6 +2793,35 @@
2793 2793   }
2794 2794  ]
2795 2795  
2746 +
2747 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2748 +
2749 +(% class="box successmessage" %)
2750 +(((
2751 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2752 +)))
2753 +
2754 +(% style="color:#000000" %)Метод запроса: **PUT**
2755 +
2756 +Пример запроса:
2757 +
2758 +(((
2759 +{
2760 + "id": 0,  ~/~/ Идентификатор объекта геозоны
2761 + "name": "string",  ~/~/ Наименование объекта геозоны
2762 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2763 + "description": "string", ~/~/ Описание объекта геозоны
2764 + "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2765 + "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2766 + "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2767 +}
2768 +)))
2769 +
2770 +
2771 +Пример ответа:
2772 +
2773 +200 ~/~/ Success
2774 +
2796 2796  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2797 2797  
2798 2798  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -2824,7 +2824,7 @@
2824 2824   "id": 0, ~/~/ ID уведомления
2825 2825   "name": "string", ~/~/ Название уведомления
2826 2826   "active": true, ~/~/ Состояние true - активен, false - деактивирован
2827 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2806 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2828 2828   "userId": "", ~/~/ Пользователь, создавший уведомление
2829 2829   "parentId": "", ~/~/ Идентификатор клиента
2830 2830   "parentName": "string" ~/~/ Имя клиента
... ... @@ -2831,6 +2831,155 @@
2831 2831   }
2832 2832  ]
2833 2833  
2813 +
2814 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2815 +
2816 +(% class="box infomessage" %)
2817 +(((
2818 +**POST /api/v3/notifications**
2819 +)))
2820 +
2821 +Метод запроса **POST**
2822 +
2823 +(% style="text-align: left;" %)
2824 +(% style="color:#000000" %)Пример запроса
2825 +
2826 +(((
2827 +{
2828 + "id": 0, ~/~/ ID правила
2829 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2830 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2831 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2832 + "name": "string", ~/~/ Имя правила
2833 + "active": true, ~/~/ Активность правила
2834 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2835 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2836 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2837 + ],
2838 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2839 + 0
2840 + ],
2841 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2842 + 0
2843 + ],
2844 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2845 + 0
2846 + ],
2847 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2848 + "additionalProp1": "string",  
2849 + "additionalProp2": "string",
2850 + "additionalProp3": "string"
2851 + },
2852 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2853 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2854 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2855 + ],
2856 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2857 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2858 + "string"
2859 + ],
2860 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2861 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2862 + {
2863 + "id": 0, ~/~/ Идентификатор участника чата.
2864 + "info": "string" ~/~/ Дополнительные сведения.
2865 + }
2866 + ],
2867 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2868 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2869 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2870 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2871 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2872 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2873 + "timezone": 0, ~/~/ часовой пояс 
2874 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2875 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2876 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2877 + {
2878 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2879 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2880 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2881 + "additionalProp1": "string",
2882 + "additionalProp2": "string",
2883 + "additionalProp3": "string"
2884 + }
2885 + }
2886 + ]
2887 +}
2888 +)))
2889 +
2890 +(((
2891 +
2892 +)))
2893 +
2894 +(((
2895 +
2896 +)))
2897 +
2898 +Ответ:
2899 +
2900 +{
2901 + "id": 0, ~/~/ ID правила
2902 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2903 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2904 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2905 + "name": "string", ~/~/ Имя правила
2906 + "active": true, ~/~/ Активность правила
2907 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2908 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2909 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2910 + ],
2911 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2912 + 0
2913 + ],
2914 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2915 + 0
2916 + ],
2917 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2918 + 0
2919 + ],
2920 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2921 + "additionalProp1": "string",  
2922 + "additionalProp2": "string",
2923 + "additionalProp3": "string"
2924 + },
2925 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2926 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2927 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2928 + ],
2929 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2930 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2931 + "string"
2932 + ],
2933 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2934 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2935 + {
2936 + "id": 0, ~/~/ Идентификатор участника чата.
2937 + "info": "string" ~/~/ Дополнительные сведения.
2938 + }
2939 + ],
2940 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2941 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2942 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2943 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2944 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2945 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2946 + "timezone": 0, ~/~/ часовой пояс 
2947 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2948 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2949 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2950 + {
2951 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2952 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2953 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2954 + "additionalProp1": "string",
2955 + "additionalProp2": "string",
2956 + "additionalProp3": "string"
2957 + }
2958 + }
2959 + ]
2960 +}
2961 +
2834 2834  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2835 2835  
2836 2836  (% class="box infomessage" %)
... ... @@ -4048,16 +4048,12 @@
4048 4048  Тело запроса:
4049 4049  
4050 4050  {
4051 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4052 - "Balance": 0
4179 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4180 + "Balance": 0 ~/~/ Значение баланса.
4053 4053  }
4054 4054  
4055 4055  Ответ: Success
4056 4056  
4057 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4058 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4059 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4060 -
4061 4061  == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4062 4062  
4063 4063  (% class="box warningmessage" %)
... ... @@ -4069,16 +4069,29 @@
4069 4069  
4070 4070  Тело запроса:
4071 4071  
4196 +(((
4072 4072  {
4073 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4074 - "Balance": 0
4198 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4199 + "amount": 0 ~/~/ Сумма пополнения баланса 
4075 4075  }
4201 +)))
4076 4076  
4203 +(((
4204 +
4205 +)))
4206 +
4077 4077  Ответ: Success
4078 4078  
4079 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4080 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4081 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4209 +(((
4210 +{
4211 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4212 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4213 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4214 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4215 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4216 + "Description": "string" ~/~/ Описание корректировки.
4217 +}
4218 +)))
4082 4082  
4083 4083  == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4084 4084  
... ... @@ -4091,16 +4091,25 @@
4091 4091  
4092 4092  Тело запроса:
4093 4093  
4231 +(((
4094 4094  {
4095 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4096 - "Balance": 0
4233 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4234 + "amount": 0 ~/~/ Сумма списания с баланса
4097 4097  }
4236 +)))
4098 4098  
4099 4099  Ответ: Success
4100 4100  
4101 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4102 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4103 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4240 +(((
4241 +{
4242 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4243 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4244 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4245 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4246 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4247 + "Description": "string" ~/~/ Описание корректировки
4248 +}
4249 +)))
4104 4104  
4105 4105  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4106 4106  
... ... @@ -4111,28 +4111,35 @@
4111 4111  
4112 4112  Тело запроса:
4113 4113  
4260 +(((
4114 4114  {
4115 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4116 - "CalculationType": 0,
4117 - "PermissibleBalance": 0,
4118 - "DefermentDays": 0,
4119 - "SendUiNotifications": true,
4120 - "SendEmailNotifications": true,
4121 - "IsPrivate": true,
4262 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4263 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4264 + "PermissibleBalance": 0, ~/~/ Допустимый баланс
4265 + "DefermentDays": 0, ~/~/ Отсрочка (дни).
4266 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4267 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4122 4122  }
4269 +)))
4123 4123  
4271 +(((
4272 +
4273 +)))
4274 +
4124 4124  Ответ: Success
4125 4125  
4126 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4127 -|ClientId|Идентификатор клиента
4128 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4129 -|PermissibleBalance|Допустимый баланс
4130 -|DefermentDays|(((
4131 -Отсрочка, количество дней
4277 +(((
4278 +{
4279 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4280 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4281 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4282 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4283 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4284 + "DefermentDays": 0, ~/~/ Отсрочка (дни)
4285 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4286 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4287 +}
4132 4132  )))
4133 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4134 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4135 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4136 4136  
4137 4137  == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4138 4138  
... ... @@ -4144,35 +4144,68 @@
4144 4144  Тело запроса:
4145 4145  
4146 4146  {
4147 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4148 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4149 - "Features": [
4300 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4301 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4302 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4150 4150   {
4151 - "Feature": "string",
4152 - "IsEnabled": true,
4153 - "IsFactual": true,
4154 - "Limit": 0,
4155 - "Price": 0,
4156 - "DebitDate": "2023-10-18T13:26:58.987Z",
4157 - "PeriodValue": 0,
4158 - "PeriodType": 0
4304 + "Feature": "string", ~/~/ Код услуги.
4305 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4306 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4307 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4308 + "Price": 0, ~/~/ Цена за единицу.
4309 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4310 + "PeriodValue": 0, ~/~/ Значение периода.
4311 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4159 4159   }
4160 4160   ]
4161 4161  }
4162 4162  
4316 +
4163 4163  Ответ: Success
4164 4164  
4165 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4166 -|ClientId|Идентификатор клиента
4167 -|PlanId|Идентификатор тарифного плана
4168 -|Feature|Код услуги
4169 -|IsEnabled|Признак, определяющий активирована ли услуга
4170 -|IsFactual|Признак, определяющий расчёт по факту
4171 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4172 -|Price|Цена за единицу.
4173 -|DebitDate|Следующий момент времени списания с баланса за услугу.
4174 -|PeriodValue|Значение периода.
4175 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4319 +(((
4320 +{
4321 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4322 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4323 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4324 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4325 + "Name": "string", ~/~/ Наименование.
4326 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4327 + "Constraint": { ~/~/ Ограничения по тарифу 
4328 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4329 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4330 + "DefermentDays": 0 ~/~/ Отсрочка (дни)
4331 + },
4332 + "Features": [ ~/~/ Набор услуг по тарифному плану.
4333 + {
4334 + "Feature": "string", ~/~/Код услуги.
4335 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4336 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4337 + "Price": 0, ~/~/ Цена за единицу.
4338 + "PeriodValue": 0, ~/~/ Значение периода.
4339 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4340 + }
4341 + ],
4342 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4343 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4344 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4345 + },
4346 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4347 + {
4348 + "Feature": "string", ~/~/ Код услуги.
4349 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4350 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4351 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4352 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4353 + "Price": 0, ~/~/ Цена за единицу.
4354 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4355 + "PeriodValue": 0, ~/~/ Значение периода.
4356 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4357 + "Quantity": 0 ~/~/ Количество использования услуги.
4358 + }
4359 + ]
4360 +}
4361 +)))
4176 4176  
4177 4177  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4178 4178  
... ... @@ -4277,6 +4277,43 @@
4277 4277  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4278 4278  |msgCount|Кол-во обработанных сообщений всего
4279 4279  
4466 +== **Импортировать историю ТС (Асинхронный запрос)** ==
4467 +
4468 +(% class="box successmessage" %)
4469 +(((
4470 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4471 +)))
4472 +
4473 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4474 +
4475 +Метод запроса: **POST**
4476 +
4477 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4478 +
4479 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4480 +
4481 +
4482 +Ответ:
4483 +
4484 +{
4485 +
4486 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4487 +
4488 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4489 +
4490 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4491 +
4492 + "Message": "string", ~/~/ Информация о выполнении запроса
4493 +
4494 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4495 +
4496 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4497 +
4498 + "Data": "string" ~/~/ Данные
4499 +
4500 +}
4501 +
4502 +
4280 4280  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4281 4281  
4282 4282  (% class="box infomessage" %)
... ... @@ -4294,10 +4294,59 @@
4294 4294   "message": "string"
4295 4295  }
4296 4296  
4297 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4298 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4299 -|progress|Guid ТС
4520 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4521 +**Параметр**
4522 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4523 +**Описание**
4524 +)))
4525 +|(((
4526 +activity
4527 +)))|(((
4528 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4529 +)))
4530 +|(((
4531 +progress
4532 +)))|(((
4533 +Guid ТС
4534 +)))
4300 4300  
4536 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4537 +
4538 +(% class="box infomessage" %)
4539 +(((
4540 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4541 +)))
4542 +
4543 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4544 +
4545 +Метод запроса: **GET**
4546 +
4547 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4548 +
4549 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4550 +
4551 +
4552 +Ответ:
4553 +
4554 +{
4555 +
4556 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4557 +
4558 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
4559 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4560 +
4561 + "Message": "string", ~/~/ Информация о выполнении запроса
4562 +
4563 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4564 +
4565 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4566 +
4567 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4568 +
4569 + "Data": "string" ~/~/ Данные
4570 +
4571 +}
4572 +
4301 4301  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4302 4302  
4303 4303  (% class="box infomessage" %)
... ... @@ -4809,8 +4809,51 @@
4809 4809   }
4810 4810   ]
4811 4811  }
5084 +
5085 +
5086 +== **Превышение скорости** ==
5087 +
5088 +(% class="box infomessage" %)
5089 +(((
5090 +**POST /api/v3/Reports/overSpeedDuration**
4812 4812  )))
4813 4813  
5093 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
5094 +
5095 +Пример запроса:
5096 +
5097 +(((
5098 +{
5099 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
5100 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
5101 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
5102 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5103 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
5104 +}
5105 +)))
5106 +
5107 +(((
5108 +
5109 +)))
5110 +
5111 +(((
5112 +Пример ответа:
5113 +)))
5114 +
5115 +(((
5116 +(((
5117 +[
5118 + {
5119 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
5120 + "duration": 0, ~/~/ Продолжительность события в секундах 
5121 + "maxSpeed": 0, ~/~/ Максимальная скорость 
5122 + "speedLimit": 0 ~/~/ Ограничение скорости 
5123 + }
5124 +]
5125 +)))
5126 +)))
5127 +)))
5128 +
4814 4814  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4815 4815  
4816 4816  
... ... @@ -5116,33 +5116,9 @@
5116 5116  )))
5117 5117  
5118 5118  
5119 -== **Удаление существующего поля** ==
5120 -
5121 -(% class="box errormessage" %)
5122 5122  (((
5123 -**DELETE /api/v3/agroLands/{id}**
5124 -)))
5125 -
5126 -Пример запроса:
5127 -id  ~/~/ Идентификатор поля
5128 -
5129 -Пример ответа:
5130 -
5131 5131  (((
5132 -200 ~/~/ Успех
5133 -)))
5134 -
5135 5135  (((
5136 -
5137 -)))
5138 -
5139 -(((
5140 -(((
5141 -(((
5142 -
5143 -)))
5144 -
5145 -(((
5146 5146  == **Изменение поля** ==
5147 5147  
5148 5148  (% class="box infomessage" %)
... ... @@ -5388,9 +5388,102 @@
5388 5388   "perimetr": 0, ~/~/ ериметр, м
5389 5389   "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5390 5390  }
5682 +
5683 +
5684 +== **Какие поля посещал объект** ==
5685 +
5686 +(% class="box successmessage" %)
5687 +(((
5688 +**POST /api/v3/agroLands/visitingByVehicle**
5391 5391  )))
5392 5392  
5691 +Пример запроса:
5393 5393  
5693 +{
5694 + "vehicleId": 0, ~/~/ id объекта 
5695 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5696 + "byTime": 0, ~/~/ Объединение событий по времени
5697 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5698 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5699 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
5700 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
5701 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5702 +}
5703 +
5704 +Пример ответа:
5705 +
5706 +[
5707 + {
5708 + "fieldId": 0, ~/~/ id объекта 
5709 + "vehicleName": "string", ~/~/ Наименование объекта 
5710 + "fieldName": "string", ~/~/ Наименование поля 
5711 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5712 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5713 + "vehicleId": 0, ~/~/ Идентификатор ТС
5714 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
5715 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
5716 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5717 + "mileage": 0 ~/~/ Пробег 
5718 + }
5719 +]
5720 +)))
5721 +
5722 +
5723 +== **Посещение поля объектами ** ==
5724 +
5725 +(% class="box successmessage" %)
5726 +(((
5727 +**POST /api/v3/agroLands/visitingByField**
5728 +)))
5729 +
5730 +Пример запроса:
5731 +{
5732 + "fieldId": 0, ~/~/ ID поля
5733 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5734 + "byTime": 0, ~/~/ Объединение событий по времени
5735 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5736 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5737 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
5738 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
5739 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5740 +}
5741 +
5742 +Пример ответа:
5743 +
5744 +[
5745 + {
5746 + "fieldId": 0, ~/~/ ID поля
5747 + "vehicleName": "string", ~/~/ Наименование объекта 
5748 + "fieldName": "string", ~/~/ Имя поля
5749 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5750 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5751 + "vehicleId": 0, ~/~/ Идентификатор ТС
5752 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
5753 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
5754 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5755 + "mileage": 0 ~/~/ Пробег
5756 + }
5757 +]
5758 +
5759 +
5760 +== **Удаление существующего поля** ==
5761 +
5762 +(% class="box errormessage" %)
5763 +(((
5764 +**DELETE /api/v3/agroLands/{id}**
5765 +)))
5766 +
5767 +Пример запроса:
5768 +id  ~/~/ Идентификатор поля
5769 +
5770 +Пример ответа:
5771 +
5772 +(((
5773 +200 ~/~/ Успех
5774 +
5775 +
5776 +)))
5777 +
5394 5394  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5395 5395  )))
5396 5396  )))
... ... @@ -5815,49 +5815,129 @@
5815 5815  )))
5816 5816  
5817 5817  
6202 += **Раздел: Роли** =
6203 +
6204 +== **Получение списка клиентских и системных ролей пользователя ** ==
6205 +
6206 +(% class="box successmessage" %)
6207 +(((
6208 +**POST /api/v3/groups/find**
6209 +)))
6210 +
6211 +Пример запроса:
6212 +
6213 +(((
6214 +{
6215 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6216 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6217 +}
6218 +)))
6219 +
6220 +(((
6221 +
6222 +)))
6223 +
6224 +(((
6225 +Пример ответа:
6226 +)))
6227 +
6228 +(((
6229 +(((
6230 +{
6231 + "groups": [  ~/~/ Системные роли пользователя
6232 + {
6233 + "code": "string", ~/~/ Код роли.
6234 + "name": "string", ~/~/ Имя  
6235 + "shortName": "string" ~/~/ Короткое имя 
6236 + }
6237 + ],
6238 + "customGroups": [ ~/~/ Системные роли пользователя
6239 + {
6240 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6241 + "name": "string", ~/~/ Наименование 
6242 + "shortName": "string", ~/~/ Короткое наименование 
6243 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6244 + }
6245 + ]
6246 +}
6247 +)))
6248 +)))
6249 +
6250 +(((
6251 +
6252 +)))
6253 +
6254 +(((
6255 +
6256 +)))
6257 +
5818 5818  = **Раздел: Локатор ** =
5819 5819  
5820 5820  
5821 -== **Получение списка локаторов, доступных пользователю ** ==
6261 +== **Получение данных по локатору** ==
5822 5822  
5823 5823  (% class="box infomessage" %)
5824 5824  (((
5825 -**GET /api/v3/locators**
6265 +**GET /api/v3/locators/{locatorId}**
5826 5826  )))
5827 5827  
5828 -В заголовках запроса: X-Auth: Токен авторизации
6268 +В запросе указывается locatorid - идентификатор локатора
5829 5829  
5830 5830  
5831 5831  Пример ответа:
5832 5832  
5833 5833  (((
5834 -[
5835 - {
5836 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5837 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5838 - "agentName": "string", ~/~/ Наименование агента.
5839 - "isEnabled": true, ~/~/ Активен 
5840 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5841 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5842 - "name": "string", ~/~/ Наименование
5843 - "status": 0, ~/~/ 
5844 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5845 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5846 - "validity": 0, ~/~/ Срок действия в днях (1-90).
5847 - "autoProlongation": true, ~/~/ Автопродление срока действия.
5848 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5849 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5850 - "url": "string", ~/~/ Ссылка
5851 - "language": 0, ~/~/ Язык.
5852 - "vehiclesCount": 0, ~/~/ Количество объектов.
5853 - "geozonesCount": 0, ~/~/ Количество геозон.
5854 - "fieldsCount": 0 ~/~/ Количество полей.
5855 - }
5856 -]
6274 +(((
6275 +{
6276 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6277 + 0
6278 + ],
6279 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6280 + 0
6281 + ],
6282 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6283 + 0
6284 + ],
6285 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6286 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6287 + "agentName": "string", ~/~/ Наименование агента.
6288 + "isEnabled": true, ~/~/ Активность 
6289 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6290 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6291 + "name": "string", ~/~/ Наименование.
6292 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6293 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6294 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6295 + "validity": 0, ~/~/ Значение срока действия
6296 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6297 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6298 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6299 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6300 + "url": "string", ~/~/ Ссылка
6301 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6302 +
6303 + "showVehicleName": true, ~/~/ Наименование объекта
6304 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6305 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6306 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6307 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6308 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6309 +
6310 + 1
6311 +
6312 + ]
6313 +}
5857 5857  )))
6315 +)))
5858 5858  
5859 5859  
6318 +(((
6319 +(((
6320 +
6321 +)))
6322 +)))
5860 5860  
6324 +
5861 5861  == **Создание локатора** ==
5862 5862  
5863 5863  (% class="box successmessage" %)
... ... @@ -5869,7 +5869,6 @@
5869 5869  
5870 5870  (((
5871 5871  {
5872 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5873 5873   "isEnabled": true, ~/~/ Активность
5874 5874   "name": "string", ~/~/ Наименование локатора
5875 5875   "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
... ... @@ -5876,8 +5876,28 @@
5876 5876   "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
5877 5877   "validity": 0, ~/~/ Срок действия в днях (1-90)
5878 5878   "autoProlongation": true, ~/~/ Автопродление срока действия.
5879 - "url": "string", ~/~/ Ссылка
5880 - "language": 0 ~/~/ Язык
6342 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6343 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6344 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6345 + 0
6346 + ],
6347 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6348 + 0
6349 + ],
6350 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6351 + 0
6352 + ],
6353 +
6354 + "showVehicleName": true, ~/~/ Наименование объекта
6355 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6356 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6357 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6358 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6359 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6360 +
6361 + 1
6362 +
6363 + ]
5881 5881  }
5882 5882  )))
5883 5883  
... ... @@ -5889,7 +5889,69 @@
5889 5889  )))
5890 5890  
5891 5891  
6375 +== **Выводит список локаторов ** ==
5892 5892  
6377 +(% class="box successmessage" %)
6378 +(((
6379 +**POST /api/v3/locators/find**
6380 +)))
6381 +
6382 +Пример запроса:
6383 +
6384 +(((
6385 +{
6386 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
6387 +}
6388 +)))
6389 +
6390 +(((
6391 +
6392 +)))
6393 +
6394 +(((
6395 +
6396 +)))
6397 +
6398 +
6399 +Пример ответа:
6400 +
6401 +(((
6402 +[
6403 + {
6404 + "vehiclesCount": 0, ~/~/ Количество объектов.
6405 + "geozonesCount": 0, ~/~/ Количество геозон.
6406 + "fieldsCount": 0, ~/~/ Количество полей.
6407 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6408 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
6409 + "agentName": "string", ~/~/ Наименование агента.
6410 + "isEnabled": true, ~/~/ Активность локатора
6411 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
6412 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 
6413 + "name": "string", ~/~/ Наименование локатора 
6414 + "status": 0,  ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6415 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6416 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
6417 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6418 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6419 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 
6420 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6421 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 
6422 + "url": "string", ~/~/ ссылка на локатор 
6423 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6424 + "showVehicleName": true, ~/~/ Наименование объекта
6425 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6426 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6427 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6428 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6429 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6430 +
6431 + 0
6432 + ]
6433 + }
6434 +]
6435 +)))
6436 +
6437 +
5893 5893  == **Изменение локатора** ==
5894 5894  
5895 5895  (% class="box infomessage" %)
... ... @@ -5908,12 +5908,31 @@
5908 5908   "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
5909 5909   "validity": 0, ~/~/ Срок действия в днях (1-90)
5910 5910   "autoProlongation": true, ~/~/ Автопродление срока действия
5911 - "url": "string", ~/~/ Ссылка
5912 - "language": 0 ~/~/ Язык
6456 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6457 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6458 + 0
6459 + ],
6460 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6461 + 0
6462 + ],
6463 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6464 + 0
6465 + ],
6466 + "showVehicleName": true, ~/~/ Наименование объекта
6467 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6468 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6469 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6470 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6471 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6472 +
6473 + 0
6474 +
6475 + ]
5913 5913  }
6477 +
6478 +
5914 5914  )))
5915 5915  
5916 -
5917 5917  Пример ответа:
5918 5918  
5919 5919  200 ~/~/ Success
... ... @@ -5935,8 +5935,201 @@
5935 5935  )))
5936 5936  
5937 5937  
6502 += **Раздел: Яндекс Маршруты** =
5938 5938  
5939 5939  
6505 +== **Возвращение списка маршрутов** ==
6506 +
6507 +(% class="box infomessage" %)
6508 +(((
6509 +**GET /api/v3/TransportRoutes**
6510 +)))
6511 +
6512 +Пример запроса:
6513 +Id  ~/~/ Идентификатор поля
6514 +
6515 +Пример ответа:
6516 +
6517 +(((
6518 +[
6519 + {
6520 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6521 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6522 + "name": "string", ~/~/ Наименование маршрута.
6523 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6524 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6525 + 0
6526 + ]
6527 + }
6528 +]
6529 +)))
6530 +
6531 +
6532 +== **Добавить маршрут** ==
6533 +
6534 +(% class="box infomessage" %)
6535 +(((
6536 +**POST /api/v3/TransportRoutes**
6537 +)))
6538 +
6539 +Пример запроса: 
6540 +{
6541 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6542 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6543 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6544 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6545 + 0
6546 + ]
6547 +}
6548 +
6549 +
6550 +Пример ответа:
6551 +
6552 +(((
6553 +{
6554 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6555 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6556 + "name": "string", ~/~/ Определяет наименование маршрута 
6557 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6558 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6559 + 0
6560 + ]
6561 +}
6562 +)))
6563 +
6564 +
6565 +== **Обновление маршрута** ==
6566 +
6567 +(% class="box successmessage" %)
6568 +(((
6569 +**PUT /api/v3/TransportRoutes**
6570 +)))
6571 +
6572 +Пример запроса:
6573 +
6574 +(((
6575 +{
6576 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6577 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6578 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6579 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6580 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6581 + 0
6582 + ]
6583 +}
6584 +)))
6585 +
6586 +Пример ответа:
6587 +
6588 +(((
6589 +{
6590 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6591 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6592 + "name": "string", ~/~/ Определяет наименование маршрута 
6593 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6594 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6595 + 0
6596 + ]
6597 +}
6598 +)))
6599 +
6600 +
6601 +== **Получить связки маршрутов ТС** ==
6602 +
6603 +(% class="box infomessage" %)
6604 +(((
6605 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6606 +)))
6607 +
6608 +Пример запроса:
6609 +
6610 +(((
6611 +[
6612 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6613 +]
6614 +)))
6615 +
6616 +Пример ответа:
6617 +
6618 +(((
6619 +[
6620 + {
6621 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6622 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6623 + }
6624 +]
6625 +)))
6626 +
6627 +
6628 +== **Удалить маршрут** ==
6629 +
6630 +(% class="box warningmessage" %)
6631 +(((
6632 +**DELETE /api/v3/TransportRoutes/{id}**
6633 +)))
6634 +
6635 +Пример запроса:
6636 +Id  ~/~/ Идентификатор поля
6637 +
6638 +
6639 += **Раздел: Управление доступа к машинам** =
6640 +
6641 +
6642 +== Получение списка транспортных средств видимых пользователю ==
6643 +
6644 +(% class="box infomessage" %)
6645 +(((
6646 +**GET /api/v3/UserVisibleVehicles/{userId}**
6647 +)))
6648 +
6649 +Пример ответа:
6650 +
6651 +(((
6652 +{
6653 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6654 + 0
6655 + ]
6656 +}
6657 +)))
6658 +
6659 +
6660 +== Задает видимость транспортных средств пользователю ==
6661 +
6662 +(% class="box infomessage" %)
6663 +(((
6664 +**POST /api/v3/UserVisibleVehicles**
6665 +)))
6666 +
6667 +Пример запроса:
6668 +
6669 +(((
6670 +(((
6671 +{
6672 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6673 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6674 + 0
6675 + ]
6676 +}
6677 +)))
6678 +
6679 +(((
6680 +
6681 +)))
6682 +
6683 +(((
6684 +Пример ответа :
6685 +)))
6686 +
6687 +(((
6688 +
6689 +)))
6690 +
6691 +(((
6692 +200 ~/~/ Success
6693 +)))
6694 +)))
6695 +
6696 +
5940 5940  (% class="box" lang="en-US" style="text-align: center;" %)
5941 5941  (((
5942 5942  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

ГЛОНАССSoft wiki - 2024 г.