Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Павел Субботин on 2025/12/11 11:25
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Gadmin1 +XWiki.subbotinpa - 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,156 +2636,415 @@ 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": "202 4-02-27T14:11:00.315Z",~/~/Времяполучениязаписи на сервере,т.е. время срабатывания+ время передачи от устройствана сервер2647 - "recordTime": "202 4-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" %)Раздел: **Запрос посещений геообъектов**(%%) = 2662 2662 2663 -== (% style="color: #000000; font-size:16px" %)**Получениеспискавсехгеообъектов**(%%) ==2620 +== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Получение информации о геозоне по ID геозоны **(%%) == 2664 2664 2665 2665 (% class="box infomessage" %) 2666 2666 ((( 2667 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/find**2624 +**GET /api/v3/gis/{geozoneId}** 2668 2668 ))) 2669 2669 2670 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2627 +Пример запроса: 2628 +\\geozoneId ~/~/ id геозоны 2671 2671 2672 -(% style="color:#000000" %)Метод запроса: **POST** 2673 2673 2674 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2631 +(% style="text-align:left" %) 2632 +Ответ: 2675 2675 2676 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2634 +((( 2635 +{ 2636 + "id": 0, ~/~/ Идентификатор объекта геозоны 2637 + "name": "string", ~/~/ Наименование объекта геозоны 2638 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2639 + "description": "string", ~/~/ Описание объекта геозоны 2640 + "beginCalc": "2025-12-04T07:13:04.658Z", ~/~/ Дата начала расчетов для геозоны 2641 + "endCalc": "2025-12-04T07:13:04.658Z", ~/~/ Дата окончания расчетов для геозоны 2642 + "settingsData": "string", ~/~/ Параметры отображения в формате XML. 2643 + "type": 0, ~/~/ Тип геозоны - линия,полигон 2644 + "radius": 0, ~/~/ Радиус геозоны 2645 + "shape": "string", ~/~/ Координаты геозоны 2646 + "shape_format": "string" ~/~/ Формат xml,json 2647 +} 2648 +))) 2677 2677 2678 -(% style="text-align:left" %) 2679 -Тело запроса: 2650 +((( 2651 + 2652 +))) 2680 2680 2681 -(% style="text-align:left" %) 2654 +== **Удаление геообъекта ** == 2655 + 2656 +((( 2657 + 2658 +))) 2659 + 2660 +(% class="box errormessage" %) 2661 +((( 2662 +**DELETE /api/v3/gis/{geozoneId}** 2663 +))) 2664 + 2665 +((( 2666 +Пример запроса: 2667 +))) 2668 + 2669 +((( 2670 + 2671 +))) 2672 + 2673 +((( 2674 +geozoneId ~/~/ Id геообъекта 2675 +))) 2676 + 2677 +((( 2678 + 2679 +))) 2680 + 2681 +((( 2682 +Пример ответа: 2683 +))) 2684 + 2685 +((( 2686 + 2687 +))) 2688 + 2689 +((( 2690 +200 ~/~/ Success 2691 +))) 2692 + 2693 +((( 2694 + 2695 +))) 2696 + 2697 +== **Возвращение данных по пересечению объектами геозон ** == 2698 + 2699 +((( 2700 + 2701 +))) 2702 + 2703 +(% class="box successmessage" %) 2704 +((( 2705 +**POST /api/v3/gis/intersections/geozones** 2706 +))) 2707 + 2708 +((( 2709 +Пример запроса: 2710 +))) 2711 + 2712 +((( 2713 +((( 2682 2682 { 2683 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2715 + "startDate": "2025-12-04T07:19:27.628Z", ~/~/ Дата и время начала расчета 2716 + "endDate": "2025-12-04T07:19:27.628Z", ~/~/ Дата и время конца расчета 2717 + "ids": [ ~/~/ Идентификаторы объектов 2718 + 0 2719 + ], 2720 + "byTime": 0, ~/~/ объединение геообъектов по времени (секунды) 2721 + "byDist": 0, ~/~/ объединение геообъектов по расстоянию(метры) 2722 + "filterByTime": 0, ~/~/ Фильтрация посещений по времени, сек. 2723 + "filterByHalfPerimeter": true, ~/~/ Фильтрация по половине периметра геообъекта 2724 + "includeMotoHours": true ~/~/ Флаг, включать ли моточасы в отчет 2684 2684 } 2726 +))) 2727 +))) 2685 2685 2686 -(% style="text-align:left" %) 2687 -Ответ: 2729 +((( 2730 + 2731 +))) 2688 2688 2733 +((( 2734 +Пример ответа: 2735 +))) 2736 + 2737 +((( 2738 +((( 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", ~/~/ Дата создания 2741 + "geozoneId": 0, ~/~/ ID геозоны 2742 + "geozoneName": "string", ~/~/ Наименование геозоны 2743 + "startDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время входа из геозоны 2744 + "endDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время выхода из геозоны 2745 + "duration": 0, ~/~/ Продолжительность внутри геозоны 2746 + "vehicleId": 0, ~/~/ ID объекта 2747 + "vehicleName": "string", ~/~/ Имя объекта 2748 + "motoHours": 0 ~/~/ Моточасы 2703 2703 } 2704 2704 ] 2751 +))) 2752 +))) 2705 2705 2706 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2707 - 2708 -(% class="box infomessage" %) 2709 2709 ((( 2710 - (%style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**2755 + 2711 2711 ))) 2712 2712 2713 - (% style="color:#000000"%)Метод позволяет получитьсписокпересеченийвыбранныхобъектов совсеми геообъектамизавыбранный период.2758 +== **Возвращение данных по пересечению геозон для объектов с заданными ID ** == 2714 2714 2715 -(% style="color:#000000" %)Метод запроса: **POST** 2760 +((( 2761 + 2762 +))) 2716 2716 2717 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2764 +(% class="box successmessage" %) 2765 +((( 2766 +**POST /api/v3/gis/intersections/vehicles** 2767 +))) 2718 2718 2719 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2769 +((( 2770 +Пример запроса: 2771 +))) 2720 2720 2721 -(% style="text-align:left" %) 2722 -Тело запроса: 2773 +((( 2774 + 2775 +))) 2723 2723 2777 +((( 2778 +((( 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 ~/~/ Фильтрация событий по пробегу половины периметра 2780 + "startDate": "2025-12-04T07:26:11.520Z", ~/~/ Дата и время начала расчета 2781 + "endDate": "2025-12-04T07:26:11.520Z", ~/~/ Дата и время конца расчета 2782 + "ids": [ ~/~/ Идентификаторы объектов 2783 + 0 2784 + ], 2785 + "byTime": 0, ~/~/ объединение геообъектов по времени (секунды) 2786 + "byDist": 0, ~/~/ объединение геообъектов по расстоянию(метры) 2787 + "filterByTime": 0, ~/~/ Фильтрация посещений по времени, сек. 2788 + "filterByHalfPerimeter": true, ~/~/ Фильтрация по половине периметра геообъекта 2789 + "includeMotoHours": true ~/~/ Флаг, включать ли моточасы в отчет 2732 2732 } 2791 +))) 2792 +))) 2733 2733 2734 -Ответ: 2794 +((( 2795 + 2796 +))) 2797 + 2798 +((( 2799 +Пример ответа: 2800 +))) 2801 + 2802 +((( 2735 2735 [ 2736 2736 { 2737 - "geozoneId": 0, ~/~/ ID геоо бъекта2738 - "geozoneName": "string", ~/~/ Название геообъекта2739 - "startDate": "202 3-08-02T06:13:18.554Z", ~/~/Датавъезда2740 - "endDate": "202 3-08-02T06:13:18.554Z", ~/~/Датавыезда2741 - "duration": 0, ~/~/ Продолжительность нахождениявгеообъекте2805 + "geozoneId": 0, ~/~/ ID геозоны 2806 + "geozoneName": "string", ~/~/ Наименование геозоны 2807 + "startDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время входа из геозоны 2808 + "endDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время выхода из геозоны 2809 + "duration": 0, ~/~/ Продолжительность внутри геозоны 2742 2742 "vehicleId": 0, ~/~/ ID объекта 2743 - "vehicleName": "string" ~/~/ Имя объекта 2811 + "vehicleName": "string", ~/~/ Имя объекта 2812 + "motoHours": 0 ~/~/ Моточасы 2744 2744 } 2745 2745 ] 2815 +))) 2746 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**2818 + 2752 2752 ))) 2753 2753 2754 - (% style="color:#000000"%)Метод позволяет получитьсписокпересечений выбранныхгеообъектов со всеми объектамиза выбранныйпериод.2821 +== **Получение списка геозон** == 2755 2755 2756 -(% style="color:#000000" %)Метод запроса: **POST** 2823 +((( 2824 + 2825 +))) 2757 2757 2758 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2827 +(% class="box successmessage" %) 2828 +((( 2829 +**POST /api/v3/gis/find** 2830 +))) 2759 2759 2760 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2832 +((( 2833 +((( 2834 +Пример запроса: 2835 +))) 2761 2761 2762 -(% style="text-align:left" %) 2763 -Тело запроса: 2837 +((( 2838 + 2839 +))) 2764 2764 2841 +((( 2765 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 ~/~/ Фильтрация событий по пробегу половины периметра 2843 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента, для которого надо получить данные. 2773 2773 } 2845 +))) 2846 +))) 2774 2774 2775 -Ответ: 2848 +((( 2849 + 2850 +))) 2776 2776 2852 +((( 2853 +Пример ответа: 2854 +))) 2855 + 2856 +((( 2857 +((( 2777 2777 [ 2778 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" ~/~/ Имя объекта 2860 + "id": 0, ~/~/ Идентификатор объекта геозоны 2861 + "name": "string", ~/~/ Название объекта геозоны 2862 + "type": 0, ~/~/ Тип объекта геозоны 2863 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2864 + "fname": "string", ~/~/ Имя файла 2865 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента 2866 + "beginCalc": "2025-12-04T07:31:23.082Z", ~/~/ Дата начала расчетов для геозоны 2867 + "endCalc": "2025-12-04T07:31:23.082Z", ~/~/ Дата окончания расчетов для геозоны 2868 + "description": "string", ~/~/ Описание объекта геозоны 2869 + "area": 0, ~/~/ Площадь, м2 2870 + "perimetr": 0, ~/~/ Периметр, м 2871 + "createDate": "2025-12-04T07:31:23.082Z" ~/~/ Дата создания в бд 2786 2786 } 2787 2787 ] 2874 +))) 2875 +))) 2788 2788 2877 +((( 2878 + 2879 +))) 2880 + 2881 +== **Создание геообъекта** == 2882 + 2883 +((( 2884 + 2885 +))) 2886 + 2887 +(% class="box successmessage" %) 2888 +((( 2889 +**POST /api/v3/gis** 2890 +))) 2891 + 2892 +((( 2893 +((( 2894 +Пример запроса: 2895 +\\{ 2896 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента 2897 + "name": "string", ~/~/ Наименование объекта геозоны 2898 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2899 + "description": "string", ~/~/ Описание объекта геозоны 2900 + "beginCalc": "2025-12-04T07:35:07.395Z", ~/~/ Дата начала расчетов для геозоны 2901 + "endCalc": "2025-12-04T07:35:07.395Z", ~/~/ Дата окончания расчетов для геозоны 2902 + "settingsData": "string", ~/~/ Параметры отображения в формате XML 2903 + "type": 0, ~/~/ Тип геозоны - линия,полигон 2904 + "radius": 0, ~/~/ Радиус геозоны 2905 + "shape": "string", ~/~/ Координаты геозоны 2906 + "shape_format": "string" ~/~/ Формат xml,json, 2907 +} 2908 +))) 2909 +))) 2910 + 2911 +((( 2912 + 2913 +))) 2914 + 2915 +((( 2916 +Пример ответа: 2917 +))) 2918 + 2919 +((( 2920 + 2921 +))) 2922 + 2923 +((( 2924 +200 ~/~/ Success 2925 +))) 2926 + 2927 +((( 2928 + 2929 +))) 2930 + 2931 +== **Редактирование геообъекта ** == 2932 + 2933 +((( 2934 + 2935 +))) 2936 + 2937 +(% class="box warningmessage" %) 2938 +((( 2939 +**PUT /api/v3/gis** 2940 +))) 2941 + 2942 +((( 2943 +((( 2944 +Пример запроса: 2945 +{ 2946 + "id": 0, ~/~/ Идентификатор объекта геозоны 2947 + "name": "string", ~/~/ Наименование объекта геозоны 2948 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2949 + "description": "string", ~/~/ Описание объекта геозоны 2950 + "beginCalc": "2025-12-04T07:38:55.221Z", ~/~/ Дата начала расчетов для геозоны 2951 + "endCalc": "2025-12-04T07:38:55.221Z", ~/~/ Дата окончания расчетов для геозоны 2952 + "settingsData": "string", ~/~/ Параметры отображения в формате XML. 2953 + "type": 0, ~/~/ Тип геозоны - линия,полигон 2954 + "radius": 0, ~/~/ Радиус геозоны 2955 + "shape": "string", ~/~/ Координаты геозоны 2956 + "shape_format": "string" ~/~/Формат xml,json 2957 +} 2958 +))) 2959 +))) 2960 + 2961 +((( 2962 + 2963 +))) 2964 + 2965 +((( 2966 +Пример ответа: 2967 +))) 2968 + 2969 +((( 2970 + 2971 +))) 2972 + 2973 +((( 2974 +200 ~/~/ Success 2975 +))) 2976 + 2977 +((( 2978 + 2979 +))) 2980 + 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 - Выполнение ТО 3012 + "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,151 @@ 2824 2824 } 2825 2825 ] 2826 2826 3019 + 3020 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 3021 + 3022 +(% class="box infomessage" %) 3023 +((( 3024 +**POST /api/v3/notifications** 3025 +))) 3026 + 3027 +Метод запроса **POST** 3028 + 3029 +(% style="text-align: left;" %) 3030 +(% style="color:#000000" %)Пример запроса 3031 + 3032 +((( 3033 +{ 3034 + "id": 0, ~/~/ ID правила 3035 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 3036 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 3037 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 3038 + "name": "string", ~/~/ Имя правила 3039 + "active": true, ~/~/ Активность правила 3040 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 3041 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 3042 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 3043 + ], 3044 + "vehicleIds": [ ~/~/ Список объектов для анализа. 3045 + 0 3046 + ], 3047 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 3048 + 0 3049 + ], 3050 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 3051 + 0 3052 + ], 3053 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 3054 + "additionalProp1": "string", 3055 + "additionalProp2": "string", 3056 + "additionalProp3": "string" 3057 + }, 3058 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 3059 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 3060 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3061 + ], 3062 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 3063 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 3064 + "string" 3065 + ], 3066 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 3067 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 3068 + { 3069 + "id": 0, ~/~/ Идентификатор участника чата. 3070 + "info": "string" ~/~/ Дополнительные сведения. 3071 + } 3072 + ], 3073 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 3074 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 3075 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 3076 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 3077 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 3078 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 3079 + "timezone": 0, ~/~/ часовой пояс 3080 + "validity": 0, ~/~/ Срок действия в днях (1-90). 3081 + "autoProlongation": true, ~/~/ Автопродление срока действия. 3082 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 3083 + { 3084 + "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 - Срок действия правила истек 3085 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 3086 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 3087 + "additionalProp1": "string", 3088 + "additionalProp2": "string", 3089 + "additionalProp3": "string" 3090 + } 3091 + } 3092 + ] 3093 +} 3094 +))) 3095 + 3096 +((( 3097 + 3098 +))) 3099 + 3100 +Ответ: 3101 + 3102 +{ 3103 + "id": 0, ~/~/ ID правила 3104 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 3105 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 3106 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 3107 + "name": "string", ~/~/ Имя правила 3108 + "active": true, ~/~/ Активность правила 3109 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 3110 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 3111 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 3112 + ], 3113 + "vehicleIds": [ ~/~/ Список объектов для анализа. 3114 + 0 3115 + ], 3116 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 3117 + 0 3118 + ], 3119 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 3120 + 0 3121 + ], 3122 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 3123 + "additionalProp1": "string", 3124 + "additionalProp2": "string", 3125 + "additionalProp3": "string" 3126 + }, 3127 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 3128 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 3129 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3130 + ], 3131 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 3132 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 3133 + "string" 3134 + ], 3135 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 3136 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 3137 + { 3138 + "id": 0, ~/~/ Идентификатор участника чата. 3139 + "info": "string" ~/~/ Дополнительные сведения. 3140 + } 3141 + ], 3142 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 3143 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 3144 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 3145 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 3146 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 3147 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 3148 + "timezone": 0, ~/~/ часовой пояс 3149 + "validity": 0, ~/~/ Срок действия в днях (1-90). 3150 + "autoProlongation": true, ~/~/ Автопродление срока действия. 3151 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 3152 + { 3153 + "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 - Срок действия правила истек 3154 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 3155 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 3156 + "additionalProp1": "string", 3157 + "additionalProp2": "string", 3158 + "additionalProp3": "string" 3159 + } 3160 + } 3161 + ] 3162 +} 3163 + 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 4381 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4382 + "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 4398 +((( 4065 4065 { 4066 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4067 - " Balance": 04400 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4401 + "amount": 0 ~/~/ Сумма пополнения баланса 4068 4068 } 4403 +))) 4069 4069 4405 +((( 4406 + 4407 +))) 4408 + 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" %)Значение баланса 4411 +((( 4412 +{ 4413 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4414 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4415 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4416 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4417 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4418 + "Description": "string" ~/~/ Описание корректировки. 4419 +} 4420 +))) 4075 4075 4076 4076 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4077 4077 ... ... @@ -4084,16 +4084,25 @@ 4084 4084 4085 4085 Тело запроса: 4086 4086 4433 +((( 4087 4087 { 4088 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4089 - " Balance": 04435 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4436 + "amount": 0 ~/~/ Сумма списания с баланса 4090 4090 } 4438 +))) 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" %)Значение баланса 4442 +((( 4443 +{ 4444 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4445 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4446 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4447 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4448 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4449 + "Description": "string" ~/~/ Описание корректировки 4450 +} 4451 +))) 4097 4097 4098 4098 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4099 4099 ... ... @@ -4104,28 +4104,35 @@ 4104 4104 4105 4105 Тело запроса: 4106 4106 4462 +((( 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, 4464 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4465 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4466 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4467 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4468 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4469 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4115 4115 } 4471 +))) 4116 4116 4473 +((( 4474 + 4475 +))) 4476 + 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 -Отсрочка, количество дней 4479 +((( 4480 +{ 4481 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4482 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4483 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4484 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4485 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4486 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4487 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4488 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4489 +} 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": [ 4502 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4503 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4504 + "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 4506 + "Feature": "string", ~/~/ Код услуги. 4507 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4508 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4509 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4510 + "Price": 0, ~/~/ Цена за единицу. 4511 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4512 + "PeriodValue": 0, ~/~/ Значение периода. 4513 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4152 4152 } 4153 4153 ] 4154 4154 } 4155 4155 4518 + 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 - Месяцы 4521 +((( 4522 +{ 4523 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4524 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4525 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4526 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4527 + "Name": "string", ~/~/ Наименование. 4528 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4529 + "Constraint": { ~/~/ Ограничения по тарифу 4530 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4531 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4532 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4533 + }, 4534 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4535 + { 4536 + "Feature": "string", ~/~/Код услуги. 4537 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4538 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4539 + "Price": 0, ~/~/ Цена за единицу. 4540 + "PeriodValue": 0, ~/~/ Значение периода. 4541 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4542 + } 4543 + ], 4544 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4545 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4546 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4547 + }, 4548 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4549 + { 4550 + "Feature": "string", ~/~/ Код услуги. 4551 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4552 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4553 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4554 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4555 + "Price": 0, ~/~/ Цена за единицу. 4556 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4557 + "PeriodValue": 0, ~/~/ Значение периода. 4558 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4559 + "Quantity": 0 ~/~/ Количество использования услуги. 4560 + } 4561 + ] 4562 +} 4563 +))) 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 4668 +== **Импортировать историю ТС (Асинхронный запрос)** == 4669 + 4670 +(% class="box successmessage" %) 4671 +((( 4672 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4673 +))) 4674 + 4675 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4676 + 4677 +Метод запроса: **POST** 4678 + 4679 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4680 + 4681 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4682 + 4683 + 4684 +Ответ: 4685 + 4686 +{ 4687 + 4688 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4689 + 4690 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4691 + 4692 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4693 + 4694 + "Message": "string", ~/~/ Информация о выполнении запроса 4695 + 4696 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4697 + 4698 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4699 + 4700 + "Data": "string" ~/~/ Данные 4701 + 4702 +} 4703 + 4704 + 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 ТС 4722 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4723 +**Параметр** 4724 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4725 +**Описание** 4726 +))) 4727 +|((( 4728 +activity 4729 +)))|((( 4730 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4731 +))) 4732 +|((( 4733 +progress 4734 +)))|((( 4735 +Guid ТС 4736 +))) 4293 4293 4738 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4739 + 4740 +(% class="box infomessage" %) 4741 +((( 4742 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4743 +))) 4744 + 4745 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4746 + 4747 +Метод запроса: **GET** 4748 + 4749 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4750 + 4751 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4752 + 4753 + 4754 +Ответ: 4755 + 4756 +{ 4757 + 4758 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4759 + 4760 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4761 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4762 + 4763 + "Message": "string", ~/~/ Информация о выполнении запроса 4764 + 4765 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4766 + 4767 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4768 + 4769 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4770 + 4771 + "Data": "string" ~/~/ Данные 4772 + 4773 +} 4774 + 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 } 5286 + 5287 + 5288 +== **Превышение скорости** == 5289 + 5290 +(% class="box infomessage" %) 5291 +((( 5292 +**POST /api/v3/Reports/overSpeedDuration** 4805 4805 ))) 4806 4806 5295 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5296 + 5297 +Пример запроса: 5298 + 5299 +((( 5300 +{ 5301 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5302 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5303 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5304 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5305 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5306 +} 5307 +))) 5308 + 5309 +((( 5310 + 5311 +))) 5312 + 5313 +((( 5314 +Пример ответа: 5315 +))) 5316 + 5317 +((( 5318 +((( 5319 +[ 5320 + { 5321 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5322 + "duration": 0, ~/~/ Продолжительность события в секундах 5323 + "maxSpeed": 0, ~/~/ Максимальная скорость 5324 + "speedLimit": 0 ~/~/ Ограничение скорости 5325 + } 5326 +] 5327 +))) 5328 +))) 5329 +))) 5330 + 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 5405 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5406 +X-agent - ID клиента 5407 + 4881 4881 Пример запроса: 4882 4882 4883 4883 ((( 4884 4884 { 4885 4885 "extId": "string", 4886 - "shape": " string", ~/~/ Форма поля4887 - "shapeFormat": "s tring", ~/~/ Формат, в котором представлена форма поля5413 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5414 + "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 } 5884 + 5885 + 5886 +== **Какие поля посещал объект** == 5887 + 5888 +(% class="box successmessage" %) 5889 +((( 5890 +**POST /api/v3/agroLands/visitingByVehicle** 5381 5381 ))) 5382 5382 5893 +Пример запроса: 5383 5383 5895 +{ 5896 + "vehicleId": 0, ~/~/ id объекта 5897 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5898 + "byTime": 0, ~/~/ Объединение событий по времени 5899 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5900 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5901 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5902 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5903 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5904 +} 5905 + 5906 +Пример ответа: 5907 + 5908 +[ 5909 + { 5910 + "fieldId": 0, ~/~/ id объекта 5911 + "vehicleName": "string", ~/~/ Наименование объекта 5912 + "fieldName": "string", ~/~/ Наименование поля 5913 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5914 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5915 + "vehicleId": 0, ~/~/ Идентификатор ТС 5916 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5917 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5918 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5919 + "mileage": 0 ~/~/ Пробег 5920 + } 5921 +] 5922 +))) 5923 + 5924 + 5925 +== **Посещение поля объектами ** == 5926 + 5927 +(% class="box successmessage" %) 5928 +((( 5929 +**POST /api/v3/agroLands/visitingByField** 5930 +))) 5931 + 5932 +Пример запроса: 5933 +{ 5934 + "fieldId": 0, ~/~/ ID поля 5935 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5936 + "byTime": 0, ~/~/ Объединение событий по времени 5937 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5938 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5939 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5940 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5941 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5942 +} 5943 + 5944 +Пример ответа: 5945 + 5946 +[ 5947 + { 5948 + "fieldId": 0, ~/~/ ID поля 5949 + "vehicleName": "string", ~/~/ Наименование объекта 5950 + "fieldName": "string", ~/~/ Имя поля 5951 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5952 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5953 + "vehicleId": 0, ~/~/ Идентификатор ТС 5954 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5955 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5956 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5957 + "mileage": 0 ~/~/ Пробег 5958 + } 5959 +] 5960 + 5961 + 5962 +== **Удаление существующего поля** == 5963 + 5964 +(% class="box errormessage" %) 5965 +((( 5966 +**DELETE /api/v3/agroLands/{id}** 5967 +))) 5968 + 5969 +Пример запроса: 5970 +id ~/~/ Идентификатор поля 5971 + 5972 +Пример ответа: 5973 + 5974 +((( 5975 +200 ~/~/ Успех 5976 + 5977 + 5978 +))) 5979 + 5384 5384 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5385 5385 ))) 5386 5386 ))) ... ... @@ -5483,7 +5483,6 @@ 5483 5483 5484 5484 В заголовках запроса: X-Auth: Токен авторизации 5485 5485 5486 - 5487 5487 Пример запроса: 5488 5488 5489 5489 ((( ... ... @@ -5570,7 +5570,6 @@ 5570 5570 } 5571 5571 ))) 5572 5572 5573 - 5574 5574 Пример ответа: 5575 5575 5576 5576 { ... ... @@ -5701,11 +5701,9 @@ 5701 5701 ))) 5702 5702 5703 5703 ((( 5704 - 6298 +Пример ответа: 5705 5705 ))) 5706 5706 5707 -Пример ответа: 5708 - 5709 5709 { 5710 5710 "vehicleId": 0, ~/~/ Идентификатор ТС 5711 5711 "description": "string", ~/~/ Описание ... ... @@ -5805,6 +5805,297 @@ 5805 5805 ))) 5806 5806 5807 5807 6400 += **Раздел: Роли** = 6401 + 6402 +== **Получение списка клиентских и системных ролей пользователя ** == 6403 + 6404 +(% class="box successmessage" %) 6405 +((( 6406 +**POST /api/v3/groups/find** 6407 +))) 6408 + 6409 +Пример запроса: 6410 + 6411 +((( 6412 +{ 6413 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6414 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6415 +} 6416 +))) 6417 + 6418 +((( 6419 + 6420 +))) 6421 + 6422 +((( 6423 +Пример ответа: 6424 +))) 6425 + 6426 +((( 6427 +((( 6428 +{ 6429 + "groups": [ ~/~/ Системные роли пользователя 6430 + { 6431 + "code": "string", ~/~/ Код роли. 6432 + "name": "string", ~/~/ Имя 6433 + "shortName": "string" ~/~/ Короткое имя 6434 + } 6435 + ], 6436 + "customGroups": [ ~/~/ Системные роли пользователя 6437 + { 6438 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6439 + "name": "string", ~/~/ Наименование 6440 + "shortName": "string", ~/~/ Короткое наименование 6441 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6442 + } 6443 + ] 6444 +} 6445 +))) 6446 +))) 6447 + 6448 +((( 6449 + 6450 +))) 6451 + 6452 += **Раздел: Локатор ** = 6453 + 6454 + 6455 +== **Получение данных по локатору** == 6456 + 6457 +(% class="box infomessage" %) 6458 +((( 6459 +**GET /api/v3/locators/{locatorId}** 6460 +))) 6461 + 6462 +В запросе указывается locatorid - идентификатор локатора 6463 + 6464 +Пример ответа: 6465 + 6466 +((( 6467 +((( 6468 +{ 6469 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6470 + 0 6471 + ], 6472 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6473 + 0 6474 + ], 6475 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6476 + 0 6477 + ], 6478 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6479 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6480 + "agentName": "string", ~/~/ Наименование агента. 6481 + "isEnabled": true, ~/~/ Активность 6482 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6483 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6484 + "name": "string", ~/~/ Наименование. 6485 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6486 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6487 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6488 + "validity": 0, ~/~/ Значение срока действия 6489 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6490 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6491 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6492 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6493 + "url": "string", ~/~/ Ссылка 6494 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6495 + 6496 + "showVehicleName": true, ~/~/ Наименование объекта 6497 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6498 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6499 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6500 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6501 + "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ГИС) 6502 + 6503 + 1 6504 + 6505 + ] 6506 +} 6507 +))) 6508 +))) 6509 + 6510 + 6511 +== **Создание локатора** == 6512 + 6513 +(% class="box successmessage" %) 6514 +((( 6515 +**POST /api/v3/locators** 6516 +))) 6517 + 6518 +Пример запроса: 6519 + 6520 +((( 6521 +{ 6522 + "isEnabled": true, ~/~/ Активность 6523 + "name": "string", ~/~/ Наименование локатора 6524 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6525 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6526 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6527 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6528 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6529 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6530 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6531 + 0 6532 + ], 6533 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6534 + 0 6535 + ], 6536 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6537 + 0 6538 + ], 6539 + 6540 + "showVehicleName": true, ~/~/ Наименование объекта 6541 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6542 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6543 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6544 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6545 + "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ГИС) 6546 + 6547 + 1 6548 + 6549 + ] 6550 +} 6551 +))) 6552 + 6553 +Пример ответа: 6554 + 6555 +((( 6556 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6557 +))) 6558 + 6559 + 6560 +== **Выводит список локаторов ** == 6561 + 6562 +(% class="box successmessage" %) 6563 +((( 6564 +**POST /api/v3/locators/find** 6565 +))) 6566 + 6567 +Пример запроса: 6568 + 6569 +((( 6570 +{ 6571 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6572 +} 6573 +))) 6574 + 6575 +((( 6576 + 6577 +))) 6578 + 6579 +Пример ответа: 6580 + 6581 +((( 6582 +[ 6583 + { 6584 + "vehiclesCount": 0, ~/~/ Количество объектов. 6585 + "geozonesCount": 0, ~/~/ Количество геозон. 6586 + "fieldsCount": 0, ~/~/ Количество полей. 6587 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6588 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6589 + "agentName": "string", ~/~/ Наименование агента. 6590 + "isEnabled": true, ~/~/ Активность локатора 6591 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6592 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6593 + "name": "string", ~/~/ Наименование локатора 6594 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6595 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6596 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6597 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6598 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6599 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6600 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6601 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6602 + "url": "string", ~/~/ ссылка на локатор 6603 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6604 + "showVehicleName": true, ~/~/ Наименование объекта 6605 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6606 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6607 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6608 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6609 + "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ГИС) 6610 + 6611 + 0 6612 + ] 6613 + } 6614 +] 6615 +))) 6616 + 6617 + 6618 +== **Изменение локатора** == 6619 + 6620 +(% class="box infomessage" %) 6621 +((( 6622 +**PUT /api/v3/locators** 6623 +))) 6624 + 6625 +Пример запроса: 6626 + 6627 +((( 6628 +{ 6629 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6630 + "isEnabled": true, ~/~/ Активность 6631 + "name": "string", ~/~/ Наименование 6632 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6633 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6634 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6635 + "autoProlongation": true, ~/~/ Автопродление срока действия 6636 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6637 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6638 + 0 6639 + ], 6640 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6641 + 0 6642 + ], 6643 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6644 + 0 6645 + ], 6646 + "showVehicleName": true, ~/~/ Наименование объекта 6647 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6648 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6649 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6650 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6651 + "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ГИС) 6652 + 6653 + 0 6654 + 6655 + ] 6656 +} 6657 + 6658 + 6659 +))) 6660 + 6661 +Пример ответа: 6662 + 6663 +200 ~/~/ Success 6664 + 6665 + 6666 +== **Удалить локатор** == 6667 + 6668 +(% class="box warningmessage" %) 6669 +((( 6670 +**DELETE /api/v3/locators** 6671 +))) 6672 + 6673 +Пример запроса: 6674 + 6675 +((( 6676 +[ 6677 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6678 +] 6679 +))) 6680 + 6681 + 6682 += = 6683 + 6684 +((( 6685 +((( 6686 + 6687 +))) 6688 +))) 6689 + 6690 + 5808 5808 (% class="box" lang="en-US" style="text-align: center;" %) 5809 5809 ((( 5810 5810 (% 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]] **