Last modified by Андрей Калиновский on 2025/09/11 10:51
<
From version < 212.2 >
edited by Андрей Калиновский
on 2025/03/12 10:23
To version < 259.1 >
edited by Андрей Калиновский
on 2025/09/03 15:30
>
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,194 +2636,241 @@
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 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2618 += =
2662 2662  
2663 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2620 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2664 2664  
2622 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2623 +
2665 2665  (% class="box infomessage" %)
2666 2666  (((
2667 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2626 +**POST /api/v3/notifications/find**
2668 2668  )))
2669 2669  
2670 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2629 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2671 2671  
2672 -(% style="color:#000000" %)Метод запроса: **POST**
2631 +(% style="text-align: left;" %)
2632 +Метод запроса **POST**
2673 2673  
2674 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2634 +(% style="text-align: left;" %)
2635 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2675 2675  
2637 +(% style="text-align: left;" %)
2676 2676  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2677 2677  
2678 -(% style="text-align:left" %)
2679 -Тело запроса:
2680 -
2681 -(% style="text-align:left" %)
2682 2682  {
2683 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2641 + "parentId": "" ~/~/ id клиента
2684 2684  }
2685 2685  
2686 -(% style="text-align:left" %)
2687 2687  Ответ:
2688 2688  
2689 2689  [
2690 2690   {
2691 - "id": 0, ~/~/ Идентификатор объекта геозоны
2692 - "name": "string", ~/~/ Название объекта геозоны
2693 - "type": 0, ~/~/ Тип объекта геозоны
2694 - "fname": "string", ~/~/ Имя файла
2695 - "parentId": "string", ~/~/ Идентификатор клиента
2696 - "radius": 0, ~/~/ Радиус геообъекта
2697 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2698 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2699 - "description": "string", ~/~/ Описание
2700 - "area": 0, ~/~/ Площадь, м^^2^^
2701 - "perimetr": 0, ~/~/ Периметр, м
2702 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2648 + "id": 0, ~/~/ ID уведомления
2649 + "name": "string", ~/~/ Название уведомления
2650 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2651 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2652 + "userId": "", ~/~/ Пользователь, создавший уведомление
2653 + "parentId": "", ~/~/ Идентификатор клиента
2654 + "parentName": "string" ~/~/ Имя клиента
2703 2703   }
2704 2704  ]
2705 2705  
2706 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2707 2707  
2659 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2660 +
2708 2708  (% class="box infomessage" %)
2709 2709  (((
2710 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2663 +**POST /api/v3/notifications**
2711 2711  )))
2712 2712  
2713 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2666 +Метод запроса **POST**
2714 2714  
2715 -(% style="color:#000000" %)Метод запроса: **POST**
2668 +(% style="text-align: left;" %)
2669 +(% style="color:#000000" %)Пример запроса
2716 2716  
2717 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2718 -
2719 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2720 -
2721 -(% style="text-align:left" %)
2722 -Тело запроса:
2723 -
2671 +(((
2724 2724  {
2725 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2726 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2727 - "ids": [ ], ~/~/ Массив id объектов
2728 - "byTime": 0, ~/~/ Объединение событий по времени 
2729 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2730 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2731 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2673 + "id": 0, ~/~/ ID правила
2674 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2675 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2676 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2677 + "name": "string", ~/~/ Имя правила
2678 + "active": true, ~/~/ Активность правила
2679 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2680 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2681 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2682 + ],
2683 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2684 + 0
2685 + ],
2686 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2687 + 0
2688 + ],
2689 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2690 + 0
2691 + ],
2692 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2693 + "additionalProp1": "string",  
2694 + "additionalProp2": "string",
2695 + "additionalProp3": "string"
2696 + },
2697 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2698 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2699 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2700 + ],
2701 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2702 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2703 + "string"
2704 + ],
2705 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2706 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2707 + {
2708 + "id": 0, ~/~/ Идентификатор участника чата.
2709 + "info": "string" ~/~/ Дополнительные сведения.
2710 + }
2711 + ],
2712 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2713 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2714 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2715 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2716 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2717 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2718 + "timezone": 0, ~/~/ часовой пояс 
2719 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2720 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2721 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2722 + {
2723 + "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 - Срок действия правила истек
2724 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2725 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2726 + "additionalProp1": "string",
2727 + "additionalProp2": "string",
2728 + "additionalProp3": "string"
2729 + }
2730 + }
2731 + ]
2732 2732  }
2733 +)))
2733 2733  
2734 -Ответ:
2735 -[
2736 - {
2737 - "geozoneId": 0, ~/~/ ID геообъекта
2738 - "geozoneName": "string", ~/~/ Название геообъекта
2739 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2740 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2741 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2742 - "vehicleId": 0, ~/~/ ID объекта
2743 - "vehicleName": "string" ~/~/ Имя объекта
2744 - }
2745 -]
2746 -
2747 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2748 -
2749 -(% class="box infomessage" %)
2750 2750  (((
2751 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2736 +
2752 2752  )))
2753 2753  
2754 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2755 -
2756 -(% style="color:#000000" %)Метод запроса: **POST**
2757 -
2758 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2759 -
2760 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2761 -
2762 -(% style="text-align:left" %)
2763 -Тело запроса:
2764 -
2765 -{
2766 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2767 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2768 - "ids": [ ], ~/~/ Массив id геообъектов
2769 - "byTime": 0, ~/~/ Объединение событий по времени 
2770 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2771 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2772 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2773 -}
2774 -
2775 -Ответ:
2776 -
2777 -[
2778 - {
2779 - "geozoneId": 0, ~/~/ ID геообъекта
2780 - "geozoneName": "string", ~/~/ Название геообъекта
2781 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2782 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2783 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2784 - "vehicleId": 0, ~/~/ ID объекта
2785 - "vehicleName": "string" ~/~/ Имя объекта
2786 - }
2787 -]
2788 -
2789 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2790 -
2791 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2792 -
2793 -(% class="box infomessage" %)
2794 2794  (((
2795 -**POST /api/v3/notifications/find**
2740 +
2796 2796  )))
2797 2797  
2798 -Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2743 +Ответ:
2799 2799  
2800 -(% style="text-align: left;" %)
2801 -Метод запроса **POST**
2802 -
2803 -(% style="text-align: left;" %)
2804 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2805 -
2806 -(% style="text-align: left;" %)
2807 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2808 -
2809 2809  {
2810 - "parentId": "" ~/~/ id клиента
2746 + "id": 0, ~/~/ ID правила
2747 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2748 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2749 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2750 + "name": "string", ~/~/ Имя правила
2751 + "active": true, ~/~/ Активность правила
2752 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2753 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2754 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2755 + ],
2756 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2757 + 0
2758 + ],
2759 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2760 + 0
2761 + ],
2762 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2763 + 0
2764 + ],
2765 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2766 + "additionalProp1": "string",  
2767 + "additionalProp2": "string",
2768 + "additionalProp3": "string"
2769 + },
2770 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2771 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2772 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2773 + ],
2774 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2775 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2776 + "string"
2777 + ],
2778 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2779 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2780 + {
2781 + "id": 0, ~/~/ Идентификатор участника чата.
2782 + "info": "string" ~/~/ Дополнительные сведения.
2783 + }
2784 + ],
2785 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2786 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2787 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2788 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2789 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2790 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2791 + "timezone": 0, ~/~/ часовой пояс 
2792 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2793 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2794 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2795 + {
2796 + "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 - Срок действия правила истек
2797 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2798 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2799 + "additionalProp1": "string",
2800 + "additionalProp2": "string",
2801 + "additionalProp3": "string"
2802 + }
2803 + }
2804 + ]
2811 2811  }
2812 2812  
2813 -Ответ:
2814 -
2815 -[
2816 - {
2817 - "id": 0, ~/~/ ID уведомления
2818 - "name": "string", ~/~/ Название уведомления
2819 - "active": true, ~/~/ Состояние true - активен, false - деактивирован
2820 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2821 - "userId": "", ~/~/ Пользователь, создавший уведомление
2822 - "parentId": "", ~/~/ Идентификатор клиента
2823 - "parentName": "string" ~/~/ Имя клиента
2824 - }
2825 -]
2826 -
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
4024 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4025 + "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  
4041 +(((
4065 4065  {
4066 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4067 - "Balance": 0
4043 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4044 + "amount": 0 ~/~/ Сумма пополнения баланса 
4068 4068  }
4046 +)))
4069 4069  
4048 +(((
4049 +
4050 +)))
4051 +
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" %)Значение баланса
4054 +(((
4055 +{
4056 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4057 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4058 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4059 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4060 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4061 + "Description": "string" ~/~/ Описание корректировки.
4062 +}
4063 +)))
4075 4075  
4076 4076  == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4077 4077  
... ... @@ -4084,16 +4084,25 @@
4084 4084  
4085 4085  Тело запроса:
4086 4086  
4076 +(((
4087 4087  {
4088 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4089 - "Balance": 0
4078 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4079 + "amount": 0 ~/~/ Сумма списания с баланса
4090 4090  }
4081 +)))
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" %)Значение баланса
4085 +(((
4086 +{
4087 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4088 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4089 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4090 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4091 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4092 + "Description": "string" ~/~/ Описание корректировки
4093 +}
4094 +)))
4097 4097  
4098 4098  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4099 4099  
... ... @@ -4104,28 +4104,35 @@
4104 4104  
4105 4105  Тело запроса:
4106 4106  
4105 +(((
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,
4107 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4108 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4109 + "PermissibleBalance": 0, ~/~/ Допустимый баланс
4110 + "DefermentDays": 0, ~/~/ Отсрочка (дни).
4111 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4112 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4115 4115  }
4114 +)))
4116 4116  
4116 +(((
4117 +
4118 +)))
4119 +
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 -Отсрочка, количество дней
4122 +(((
4123 +{
4124 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4125 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4126 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4127 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4128 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4129 + "DefermentDays": 0, ~/~/ Отсрочка (дни)
4130 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4131 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4132 +}
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": [
4145 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4146 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4147 + "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
4149 + "Feature": "string", ~/~/ Код услуги.
4150 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4151 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4152 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4153 + "Price": 0, ~/~/ Цена за единицу.
4154 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4155 + "PeriodValue": 0, ~/~/ Значение периода.
4156 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4152 4152   }
4153 4153   ]
4154 4154  }
4155 4155  
4161 +
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 - Месяцы
4164 +(((
4165 +{
4166 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4167 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4168 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4169 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4170 + "Name": "string", ~/~/ Наименование.
4171 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4172 + "Constraint": { ~/~/ Ограничения по тарифу 
4173 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4174 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4175 + "DefermentDays": 0 ~/~/ Отсрочка (дни)
4176 + },
4177 + "Features": [ ~/~/ Набор услуг по тарифному плану.
4178 + {
4179 + "Feature": "string", ~/~/Код услуги.
4180 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4181 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4182 + "Price": 0, ~/~/ Цена за единицу.
4183 + "PeriodValue": 0, ~/~/ Значение периода.
4184 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4185 + }
4186 + ],
4187 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4188 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4189 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4190 + },
4191 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4192 + {
4193 + "Feature": "string", ~/~/ Код услуги.
4194 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4195 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4196 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4197 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4198 + "Price": 0, ~/~/ Цена за единицу.
4199 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4200 + "PeriodValue": 0, ~/~/ Значение периода.
4201 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4202 + "Quantity": 0 ~/~/ Количество использования услуги.
4203 + }
4204 + ]
4205 +}
4206 +)))
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  
4311 +== **Импортировать историю ТС (Асинхронный запрос)** ==
4312 +
4313 +(% class="box successmessage" %)
4314 +(((
4315 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4316 +)))
4317 +
4318 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4319 +
4320 +Метод запроса: **POST**
4321 +
4322 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4323 +
4324 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4325 +
4326 +
4327 +Ответ:
4328 +
4329 +{
4330 +
4331 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4332 +
4333 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4334 +
4335 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4336 +
4337 + "Message": "string", ~/~/ Информация о выполнении запроса
4338 +
4339 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4340 +
4341 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4342 +
4343 + "Data": "string" ~/~/ Данные
4344 +
4345 +}
4346 +
4347 +
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 ТС
4365 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4366 +**Параметр**
4367 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4368 +**Описание**
4369 +)))
4370 +|(((
4371 +activity
4372 +)))|(((
4373 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4374 +)))
4375 +|(((
4376 +progress
4377 +)))|(((
4378 +Guid ТС
4379 +)))
4293 4293  
4381 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4382 +
4383 +(% class="box infomessage" %)
4384 +(((
4385 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4386 +)))
4387 +
4388 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4389 +
4390 +Метод запроса: **GET**
4391 +
4392 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4393 +
4394 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4395 +
4396 +
4397 +Ответ:
4398 +
4399 +{
4400 +
4401 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4402 +
4403 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
4404 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4405 +
4406 + "Message": "string", ~/~/ Информация о выполнении запроса
4407 +
4408 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4409 +
4410 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4411 +
4412 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4413 +
4414 + "Data": "string" ~/~/ Данные
4415 +
4416 +}
4417 +
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  }
4929 +
4930 +
4931 +== **Превышение скорости** ==
4932 +
4933 +(% class="box infomessage" %)
4934 +(((
4935 +**POST /api/v3/Reports/overSpeedDuration**
4805 4805  )))
4806 4806  
4938 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4939 +
4940 +Пример запроса:
4941 +
4942 +(((
4943 +{
4944 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4945 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4946 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4947 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4948 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4949 +}
4950 +)))
4951 +
4952 +(((
4953 +
4954 +)))
4955 +
4956 +(((
4957 +Пример ответа:
4958 +)))
4959 +
4960 +(((
4961 +(((
4962 +[
4963 + {
4964 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4965 + "duration": 0, ~/~/ Продолжительность события в секундах 
4966 + "maxSpeed": 0, ~/~/ Максимальная скорость 
4967 + "speedLimit": 0 ~/~/ Ограничение скорости 
4968 + }
4969 +]
4970 +)))
4971 +)))
4972 +)))
4973 +
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  
5048 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5049 +X-agent  - ID клиента
5050 +
4881 4881  Пример запроса:
4882 4882  
4883 4883  (((
4884 4884  {
4885 4885   "extId": "string", 
4886 - "shape": "string", ~/~/ Форма поля
4887 - "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5056 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5057 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
4888 4888   "display": "string", ~/~/ Настройки отображения
4889 4889   "year": 0, ~/~/ Год поля
4890 4890   "name": "string", ~/~/ Наименование
... ... @@ -5106,33 +5106,9 @@
5106 5106  )))
5107 5107  
5108 5108  
5109 -== **Удаление существующего поля** ==
5110 -
5111 -(% class="box errormessage" %)
5112 5112  (((
5113 -**DELETE /api/v3/agroLands/{id}**
5114 -)))
5115 -
5116 -Пример запроса:
5117 -id  ~/~/ Идентификатор поля
5118 -
5119 -Пример ответа:
5120 -
5121 5121  (((
5122 -200 ~/~/ Успех
5123 -)))
5124 -
5125 5125  (((
5126 -
5127 -)))
5128 -
5129 -(((
5130 -(((
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  }
5527 +
5528 +
5529 +== **Какие поля посещал объект** ==
5530 +
5531 +(% class="box successmessage" %)
5532 +(((
5533 +**POST /api/v3/agroLands/visitingByVehicle**
5381 5381  )))
5382 5382  
5536 +Пример запроса:
5383 5383  
5538 +{
5539 + "vehicleId": 0, ~/~/ id объекта 
5540 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5541 + "byTime": 0, ~/~/ Объединение событий по времени
5542 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5543 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5544 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
5545 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
5546 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5547 +}
5548 +
5549 +Пример ответа:
5550 +
5551 +[
5552 + {
5553 + "fieldId": 0, ~/~/ id объекта 
5554 + "vehicleName": "string", ~/~/ Наименование объекта 
5555 + "fieldName": "string", ~/~/ Наименование поля 
5556 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5557 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5558 + "vehicleId": 0, ~/~/ Идентификатор ТС
5559 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
5560 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
5561 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5562 + "mileage": 0 ~/~/ Пробег 
5563 + }
5564 +]
5565 +)))
5566 +
5567 +
5568 +== **Посещение поля объектами ** ==
5569 +
5570 +(% class="box successmessage" %)
5571 +(((
5572 +**POST /api/v3/agroLands/visitingByField**
5573 +)))
5574 +
5575 +Пример запроса:
5576 +{
5577 + "fieldId": 0, ~/~/ ID поля
5578 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5579 + "byTime": 0, ~/~/ Объединение событий по времени
5580 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5581 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5582 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
5583 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
5584 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5585 +}
5586 +
5587 +Пример ответа:
5588 +
5589 +[
5590 + {
5591 + "fieldId": 0, ~/~/ ID поля
5592 + "vehicleName": "string", ~/~/ Наименование объекта 
5593 + "fieldName": "string", ~/~/ Имя поля
5594 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5595 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5596 + "vehicleId": 0, ~/~/ Идентификатор ТС
5597 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
5598 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
5599 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5600 + "mileage": 0 ~/~/ Пробег
5601 + }
5602 +]
5603 +
5604 +
5605 +== **Удаление существующего поля** ==
5606 +
5607 +(% class="box errormessage" %)
5608 +(((
5609 +**DELETE /api/v3/agroLands/{id}**
5610 +)))
5611 +
5612 +Пример запроса:
5613 +id  ~/~/ Идентификатор поля
5614 +
5615 +Пример ответа:
5616 +
5617 +(((
5618 +200 ~/~/ Успех
5619 +
5620 +
5621 +)))
5622 +
5384 5384  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5385 5385  )))
5386 5386  )))
... ... @@ -5805,49 +5805,129 @@
5805 5805  )))
5806 5806  
5807 5807  
6047 += **Раздел: Роли** =
6048 +
6049 +== **Получение списка клиентских и системных ролей пользователя ** ==
6050 +
6051 +(% class="box successmessage" %)
6052 +(((
6053 +**POST /api/v3/groups/find**
6054 +)))
6055 +
6056 +Пример запроса:
6057 +
6058 +(((
6059 +{
6060 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6061 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6062 +}
6063 +)))
6064 +
6065 +(((
6066 +
6067 +)))
6068 +
6069 +(((
6070 +Пример ответа:
6071 +)))
6072 +
6073 +(((
6074 +(((
6075 +{
6076 + "groups": [  ~/~/ Системные роли пользователя
6077 + {
6078 + "code": "string", ~/~/ Код роли.
6079 + "name": "string", ~/~/ Имя  
6080 + "shortName": "string" ~/~/ Короткое имя 
6081 + }
6082 + ],
6083 + "customGroups": [ ~/~/ Системные роли пользователя
6084 + {
6085 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6086 + "name": "string", ~/~/ Наименование 
6087 + "shortName": "string", ~/~/ Короткое наименование 
6088 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6089 + }
6090 + ]
6091 +}
6092 +)))
6093 +)))
6094 +
6095 +(((
6096 +
6097 +)))
6098 +
6099 +(((
6100 +
6101 +)))
6102 +
5808 5808  = **Раздел: Локатор ** =
5809 5809  
5810 5810  
5811 -== **Получение списка локаторов, доступных пользователю ** ==
6106 +== **Получение данных по локатору** ==
5812 5812  
5813 5813  (% class="box infomessage" %)
5814 5814  (((
5815 -**GET /api/v3/locators**
6110 +**GET /api/v3/locators/{locatorId}**
5816 5816  )))
5817 5817  
5818 -В заголовках запроса: X-Auth: Токен авторизации
6113 +В запросе указывается 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 -]
6119 +(((
6120 +{
6121 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6122 + 0
6123 + ],
6124 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6125 + 0
6126 + ],
6127 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6128 + 0
6129 + ],
6130 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6131 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6132 + "agentName": "string", ~/~/ Наименование агента.
6133 + "isEnabled": true, ~/~/ Активность 
6134 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6135 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6136 + "name": "string", ~/~/ Наименование.
6137 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6138 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6139 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6140 + "validity": 0, ~/~/ Значение срока действия
6141 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6142 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6143 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6144 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6145 + "url": "string", ~/~/ Ссылка
6146 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6147 +
6148 + "showVehicleName": true, ~/~/ Наименование объекта
6149 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6150 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6151 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6152 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6153 + "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ГИС)
6154 +
6155 + 1
6156 +
6157 + ]
6158 +}
5847 5847  )))
6160 +)))
5848 5848  
5849 5849  
6163 +(((
6164 +(((
6165 +
6166 +)))
6167 +)))
5850 5850  
6169 +
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 ~/~/ Язык
6187 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6188 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6189 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6190 + 0
6191 + ],
6192 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6193 + 0
6194 + ],
6195 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6196 + 0
6197 + ],
6198 +
6199 + "showVehicleName": true, ~/~/ Наименование объекта
6200 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6201 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6202 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6203 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6204 + "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ГИС)
6205 +
6206 + 1
6207 +
6208 + ]
5871 5871  }
5872 5872  )))
5873 5873  
... ... @@ -5879,7 +5879,69 @@
5879 5879  )))
5880 5880  
5881 5881  
6220 +== **Выводит список локаторов ** ==
5882 5882  
6222 +(% class="box successmessage" %)
6223 +(((
6224 +**POST /api/v3/locators/find**
6225 +)))
6226 +
6227 +Пример запроса:
6228 +
6229 +(((
6230 +{
6231 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
6232 +}
6233 +)))
6234 +
6235 +(((
6236 +
6237 +)))
6238 +
6239 +(((
6240 +
6241 +)))
6242 +
6243 +
6244 +Пример ответа:
6245 +
6246 +(((
6247 +[
6248 + {
6249 + "vehiclesCount": 0, ~/~/ Количество объектов.
6250 + "geozonesCount": 0, ~/~/ Количество геозон.
6251 + "fieldsCount": 0, ~/~/ Количество полей.
6252 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6253 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
6254 + "agentName": "string", ~/~/ Наименование агента.
6255 + "isEnabled": true, ~/~/ Активность локатора
6256 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
6257 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 
6258 + "name": "string", ~/~/ Наименование локатора 
6259 + "status": 0,  ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6260 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6261 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
6262 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6263 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6264 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 
6265 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6266 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 
6267 + "url": "string", ~/~/ ссылка на локатор 
6268 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6269 + "showVehicleName": true, ~/~/ Наименование объекта
6270 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6271 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6272 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6273 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6274 + "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ГИС)
6275 +
6276 + 0
6277 + ]
6278 + }
6279 +]
6280 +)))
6281 +
6282 +
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 ~/~/ Язык
6301 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6302 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6303 + 0
6304 + ],
6305 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6306 + 0
6307 + ],
6308 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6309 + 0
6310 + ],
6311 + "showVehicleName": true, ~/~/ Наименование объекта
6312 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6313 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6314 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6315 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6316 + "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ГИС)
6317 +
6318 + 0
6319 +
6320 + ]
5903 5903  }
6322 +
6323 +
5904 5904  )))
5905 5905  
5906 -
5907 5907  Пример ответа:
5908 5908  
5909 5909  200 ~/~/ Success
... ... @@ -5913,7 +5913,7 @@
5913 5913  
5914 5914  (% class="box warningmessage" %)
5915 5915  (((
5916 -**PUT /api/v3/locators**
6335 +**DELETE /api/v3/locators**
5917 5917  )))
5918 5918  
5919 5919  Пример запроса:
... ... @@ -5925,8 +5925,201 @@
5925 5925  )))
5926 5926  
5927 5927  
6347 += **Раздел: Яндекс Маршруты** =
5928 5928  
5929 5929  
6350 +== **Возвращение списка маршрутов** ==
6351 +
6352 +(% class="box infomessage" %)
6353 +(((
6354 +**GET /api/v3/TransportRoutes**
6355 +)))
6356 +
6357 +Пример запроса:
6358 +Id  ~/~/ Идентификатор поля
6359 +
6360 +Пример ответа:
6361 +
6362 +(((
6363 +[
6364 + {
6365 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6366 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6367 + "name": "string", ~/~/ Наименование маршрута.
6368 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6369 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6370 + 0
6371 + ]
6372 + }
6373 +]
6374 +)))
6375 +
6376 +
6377 +== **Добавить маршрут** ==
6378 +
6379 +(% class="box infomessage" %)
6380 +(((
6381 +**POST /api/v3/TransportRoutes**
6382 +)))
6383 +
6384 +Пример запроса: 
6385 +{
6386 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6387 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6388 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6389 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6390 + 0
6391 + ]
6392 +}
6393 +
6394 +
6395 +Пример ответа:
6396 +
6397 +(((
6398 +{
6399 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6400 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6401 + "name": "string", ~/~/ Определяет наименование маршрута 
6402 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6403 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6404 + 0
6405 + ]
6406 +}
6407 +)))
6408 +
6409 +
6410 +== **Обновление маршрута** ==
6411 +
6412 +(% class="box successmessage" %)
6413 +(((
6414 +**PUT /api/v3/TransportRoutes**
6415 +)))
6416 +
6417 +Пример запроса:
6418 +
6419 +(((
6420 +{
6421 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6422 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6423 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6424 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6425 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6426 + 0
6427 + ]
6428 +}
6429 +)))
6430 +
6431 +Пример ответа:
6432 +
6433 +(((
6434 +{
6435 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6436 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6437 + "name": "string", ~/~/ Определяет наименование маршрута 
6438 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6439 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6440 + 0
6441 + ]
6442 +}
6443 +)))
6444 +
6445 +
6446 +== **Получить связки маршрутов ТС** ==
6447 +
6448 +(% class="box infomessage" %)
6449 +(((
6450 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6451 +)))
6452 +
6453 +Пример запроса:
6454 +
6455 +(((
6456 +[
6457 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6458 +]
6459 +)))
6460 +
6461 +Пример ответа:
6462 +
6463 +(((
6464 +[
6465 + {
6466 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6467 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6468 + }
6469 +]
6470 +)))
6471 +
6472 +
6473 +== **Удалить маршрут** ==
6474 +
6475 +(% class="box warningmessage" %)
6476 +(((
6477 +**DELETE /api/v3/TransportRoutes/{id}**
6478 +)))
6479 +
6480 +Пример запроса:
6481 +Id  ~/~/ Идентификатор поля
6482 +
6483 +
6484 += **Раздел: Управление доступа к машинам** =
6485 +
6486 +
6487 +== Получение списка транспортных средств видимых пользователю ==
6488 +
6489 +(% class="box infomessage" %)
6490 +(((
6491 +**GET /api/v3/UserVisibleVehicles/{userId}**
6492 +)))
6493 +
6494 +Пример ответа:
6495 +
6496 +(((
6497 +{
6498 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6499 + 0
6500 + ]
6501 +}
6502 +)))
6503 +
6504 +
6505 +== Задает видимость транспортных средств пользователю ==
6506 +
6507 +(% class="box infomessage" %)
6508 +(((
6509 +**POST /api/v3/UserVisibleVehicles**
6510 +)))
6511 +
6512 +Пример запроса:
6513 +
6514 +(((
6515 +(((
6516 +{
6517 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6518 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6519 + 0
6520 + ]
6521 +}
6522 +)))
6523 +
6524 +(((
6525 +
6526 +)))
6527 +
6528 +(((
6529 +Пример ответа :
6530 +)))
6531 +
6532 +(((
6533 +
6534 +)))
6535 +
6536 +(((
6537 +200 ~/~/ Success
6538 +)))
6539 +)))
6540 +
6541 +
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 г.