<
From version < 212.5 >
edited by Андрей Калиновский
on 2025/03/12 10:28
To version < 253.1 >
edited by Андрей Калиновский
on 2025/07/29 15:43
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -11,6 +11,11 @@
11 11  
12 12  В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13 13  
14 +(% class="box infomessage" %)
15 +(((
16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 +)))
14 14  
15 15  **Содержание страницы:**
16 16  )))
... ... @@ -118,29 +118,41 @@
118 118  Запрос должен содержать данные параметра "**agentId**"
119 119  
120 120  (% style="color:#000000" %)Ответ:
126 +
127 +(((
121 121  {
122 - "agentId": "",  (%%)
123 - "parentId": "",
124 - "parentName": "string",
125 - "name": "string",
126 - "fullName": "string",
127 - "agentInfoType": 0,
128 - "isForeign": true/false,
129 - "district": "string", 
130 - "region": "string",
131 - "city": "string",
132 - "inn": "string",
133 - "kpp": "string",
134 - "address": "string",
135 - "addressFact": "string",
136 - "email": "string",
137 - "director": "string",
138 - "bankName": "string",
139 - "bankBIK": "string",
140 - "bankRS": "string",
141 - "bankKS": "string"
142 - }
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 +)))
143 143  
160 +
144 144  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
145 145  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
146 146  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
... ... @@ -270,28 +270,6 @@
270 270   "bankKS": "string" ~/~/ корр. счёт
271 271  }
272 272  
273 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
274 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
275 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
276 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
277 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
278 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
279 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
280 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
281 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ
282 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион
283 -|(% style="width:215px" %)city|(% style="width:861px" %)Город
284 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
285 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
286 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
287 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
288 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
289 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
290 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
291 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
292 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
293 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
294 -
295 295  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
296 296  
297 297  (% class="box warningmessage" %)
... ... @@ -437,7 +437,7 @@
437 437   [
438 438   "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
439 439   ],
440 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
441 441  }
442 442  {
443 443   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -749,6 +749,11 @@
749 749  (% style="text-align:left" %)
750 750  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
751 751  
747 +(% class="wikigeneratedid" id="H" %)
748 +(((
749 +
750 +)))
751 +
752 752  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
753 753  
754 754  == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
... ... @@ -860,7 +860,7 @@
860 860  {
861 861   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
862 862   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
863 - "deleted": true,
863 + "deleted": false,
864 864   "extId": "string",
865 865   "name": "string",
866 866   "picture": "string",
... ... @@ -879,7 +879,7 @@
879 879  {
880 880   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
881 881   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
882 - "deleted": true,
882 + "deleted": false,
883 883   "extId": "string",
884 884   "name": "string",
885 885   "picture": "string",
... ... @@ -913,7 +913,7 @@
913 913  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
914 914  )))
915 915  
916 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
917 917  
918 918  (% style="color:#000000" %)Метод запроса: **PUT**
919 919  
... ... @@ -980,7 +980,7 @@
980 980  (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
981 981  )))
982 982  
983 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
984 984  
985 985  (% style="color:#000000" %)Метод запроса: **DELETE**
986 986  
... ... @@ -1611,77 +1611,6 @@
1611 1611  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1612 1612  
1613 1613  
1614 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1615 -
1616 -(% class="box successmessage" %)
1617 -(((
1618 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1619 -)))
1620 -
1621 -Метод запроса: **POST**
1622 -
1623 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1624 -
1625 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1626 -
1627 -
1628 -Ответ:
1629 -
1630 -{
1631 -
1632 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1633 -
1634 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1635 -
1636 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1637 -
1638 - "Message": "string", ~/~/ Информация о выполнении запроса
1639 -
1640 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1641 -
1642 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1643 -
1644 - "Data": "string" ~/~/ Данные
1645 -
1646 -}
1647 -
1648 -
1649 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1650 -
1651 -(% class="box infomessage" %)
1652 -(((
1653 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1654 -)))
1655 -
1656 -Метод запроса: **GET**
1657 -
1658 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1659 -
1660 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1661 -
1662 -
1663 -Ответ:
1664 -
1665 -{
1666 -
1667 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1668 -
1669 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1670 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1671 -
1672 - "Message": "string", ~/~/ Информация о выполнении запроса
1673 -
1674 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1675 -
1676 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1677 -
1678 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1679 -
1680 - "Data": "string" ~/~/ Данные
1681 -
1682 -}
1683 -
1684 -
1685 1685  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1686 1686  
1687 1687  (% class="box infomessage" %)
... ... @@ -1827,7 +1827,6 @@
1827 1827   "stage": "", ~/~/ Состояние
1828 1828  (% style="color:#000000" %) }
1829 1829  
1830 -== ==
1831 1831  
1832 1832  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1833 1833  
... ... @@ -2444,7 +2444,7 @@
2444 2444  Тело запроса:
2445 2445  
2446 2446  {
2447 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2448 2448   "vehicleIds": [0], ~/~/ Список ID объектов
2449 2449   "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2450 2450   "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
... ... @@ -2491,7 +2491,7 @@
2491 2491  Тело запроса:
2492 2492  
2493 2493  {
2494 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2422 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2495 2495   "vehicleIds": [0], ~/~/ Список ID объектов
2496 2496   "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2497 2497   "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
... ... @@ -2510,8 +2510,12 @@
2510 2510   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2511 2511   "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2512 2512   "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2441 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2442 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2513 2513   "fuelConsumption": 0, ~/~/ Расход топлива
2514 2514   "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2445 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2446 +
2515 2515   }
2516 2516   ]
2517 2517   }
... ... @@ -2557,7 +2557,8 @@
2557 2557   "model": "string", ~/~/ Модель объекта
2558 2558   "fuels": [ ~/~/ Массив данным по заправкам и сливам
2559 2559   {
2560 - "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 +
2561 2561   "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2562 2562   "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2563 2563   "valueFuel": 0, ~/~/ Количество
... ... @@ -2636,26 +2636,50 @@
2636 2636  В заголовках запроса: X-Auth: Токен авторизации
2637 2637  
2638 2638  
2639 теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2572 массиве указываем id объектов через запятую
2640 2640  
2641 2641  Ответ:
2575 +
2576 +[
2642 2642   {
2643 - "vehicleId": 0, ~/~/Идентификатор объекта.
2644 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2645 - "vehicleNumber": "string",~/~/Номер объекта.
2646 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2647 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2648 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2649 - "speed": 0,~/~/Скорость объекта.
2650 - "course": 0,~/~/Курс движения [0;360]
2651 - "latitude": 0,~/~/Широта [-90°;90°].
2652 - "longitude": 0,~/~/Долгота [-180°;180°].
2653 - "address": "string",~/~/Адрес.
2654 - "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": [ ~/~/ Сведения по геозонам. 
2655 2655   {
2656 - "id": 0,
2657 - "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" ~/~/ Наименование геозоны 
2658 2658   }
2614 + ]
2615 + }
2659 2659  
2660 2660  
2661 2661  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
... ... @@ -2786,6 +2786,35 @@
2786 2786   }
2787 2787  ]
2788 2788  
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 +
2789 2789  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2790 2790  
2791 2791  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -2817,7 +2817,7 @@
2817 2817   "id": 0, ~/~/ ID уведомления
2818 2818   "name": "string", ~/~/ Название уведомления
2819 2819   "active": true, ~/~/ Состояние true - активен, false - деактивирован
2820 - "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 - Назначение водителя) 
2821 2821   "userId": "", ~/~/ Пользователь, создавший уведомление
2822 2822   "parentId": "", ~/~/ Идентификатор клиента
2823 2823   "parentName": "string" ~/~/ Имя клиента
... ... @@ -2824,6 +2824,155 @@
2824 2824   }
2825 2825  ]
2826 2826  
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 +
2827 2827  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2828 2828  
2829 2829  (% class="box infomessage" %)
... ... @@ -4041,16 +4041,12 @@
4041 4041  Тело запроса:
4042 4042  
4043 4043  {
4044 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4045 - "Balance": 0
4179 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4180 + "Balance": 0 ~/~/ Значение баланса.
4046 4046  }
4047 4047  
4048 4048  Ответ: Success
4049 4049  
4050 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4051 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4052 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4053 -
4054 4054  == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4055 4055  
4056 4056  (% class="box warningmessage" %)
... ... @@ -4062,16 +4062,29 @@
4062 4062  
4063 4063  Тело запроса:
4064 4064  
4196 +(((
4065 4065  {
4066 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4067 - "Balance": 0
4198 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4199 + "amount": 0 ~/~/ Сумма пополнения баланса 
4068 4068  }
4201 +)))
4069 4069  
4203 +(((
4204 +
4205 +)))
4206 +
4070 4070  Ответ: Success
4071 4071  
4072 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4073 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4074 -|(% 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 +)))
4075 4075  
4076 4076  == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4077 4077  
... ... @@ -4084,16 +4084,25 @@
4084 4084  
4085 4085  Тело запроса:
4086 4086  
4231 +(((
4087 4087  {
4088 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4089 - "Balance": 0
4233 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4234 + "amount": 0 ~/~/ Сумма списания с баланса
4090 4090  }
4236 +)))
4091 4091  
4092 4092  Ответ: Success
4093 4093  
4094 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4095 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4096 -|(% 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 +)))
4097 4097  
4098 4098  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4099 4099  
... ... @@ -4104,28 +4104,35 @@
4104 4104  
4105 4105  Тело запроса:
4106 4106  
4260 +(((
4107 4107  {
4108 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4109 - "CalculationType": 0,
4110 - "PermissibleBalance": 0,
4111 - "DefermentDays": 0,
4112 - "SendUiNotifications": true,
4113 - "SendEmailNotifications": true,
4114 - "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 - выключено
4115 4115  }
4269 +)))
4116 4116  
4271 +(((
4272 +
4273 +)))
4274 +
4117 4117  Ответ: Success
4118 4118  
4119 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4120 -|ClientId|Идентификатор клиента
4121 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4122 -|PermissibleBalance|Допустимый баланс
4123 -|DefermentDays|(((
4124 -Отсрочка, количество дней
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 +}
4125 4125  )))
4126 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4127 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4128 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4129 4129  
4130 4130  == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4131 4131  
... ... @@ -4137,35 +4137,68 @@
4137 4137  Тело запроса:
4138 4138  
4139 4139  {
4140 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4141 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4142 - "Features": [
4300 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4301 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4302 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4143 4143   {
4144 - "Feature": "string",
4145 - "IsEnabled": true,
4146 - "IsFactual": true,
4147 - "Limit": 0,
4148 - "Price": 0,
4149 - "DebitDate": "2023-10-18T13:26:58.987Z",
4150 - "PeriodValue": 0,
4151 - "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 - Месяцы)
4152 4152   }
4153 4153   ]
4154 4154  }
4155 4155  
4316 +
4156 4156  Ответ: Success
4157 4157  
4158 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4159 -|ClientId|Идентификатор клиента
4160 -|PlanId|Идентификатор тарифного плана
4161 -|Feature|Код услуги
4162 -|IsEnabled|Признак, определяющий активирована ли услуга
4163 -|IsFactual|Признак, определяющий расчёт по факту
4164 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4165 -|Price|Цена за единицу.
4166 -|DebitDate|Следующий момент времени списания с баланса за услугу.
4167 -|PeriodValue|Значение периода.
4168 -|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 +)))
4169 4169  
4170 4170  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4171 4171  
... ... @@ -4270,6 +4270,43 @@
4270 4270  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4271 4271  |msgCount|Кол-во обработанных сообщений всего
4272 4272  
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 +
4273 4273  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4274 4274  
4275 4275  (% class="box infomessage" %)
... ... @@ -4287,10 +4287,59 @@
4287 4287   "message": "string"
4288 4288  }
4289 4289  
4290 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4291 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4292 -|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 +)))
4293 4293  
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 +
4294 4294  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4295 4295  
4296 4296  (% class="box infomessage" %)
... ... @@ -4802,8 +4802,51 @@
4802 4802   }
4803 4803   ]
4804 4804  }
5084 +
5085 +
5086 +== **Превышение скорости** ==
5087 +
5088 +(% class="box infomessage" %)
5089 +(((
5090 +**POST /api/v3/Reports/overSpeedDuration**
4805 4805  )))
4806 4806  
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 +
4807 4807  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4808 4808  
4809 4809  
... ... @@ -4878,13 +4878,16 @@
4878 4878  **POST /api/v3/agroLands**
4879 4879  )))
4880 4880  
5203 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5204 +X-agent  - ID клиента
5205 +
4881 4881  Пример запроса:
4882 4882  
4883 4883  (((
4884 4884  {
4885 4885   "extId": "string", 
4886 - "shape": "string", ~/~/ Форма поля
4887 - "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5211 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5212 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
4888 4888   "display": "string", ~/~/ Настройки отображения
4889 4889   "year": 0, ~/~/ Год поля
4890 4890   "name": "string", ~/~/ Наименование
... ... @@ -5106,23 +5106,8 @@
5106 5106  )))
5107 5107  
5108 5108  
5109 -== **Удаление существующего поля** ==
5110 5110  
5111 -(% class="box errormessage" %)
5112 5112  (((
5113 -**DELETE /api/v3/agroLands/{id}**
5114 -)))
5115 -
5116 -Пример запроса:
5117 -id  ~/~/ Идентификатор поля
5118 -
5119 -Пример ответа:
5120 -
5121 -(((
5122 -200 ~/~/ Успех
5123 -)))
5124 -
5125 -(((
5126 5126  
5127 5127  )))
5128 5128  
... ... @@ -5129,10 +5129,6 @@
5129 5129  (((
5130 5130  (((
5131 5131  (((
5132 -
5133 -)))
5134 -
5135 -(((
5136 5136  == **Изменение поля** ==
5137 5137  
5138 5138  (% class="box infomessage" %)
... ... @@ -5378,9 +5378,102 @@
5378 5378   "perimetr": 0, ~/~/ ериметр, м
5379 5379   "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5380 5380  }
5687 +
5688 +
5689 +== **Какие поля посещал объект** ==
5690 +
5691 +(% class="box successmessage" %)
5692 +(((
5693 +**POST /api/v3/agroLands/visitingByVehicle**
5381 5381  )))
5382 5382  
5696 +Пример запроса:
5383 5383  
5698 +{
5699 + "vehicleId": 0, ~/~/ id объекта 
5700 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5701 + "byTime": 0, ~/~/ Объединение событий по времени
5702 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5703 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5704 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
5705 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
5706 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5707 +}
5708 +
5709 +Пример ответа:
5710 +
5711 +[
5712 + {
5713 + "fieldId": 0, ~/~/ id объекта 
5714 + "vehicleName": "string", ~/~/ Наименование объекта 
5715 + "fieldName": "string", ~/~/ Наименование поля 
5716 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5717 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5718 + "vehicleId": 0, ~/~/ Идентификатор ТС
5719 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
5720 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
5721 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5722 + "mileage": 0 ~/~/ Пробег 
5723 + }
5724 +]
5725 +)))
5726 +
5727 +
5728 +== **Посещение поля объектами ** ==
5729 +
5730 +(% class="box successmessage" %)
5731 +(((
5732 +**POST /api/v3/agroLands/visitingByField**
5733 +)))
5734 +
5735 +Пример запроса:
5736 +{
5737 + "fieldId": 0, ~/~/ ID поля
5738 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5739 + "byTime": 0, ~/~/ Объединение событий по времени
5740 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5741 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5742 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
5743 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
5744 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5745 +}
5746 +
5747 +Пример ответа:
5748 +
5749 +[
5750 + {
5751 + "fieldId": 0, ~/~/ ID поля
5752 + "vehicleName": "string", ~/~/ Наименование объекта 
5753 + "fieldName": "string", ~/~/ Имя поля
5754 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5755 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5756 + "vehicleId": 0, ~/~/ Идентификатор ТС
5757 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
5758 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
5759 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5760 + "mileage": 0 ~/~/ Пробег
5761 + }
5762 +]
5763 +
5764 +
5765 +== **Удаление существующего поля** ==
5766 +
5767 +(% class="box errormessage" %)
5768 +(((
5769 +**DELETE /api/v3/agroLands/{id}**
5770 +)))
5771 +
5772 +Пример запроса:
5773 +id  ~/~/ Идентификатор поля
5774 +
5775 +Пример ответа:
5776 +
5777 +(((
5778 +200 ~/~/ Успех
5779 +
5780 +
5781 +)))
5782 +
5384 5384  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5385 5385  )))
5386 5386  )))
... ... @@ -5805,49 +5805,129 @@
5805 5805  )))
5806 5806  
5807 5807  
6207 += **Раздел: Роли** =
6208 +
6209 +== **Получение списка клиентских и системных ролей пользователя ** ==
6210 +
6211 +(% class="box successmessage" %)
6212 +(((
6213 +**POST /api/v3/groups/find**
6214 +)))
6215 +
6216 +Пример запроса:
6217 +
6218 +(((
6219 +{
6220 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6221 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6222 +}
6223 +)))
6224 +
6225 +(((
6226 +
6227 +)))
6228 +
6229 +(((
6230 +Пример ответа:
6231 +)))
6232 +
6233 +(((
6234 +(((
6235 +{
6236 + "groups": [  ~/~/ Системные роли пользователя
6237 + {
6238 + "code": "string", ~/~/ Код роли.
6239 + "name": "string", ~/~/ Имя  
6240 + "shortName": "string" ~/~/ Короткое имя 
6241 + }
6242 + ],
6243 + "customGroups": [ ~/~/ Системные роли пользователя
6244 + {
6245 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6246 + "name": "string", ~/~/ Наименование 
6247 + "shortName": "string", ~/~/ Короткое наименование 
6248 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6249 + }
6250 + ]
6251 +}
6252 +)))
6253 +)))
6254 +
6255 +(((
6256 +
6257 +)))
6258 +
6259 +(((
6260 +
6261 +)))
6262 +
5808 5808  = **Раздел: Локатор ** =
5809 5809  
5810 5810  
5811 -== **Получение списка локаторов, доступных пользователю ** ==
6266 +== **Получение данных по локатору** ==
5812 5812  
5813 5813  (% class="box infomessage" %)
5814 5814  (((
5815 -**GET /api/v3/locators**
6270 +**GET /api/v3/locators/{locatorId}**
5816 5816  )))
5817 5817  
5818 -В заголовках запроса: X-Auth: Токен авторизации
6273 +В запросе указывается locatorid - идентификатор локатора
5819 5819  
5820 5820  
5821 5821  Пример ответа:
5822 5822  
5823 5823  (((
5824 -[
5825 - {
5826 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5827 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5828 - "agentName": "string", ~/~/ Наименование агента.
5829 - "isEnabled": true, ~/~/ Активен 
5830 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5831 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5832 - "name": "string", ~/~/ Наименование
5833 - "status": 0, ~/~/ 
5834 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5835 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5836 - "validity": 0, ~/~/ Срок действия в днях (1-90).
5837 - "autoProlongation": true, ~/~/ Автопродление срока действия.
5838 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5839 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5840 - "url": "string", ~/~/ Ссылка
5841 - "language": 0, ~/~/ Язык.
5842 - "vehiclesCount": 0, ~/~/ Количество объектов.
5843 - "geozonesCount": 0, ~/~/ Количество геозон.
5844 - "fieldsCount": 0 ~/~/ Количество полей.
5845 - }
5846 -]
6279 +(((
6280 +{
6281 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6282 + 0
6283 + ],
6284 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6285 + 0
6286 + ],
6287 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6288 + 0
6289 + ],
6290 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6291 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6292 + "agentName": "string", ~/~/ Наименование агента.
6293 + "isEnabled": true, ~/~/ Активность 
6294 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6295 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6296 + "name": "string", ~/~/ Наименование.
6297 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6298 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6299 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6300 + "validity": 0, ~/~/ Значение срока действия
6301 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6302 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6303 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6304 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6305 + "url": "string", ~/~/ Ссылка
6306 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6307 +
6308 + "showVehicleName": true, ~/~/ Наименование объекта
6309 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6310 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6311 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6312 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6313 + "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ГИС)
6314 +
6315 + 1
6316 +
6317 + ]
6318 +}
5847 5847  )))
6320 +)))
5848 5848  
5849 5849  
6323 +(((
6324 +(((
6325 +
6326 +)))
6327 +)))
5850 5850  
6329 +
5851 5851  == **Создание локатора** ==
5852 5852  
5853 5853  (% class="box successmessage" %)
... ... @@ -5859,7 +5859,6 @@
5859 5859  
5860 5860  (((
5861 5861  {
5862 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5863 5863   "isEnabled": true, ~/~/ Активность
5864 5864   "name": "string", ~/~/ Наименование локатора
5865 5865   "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
... ... @@ -5866,8 +5866,28 @@
5866 5866   "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
5867 5867   "validity": 0, ~/~/ Срок действия в днях (1-90)
5868 5868   "autoProlongation": true, ~/~/ Автопродление срока действия.
5869 - "url": "string", ~/~/ Ссылка
5870 - "language": 0 ~/~/ Язык
6347 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6348 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6349 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6350 + 0
6351 + ],
6352 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6353 + 0
6354 + ],
6355 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6356 + 0
6357 + ],
6358 +
6359 + "showVehicleName": true, ~/~/ Наименование объекта
6360 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6361 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6362 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6363 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6364 + "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ГИС)
6365 +
6366 + 1
6367 +
6368 + ]
5871 5871  }
5872 5872  )))
5873 5873  
... ... @@ -5879,7 +5879,69 @@
5879 5879  )))
5880 5880  
5881 5881  
6380 +== **Выводит список локаторов ** ==
5882 5882  
6382 +(% class="box successmessage" %)
6383 +(((
6384 +**POST /api/v3/locators/find**
6385 +)))
6386 +
6387 +Пример запроса:
6388 +
6389 +(((
6390 +{
6391 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
6392 +}
6393 +)))
6394 +
6395 +(((
6396 +
6397 +)))
6398 +
6399 +(((
6400 +
6401 +)))
6402 +
6403 +
6404 +Пример ответа:
6405 +
6406 +(((
6407 +[
6408 + {
6409 + "vehiclesCount": 0, ~/~/ Количество объектов.
6410 + "geozonesCount": 0, ~/~/ Количество геозон.
6411 + "fieldsCount": 0, ~/~/ Количество полей.
6412 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6413 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
6414 + "agentName": "string", ~/~/ Наименование агента.
6415 + "isEnabled": true, ~/~/ Активность локатора
6416 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
6417 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 
6418 + "name": "string", ~/~/ Наименование локатора 
6419 + "status": 0,  ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6420 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6421 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
6422 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6423 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6424 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 
6425 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6426 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 
6427 + "url": "string", ~/~/ ссылка на локатор 
6428 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6429 + "showVehicleName": true, ~/~/ Наименование объекта
6430 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6431 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6432 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6433 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6434 + "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ГИС)
6435 +
6436 + 0
6437 + ]
6438 + }
6439 +]
6440 +)))
6441 +
6442 +
5883 5883  == **Изменение локатора** ==
5884 5884  
5885 5885  (% class="box infomessage" %)
... ... @@ -5898,12 +5898,31 @@
5898 5898   "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
5899 5899   "validity": 0, ~/~/ Срок действия в днях (1-90)
5900 5900   "autoProlongation": true, ~/~/ Автопродление срока действия
5901 - "url": "string", ~/~/ Ссылка
5902 - "language": 0 ~/~/ Язык
6461 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6462 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6463 + 0
6464 + ],
6465 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6466 + 0
6467 + ],
6468 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6469 + 0
6470 + ],
6471 + "showVehicleName": true, ~/~/ Наименование объекта
6472 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6473 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6474 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6475 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6476 + "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ГИС)
6477 +
6478 + 0
6479 +
6480 + ]
5903 5903  }
6482 +
6483 +
5904 5904  )))
5905 5905  
5906 -
5907 5907  Пример ответа:
5908 5908  
5909 5909  200 ~/~/ Success
... ... @@ -5925,8 +5925,201 @@
5925 5925  )))
5926 5926  
5927 5927  
6507 += **Раздел: Яндекс Маршруты** =
5928 5928  
5929 5929  
6510 +== **Возвращение списка маршрутов** ==
6511 +
6512 +(% class="box infomessage" %)
6513 +(((
6514 +**GET /api/v3/TransportRoutes**
6515 +)))
6516 +
6517 +Пример запроса:
6518 +Id  ~/~/ Идентификатор поля
6519 +
6520 +Пример ответа:
6521 +
6522 +(((
6523 +[
6524 + {
6525 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6526 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6527 + "name": "string", ~/~/ Наименование маршрута.
6528 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6529 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6530 + 0
6531 + ]
6532 + }
6533 +]
6534 +)))
6535 +
6536 +
6537 +== **Добавить маршрут** ==
6538 +
6539 +(% class="box infomessage" %)
6540 +(((
6541 +**POST /api/v3/TransportRoutes**
6542 +)))
6543 +
6544 +Пример запроса: 
6545 +{
6546 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6547 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6548 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6549 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6550 + 0
6551 + ]
6552 +}
6553 +
6554 +
6555 +Пример ответа:
6556 +
6557 +(((
6558 +{
6559 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6560 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6561 + "name": "string", ~/~/ Определяет наименование маршрута 
6562 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6563 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6564 + 0
6565 + ]
6566 +}
6567 +)))
6568 +
6569 +
6570 +== **Обновление маршрута** ==
6571 +
6572 +(% class="box successmessage" %)
6573 +(((
6574 +**PUT /api/v3/TransportRoutes**
6575 +)))
6576 +
6577 +Пример запроса:
6578 +
6579 +(((
6580 +{
6581 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6582 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6583 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6584 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6585 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6586 + 0
6587 + ]
6588 +}
6589 +)))
6590 +
6591 +Пример ответа:
6592 +
6593 +(((
6594 +{
6595 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6596 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6597 + "name": "string", ~/~/ Определяет наименование маршрута 
6598 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6599 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6600 + 0
6601 + ]
6602 +}
6603 +)))
6604 +
6605 +
6606 +== **Получить связки маршрутов ТС** ==
6607 +
6608 +(% class="box infomessage" %)
6609 +(((
6610 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6611 +)))
6612 +
6613 +Пример запроса:
6614 +
6615 +(((
6616 +[
6617 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6618 +]
6619 +)))
6620 +
6621 +Пример ответа:
6622 +
6623 +(((
6624 +[
6625 + {
6626 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6627 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6628 + }
6629 +]
6630 +)))
6631 +
6632 +
6633 +== **Удалить маршрут** ==
6634 +
6635 +(% class="box warningmessage" %)
6636 +(((
6637 +**DELETE /api/v3/TransportRoutes/{id}**
6638 +)))
6639 +
6640 +Пример запроса:
6641 +Id  ~/~/ Идентификатор поля
6642 +
6643 +
6644 += **Раздел: Управление доступа к машинам** =
6645 +
6646 +
6647 +== Получение списка транспортных средств видимых пользователю ==
6648 +
6649 +(% class="box infomessage" %)
6650 +(((
6651 +**GET /api/v3/UserVisibleVehicles/{userId}**
6652 +)))
6653 +
6654 +Пример ответа:
6655 +
6656 +(((
6657 +{
6658 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6659 + 0
6660 + ]
6661 +}
6662 +)))
6663 +
6664 +
6665 +== Задает видимость транспортных средств пользователю ==
6666 +
6667 +(% class="box infomessage" %)
6668 +(((
6669 +**POST /api/v3/UserVisibleVehicles**
6670 +)))
6671 +
6672 +Пример запроса:
6673 +
6674 +(((
6675 +(((
6676 +{
6677 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6678 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6679 + 0
6680 + ]
6681 +}
6682 +)))
6683 +
6684 +(((
6685 +
6686 +)))
6687 +
6688 +(((
6689 +Пример ответа :
6690 +)))
6691 +
6692 +(((
6693 +
6694 +)))
6695 +
6696 +(((
6697 +200 ~/~/ Success
6698 +)))
6699 +)))
6700 +
6701 +
5930 5930  (% class="box" lang="en-US" style="text-align: center;" %)
5931 5931  (((
5932 5932  (% 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 г.