Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Андрей Калиновский 2025/08/08 13:28
<
>
отредактировано Андрей Калиновский
на 2025/03/12 10:28
на 2025/03/12 10:28
отредактировано Андрей Калиновский
на 2025/07/29 15:41
на 2025/07/29 15:41
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -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,8 @@ 749 749 (% style="text-align:left" %) 750 750 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 751 751 747 += = 748 + 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,860 + "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,879 + "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" %)Метод позволяет изменить статус пользователя, указанного в запросе.913 +(% 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" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.980 +(% 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 секунд. Весь период разбивает на подпериоды с указанной частотой. 2372 + "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 секунд. Весь период разбивает на подпериоды с указанной частотой. 2419 + "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, ~/~/ Уровень топлива на конец периода 2438 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2439 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2513 2513 "fuelConsumption": 0, ~/~/ Расход топлива 2514 2514 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2442 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2443 + 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 - слив 2489 + "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 2490 + 2561 2561 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2562 2562 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2563 2563 "valueFuel": 0, ~/~/ Количество ... ... @@ -2636,26 +2636,50 @@ 2636 2636 В заголовках запроса: X-Auth: Токен авторизации 2637 2637 2638 2638 2639 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2569 +В массиве указываем id объектов через запятую 2640 2640 2641 2641 Ответ: 2572 + 2573 +[ 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": [ ~/~/Сведения по геозонам. 2575 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2576 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2577 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2578 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2579 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2580 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2581 + "speed": 31, ~/~/ Скорость объекта 2582 + "course": 116, ~/~/ Курс движения [0;360] 2583 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2584 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2585 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2586 + "geozones": [ ~/~/ Сведения по геозонам. 2655 2655 { 2656 - "id": 0, 2657 - "name": "string" 2588 + "id": 10225647, ~/~/ ID Геозоны 2589 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2590 + }, 2591 + { 2592 + "id": 10282875, ~/~/ ID Геозоны 2593 + "name": "Ё2" ~/~/ Наименование геозоны 2594 + }, 2595 + { 2596 + "id": 10226240, ~/~/ ID Геозоны 2597 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2598 + }, 2599 + { 2600 + "id": 9747869, ~/~/ ID Геозоны 2601 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2602 + }, 2603 + { 2604 + "id": 10221123, ~/~/ ID Геозоны 2605 + "name": "53r" ~/~/ Наименование геозоны 2606 + }, 2607 + { 2608 + "id": 10197638, ~/~/ ID Геозоны 2609 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2658 2658 } 2611 + ] 2612 + } 2659 2659 2660 2660 2661 2661 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = ... ... @@ -2786,6 +2786,35 @@ 2786 2786 } 2787 2787 ] 2788 2788 2743 + 2744 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2745 + 2746 +(% class="box successmessage" %) 2747 +((( 2748 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2749 +))) 2750 + 2751 +(% style="color:#000000" %)Метод запроса: **PUT** 2752 + 2753 +Пример запроса: 2754 + 2755 +((( 2756 +{ 2757 + "id": 0, ~/~/ Идентификатор объекта геозоны 2758 + "name": "string", ~/~/ Наименование объекта геозоны 2759 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2760 + "description": "string", ~/~/ Описание объекта геозоны 2761 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2762 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2763 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2764 +} 2765 +))) 2766 + 2767 + 2768 +Пример ответа: 2769 + 2770 +200 ~/~/ Success 2771 + 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 - Выполнение ТО 2803 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2821 2821 "userId": "", ~/~/ Пользователь, создавший уведомление 2822 2822 "parentId": "", ~/~/ Идентификатор клиента 2823 2823 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2824,6 +2824,155 @@ 2824 2824 } 2825 2825 ] 2826 2826 2810 + 2811 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2812 + 2813 +(% class="box infomessage" %) 2814 +((( 2815 +**POST /api/v3/notifications** 2816 +))) 2817 + 2818 +Метод запроса **POST** 2819 + 2820 +(% style="text-align: left;" %) 2821 +(% style="color:#000000" %)Пример запроса 2822 + 2823 +((( 2824 +{ 2825 + "id": 0, ~/~/ ID правила 2826 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2827 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2828 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2829 + "name": "string", ~/~/ Имя правила 2830 + "active": true, ~/~/ Активность правила 2831 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2832 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2833 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2834 + ], 2835 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2836 + 0 2837 + ], 2838 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2839 + 0 2840 + ], 2841 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2842 + 0 2843 + ], 2844 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2845 + "additionalProp1": "string", 2846 + "additionalProp2": "string", 2847 + "additionalProp3": "string" 2848 + }, 2849 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2850 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2851 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2852 + ], 2853 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2854 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2855 + "string" 2856 + ], 2857 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2858 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2859 + { 2860 + "id": 0, ~/~/ Идентификатор участника чата. 2861 + "info": "string" ~/~/ Дополнительные сведения. 2862 + } 2863 + ], 2864 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2865 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2866 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2867 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2868 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2869 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2870 + "timezone": 0, ~/~/ часовой пояс 2871 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2872 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2873 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2874 + { 2875 + "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 - Срок действия правила истек 2876 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2877 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2878 + "additionalProp1": "string", 2879 + "additionalProp2": "string", 2880 + "additionalProp3": "string" 2881 + } 2882 + } 2883 + ] 2884 +} 2885 +))) 2886 + 2887 +((( 2888 + 2889 +))) 2890 + 2891 +((( 2892 + 2893 +))) 2894 + 2895 +Ответ: 2896 + 2897 +{ 2898 + "id": 0, ~/~/ ID правила 2899 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2900 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2901 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2902 + "name": "string", ~/~/ Имя правила 2903 + "active": true, ~/~/ Активность правила 2904 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2905 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2906 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2907 + ], 2908 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2909 + 0 2910 + ], 2911 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2912 + 0 2913 + ], 2914 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2915 + 0 2916 + ], 2917 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2918 + "additionalProp1": "string", 2919 + "additionalProp2": "string", 2920 + "additionalProp3": "string" 2921 + }, 2922 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2923 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2924 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2925 + ], 2926 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2927 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2928 + "string" 2929 + ], 2930 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2931 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2932 + { 2933 + "id": 0, ~/~/ Идентификатор участника чата. 2934 + "info": "string" ~/~/ Дополнительные сведения. 2935 + } 2936 + ], 2937 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2938 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2939 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2940 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2941 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2942 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2943 + "timezone": 0, ~/~/ часовой пояс 2944 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2945 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2946 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2947 + { 2948 + "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 - Срок действия правила истек 2949 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2950 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2951 + "additionalProp1": "string", 2952 + "additionalProp2": "string", 2953 + "additionalProp3": "string" 2954 + } 2955 + } 2956 + ] 2957 +} 2958 + 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 4176 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4177 + "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 4193 +((( 4065 4065 { 4066 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4067 - " Balance": 04195 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4196 + "amount": 0 ~/~/ Сумма пополнения баланса 4068 4068 } 4198 +))) 4069 4069 4200 +((( 4201 + 4202 +))) 4203 + 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" %)Значение баланса 4206 +((( 4207 +{ 4208 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4209 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4210 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4211 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4212 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4213 + "Description": "string" ~/~/ Описание корректировки. 4214 +} 4215 +))) 4075 4075 4076 4076 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4077 4077 ... ... @@ -4084,16 +4084,25 @@ 4084 4084 4085 4085 Тело запроса: 4086 4086 4228 +((( 4087 4087 { 4088 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4089 - " Balance": 04230 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4231 + "amount": 0 ~/~/ Сумма списания с баланса 4090 4090 } 4233 +))) 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" %)Значение баланса 4237 +((( 4238 +{ 4239 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4240 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4241 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4242 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4243 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4244 + "Description": "string" ~/~/ Описание корректировки 4245 +} 4246 +))) 4097 4097 4098 4098 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4099 4099 ... ... @@ -4104,28 +4104,35 @@ 4104 4104 4105 4105 Тело запроса: 4106 4106 4257 +((( 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, 4259 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4260 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4261 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4262 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4263 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4264 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4115 4115 } 4266 +))) 4116 4116 4268 +((( 4269 + 4270 +))) 4271 + 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 -Отсрочка, количество дней 4274 +((( 4275 +{ 4276 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4277 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4278 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4279 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4280 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4281 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4282 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4283 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4284 +} 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": [ 4297 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4298 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4299 + "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 4301 + "Feature": "string", ~/~/ Код услуги. 4302 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4303 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4304 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4305 + "Price": 0, ~/~/ Цена за единицу. 4306 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4307 + "PeriodValue": 0, ~/~/ Значение периода. 4308 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4152 4152 } 4153 4153 ] 4154 4154 } 4155 4155 4313 + 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 - Месяцы 4316 +((( 4317 +{ 4318 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4319 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4320 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4321 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4322 + "Name": "string", ~/~/ Наименование. 4323 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4324 + "Constraint": { ~/~/ Ограничения по тарифу 4325 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4326 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4327 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4328 + }, 4329 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4330 + { 4331 + "Feature": "string", ~/~/Код услуги. 4332 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4333 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4334 + "Price": 0, ~/~/ Цена за единицу. 4335 + "PeriodValue": 0, ~/~/ Значение периода. 4336 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4337 + } 4338 + ], 4339 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4340 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4341 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4342 + }, 4343 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4344 + { 4345 + "Feature": "string", ~/~/ Код услуги. 4346 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4347 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4348 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4349 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4350 + "Price": 0, ~/~/ Цена за единицу. 4351 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4352 + "PeriodValue": 0, ~/~/ Значение периода. 4353 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4354 + "Quantity": 0 ~/~/ Количество использования услуги. 4355 + } 4356 + ] 4357 +} 4358 +))) 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 4463 +== **Импортировать историю ТС (Асинхронный запрос)** == 4464 + 4465 +(% class="box successmessage" %) 4466 +((( 4467 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4468 +))) 4469 + 4470 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4471 + 4472 +Метод запроса: **POST** 4473 + 4474 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4475 + 4476 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4477 + 4478 + 4479 +Ответ: 4480 + 4481 +{ 4482 + 4483 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4484 + 4485 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4486 + 4487 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4488 + 4489 + "Message": "string", ~/~/ Информация о выполнении запроса 4490 + 4491 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4492 + 4493 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4494 + 4495 + "Data": "string" ~/~/ Данные 4496 + 4497 +} 4498 + 4499 + 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 ТС 4517 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4518 +**Параметр** 4519 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4520 +**Описание** 4521 +))) 4522 +|((( 4523 +activity 4524 +)))|((( 4525 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4526 +))) 4527 +|((( 4528 +progress 4529 +)))|((( 4530 +Guid ТС 4531 +))) 4293 4293 4533 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4534 + 4535 +(% class="box infomessage" %) 4536 +((( 4537 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4538 +))) 4539 + 4540 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4541 + 4542 +Метод запроса: **GET** 4543 + 4544 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4545 + 4546 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4547 + 4548 + 4549 +Ответ: 4550 + 4551 +{ 4552 + 4553 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4554 + 4555 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4556 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4557 + 4558 + "Message": "string", ~/~/ Информация о выполнении запроса 4559 + 4560 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4561 + 4562 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4563 + 4564 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4565 + 4566 + "Data": "string" ~/~/ Данные 4567 + 4568 +} 4569 + 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 } 5081 + 5082 + 5083 +== **Превышение скорости** == 5084 + 5085 +(% class="box infomessage" %) 5086 +((( 5087 +**POST /api/v3/Reports/overSpeedDuration** 4805 4805 ))) 4806 4806 5090 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5091 + 5092 +Пример запроса: 5093 + 5094 +((( 5095 +{ 5096 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5097 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5098 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5099 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5100 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5101 +} 5102 +))) 5103 + 5104 +((( 5105 + 5106 +))) 5107 + 5108 +((( 5109 +Пример ответа: 5110 +))) 5111 + 5112 +((( 5113 +((( 5114 +[ 5115 + { 5116 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5117 + "duration": 0, ~/~/ Продолжительность события в секундах 5118 + "maxSpeed": 0, ~/~/ Максимальная скорость 5119 + "speedLimit": 0 ~/~/ Ограничение скорости 5120 + } 5121 +] 5122 +))) 5123 +))) 5124 +))) 5125 + 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 5200 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5201 +X-agent - ID клиента 5202 + 4881 4881 Пример запроса: 4882 4882 4883 4883 ((( 4884 4884 { 4885 4885 "extId": "string", 4886 - "shape": " string", ~/~/ Форма поля4887 - "shapeFormat": "s tring", ~/~/ Формат, в котором представлена форма поля5208 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5209 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4888 4888 "display": "string", ~/~/ Настройки отображения 4889 4889 "year": 0, ~/~/ Год поля 4890 4890 "name": "string", ~/~/ Наименование ... ... @@ -5106,23 +5106,8 @@ 5106 5106 ))) 5107 5107 5108 5108 5109 -== **Удаление существующего поля** == 5110 5110 5111 -(% class="box errormessage" %) 5112 5112 ((( 5113 -**DELETE /api/v3/agroLands/{id}** 5114 -))) 5115 - 5116 -Пример запроса: 5117 -id ~/~/ Идентификатор поля 5118 - 5119 -Пример ответа: 5120 - 5121 -((( 5122 -200 ~/~/ Успех 5123 -))) 5124 - 5125 -((( 5126 5126 5127 5127 ))) 5128 5128 ... ... @@ -5129,10 +5129,6 @@ 5129 5129 ((( 5130 5130 ((( 5131 5131 ((( 5132 - 5133 -))) 5134 - 5135 -((( 5136 5136 == **Изменение поля** == 5137 5137 5138 5138 (% class="box infomessage" %) ... ... @@ -5378,9 +5378,102 @@ 5378 5378 "perimetr": 0, ~/~/ ериметр, м 5379 5379 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5380 5380 } 5684 + 5685 + 5686 +== **Какие поля посещал объект** == 5687 + 5688 +(% class="box successmessage" %) 5689 +((( 5690 +**POST /api/v3/agroLands/visitingByVehicle** 5381 5381 ))) 5382 5382 5693 +Пример запроса: 5383 5383 5695 +{ 5696 + "vehicleId": 0, ~/~/ id объекта 5697 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5698 + "byTime": 0, ~/~/ Объединение событий по времени 5699 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5700 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5701 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5702 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5703 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5704 +} 5705 + 5706 +Пример ответа: 5707 + 5708 +[ 5709 + { 5710 + "fieldId": 0, ~/~/ id объекта 5711 + "vehicleName": "string", ~/~/ Наименование объекта 5712 + "fieldName": "string", ~/~/ Наименование поля 5713 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5714 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5715 + "vehicleId": 0, ~/~/ Идентификатор ТС 5716 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5717 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5718 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5719 + "mileage": 0 ~/~/ Пробег 5720 + } 5721 +] 5722 +))) 5723 + 5724 + 5725 +== **Посещение поля объектами ** == 5726 + 5727 +(% class="box successmessage" %) 5728 +((( 5729 +**POST /api/v3/agroLands/visitingByField** 5730 +))) 5731 + 5732 +Пример запроса: 5733 +{ 5734 + "fieldId": 0, ~/~/ ID поля 5735 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5736 + "byTime": 0, ~/~/ Объединение событий по времени 5737 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5738 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5739 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5740 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5741 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5742 +} 5743 + 5744 +Пример ответа: 5745 + 5746 +[ 5747 + { 5748 + "fieldId": 0, ~/~/ ID поля 5749 + "vehicleName": "string", ~/~/ Наименование объекта 5750 + "fieldName": "string", ~/~/ Имя поля 5751 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5752 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5753 + "vehicleId": 0, ~/~/ Идентификатор ТС 5754 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5755 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5756 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5757 + "mileage": 0 ~/~/ Пробег 5758 + } 5759 +] 5760 + 5761 + 5762 +== **Удаление существующего поля** == 5763 + 5764 +(% class="box errormessage" %) 5765 +((( 5766 +**DELETE /api/v3/agroLands/{id}** 5767 +))) 5768 + 5769 +Пример запроса: 5770 +id ~/~/ Идентификатор поля 5771 + 5772 +Пример ответа: 5773 + 5774 +((( 5775 +200 ~/~/ Успех 5776 + 5777 + 5778 +))) 5779 + 5384 5384 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5385 5385 ))) 5386 5386 ))) ... ... @@ -5805,49 +5805,129 @@ 5805 5805 ))) 5806 5806 5807 5807 6204 += **Раздел: Роли** = 6205 + 6206 +== **Получение списка клиентских и системных ролей пользователя ** == 6207 + 6208 +(% class="box successmessage" %) 6209 +((( 6210 +**POST /api/v3/groups/find** 6211 +))) 6212 + 6213 +Пример запроса: 6214 + 6215 +((( 6216 +{ 6217 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6218 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6219 +} 6220 +))) 6221 + 6222 +((( 6223 + 6224 +))) 6225 + 6226 +((( 6227 +Пример ответа: 6228 +))) 6229 + 6230 +((( 6231 +((( 6232 +{ 6233 + "groups": [ ~/~/ Системные роли пользователя 6234 + { 6235 + "code": "string", ~/~/ Код роли. 6236 + "name": "string", ~/~/ Имя 6237 + "shortName": "string" ~/~/ Короткое имя 6238 + } 6239 + ], 6240 + "customGroups": [ ~/~/ Системные роли пользователя 6241 + { 6242 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6243 + "name": "string", ~/~/ Наименование 6244 + "shortName": "string", ~/~/ Короткое наименование 6245 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6246 + } 6247 + ] 6248 +} 6249 +))) 6250 +))) 6251 + 6252 +((( 6253 + 6254 +))) 6255 + 6256 +((( 6257 + 6258 +))) 6259 + 5808 5808 = **Раздел: Локатор ** = 5809 5809 5810 5810 5811 -== **Получение списка локаторов,доступных пользователю** ==6263 +== **Получение данных по локатору** == 5812 5812 5813 5813 (% class="box infomessage" %) 5814 5814 ((( 5815 -**GET /api/v3/locators** 6267 +**GET /api/v3/locators/{locatorId}** 5816 5816 ))) 5817 5817 5818 -В за головкахзапроса:X-Auth:Токен авторизации6270 +В запросе указывается 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 -] 6276 +((( 6277 +{ 6278 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6279 + 0 6280 + ], 6281 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6282 + 0 6283 + ], 6284 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6285 + 0 6286 + ], 6287 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6288 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6289 + "agentName": "string", ~/~/ Наименование агента. 6290 + "isEnabled": true, ~/~/ Активность 6291 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6292 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6293 + "name": "string", ~/~/ Наименование. 6294 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6295 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6296 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6297 + "validity": 0, ~/~/ Значение срока действия 6298 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6299 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6300 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6301 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6302 + "url": "string", ~/~/ Ссылка 6303 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6304 + 6305 + "showVehicleName": true, ~/~/ Наименование объекта 6306 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6307 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6308 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6309 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6310 + "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ГИС) 6311 + 6312 + 1 6313 + 6314 + ] 6315 +} 5847 5847 ))) 6317 +))) 5848 5848 5849 5849 6320 +((( 6321 +((( 6322 + 6323 +))) 6324 +))) 5850 5850 6326 + 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 ~/~/ Язык 6344 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6345 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6346 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6347 + 0 6348 + ], 6349 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6350 + 0 6351 + ], 6352 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6353 + 0 6354 + ], 6355 + 6356 + "showVehicleName": true, ~/~/ Наименование объекта 6357 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6358 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6359 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6360 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6361 + "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ГИС) 6362 + 6363 + 1 6364 + 6365 + ] 5871 5871 } 5872 5872 ))) 5873 5873 ... ... @@ -5879,7 +5879,69 @@ 5879 5879 ))) 5880 5880 5881 5881 6377 +== **Выводит список локаторов ** == 5882 5882 6379 +(% class="box successmessage" %) 6380 +((( 6381 +**POST /api/v3/locators/find** 6382 +))) 6383 + 6384 +Пример запроса: 6385 + 6386 +((( 6387 +{ 6388 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6389 +} 6390 +))) 6391 + 6392 +((( 6393 + 6394 +))) 6395 + 6396 +((( 6397 + 6398 +))) 6399 + 6400 + 6401 +Пример ответа: 6402 + 6403 +((( 6404 +[ 6405 + { 6406 + "vehiclesCount": 0, ~/~/ Количество объектов. 6407 + "geozonesCount": 0, ~/~/ Количество геозон. 6408 + "fieldsCount": 0, ~/~/ Количество полей. 6409 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6410 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6411 + "agentName": "string", ~/~/ Наименование агента. 6412 + "isEnabled": true, ~/~/ Активность локатора 6413 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6414 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6415 + "name": "string", ~/~/ Наименование локатора 6416 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6417 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6418 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6419 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6420 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6421 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6422 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6423 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6424 + "url": "string", ~/~/ ссылка на локатор 6425 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6426 + "showVehicleName": true, ~/~/ Наименование объекта 6427 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6428 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6429 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6430 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6431 + "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ГИС) 6432 + 6433 + 0 6434 + ] 6435 + } 6436 +] 6437 +))) 6438 + 6439 + 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 ~/~/ Язык 6458 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6459 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6460 + 0 6461 + ], 6462 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6463 + 0 6464 + ], 6465 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6466 + 0 6467 + ], 6468 + "showVehicleName": true, ~/~/ Наименование объекта 6469 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6470 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6471 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6472 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6473 + "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ГИС) 6474 + 6475 + 0 6476 + 6477 + ] 5903 5903 } 6479 + 6480 + 5904 5904 ))) 5905 5905 5906 - 5907 5907 Пример ответа: 5908 5908 5909 5909 200 ~/~/ Success ... ... @@ -5925,8 +5925,201 @@ 5925 5925 ))) 5926 5926 5927 5927 6504 += **Раздел: Яндекс Маршруты** = 5928 5928 5929 5929 6507 +== **Возвращение списка маршрутов** == 6508 + 6509 +(% class="box infomessage" %) 6510 +((( 6511 +**GET /api/v3/TransportRoutes** 6512 +))) 6513 + 6514 +Пример запроса: 6515 +Id ~/~/ Идентификатор поля 6516 + 6517 +Пример ответа: 6518 + 6519 +((( 6520 +[ 6521 + { 6522 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6523 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6524 + "name": "string", ~/~/ Наименование маршрута. 6525 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6526 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6527 + 0 6528 + ] 6529 + } 6530 +] 6531 +))) 6532 + 6533 + 6534 +== **Добавить маршрут** == 6535 + 6536 +(% class="box infomessage" %) 6537 +((( 6538 +**POST /api/v3/TransportRoutes** 6539 +))) 6540 + 6541 +Пример запроса: 6542 +{ 6543 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6544 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6545 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6546 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6547 + 0 6548 + ] 6549 +} 6550 + 6551 + 6552 +Пример ответа: 6553 + 6554 +((( 6555 +{ 6556 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6557 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6558 + "name": "string", ~/~/ Определяет наименование маршрута 6559 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6560 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6561 + 0 6562 + ] 6563 +} 6564 +))) 6565 + 6566 + 6567 +== **Обновление маршрута** == 6568 + 6569 +(% class="box successmessage" %) 6570 +((( 6571 +**PUT /api/v3/TransportRoutes** 6572 +))) 6573 + 6574 +Пример запроса: 6575 + 6576 +((( 6577 +{ 6578 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6579 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6580 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6581 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6582 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6583 + 0 6584 + ] 6585 +} 6586 +))) 6587 + 6588 +Пример ответа: 6589 + 6590 +((( 6591 +{ 6592 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6593 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6594 + "name": "string", ~/~/ Определяет наименование маршрута 6595 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6596 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6597 + 0 6598 + ] 6599 +} 6600 +))) 6601 + 6602 + 6603 +== **Получить связки маршрутов ТС** == 6604 + 6605 +(% class="box infomessage" %) 6606 +((( 6607 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6608 +))) 6609 + 6610 +Пример запроса: 6611 + 6612 +((( 6613 +[ 6614 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6615 +] 6616 +))) 6617 + 6618 +Пример ответа: 6619 + 6620 +((( 6621 +[ 6622 + { 6623 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6624 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6625 + } 6626 +] 6627 +))) 6628 + 6629 + 6630 +== **Удалить маршрут** == 6631 + 6632 +(% class="box warningmessage" %) 6633 +((( 6634 +**DELETE /api/v3/TransportRoutes/{id}** 6635 +))) 6636 + 6637 +Пример запроса: 6638 +Id ~/~/ Идентификатор поля 6639 + 6640 + 6641 += **Раздел: Управление доступа к машинам** = 6642 + 6643 + 6644 +== Получение списка транспортных средств видимых пользователю == 6645 + 6646 +(% class="box infomessage" %) 6647 +((( 6648 +**GET /api/v3/UserVisibleVehicles/{userId}** 6649 +))) 6650 + 6651 +Пример ответа: 6652 + 6653 +((( 6654 +{ 6655 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6656 + 0 6657 + ] 6658 +} 6659 +))) 6660 + 6661 + 6662 +== Задает видимость транспортных средств пользователю == 6663 + 6664 +(% class="box infomessage" %) 6665 +((( 6666 +**POST /api/v3/UserVisibleVehicles** 6667 +))) 6668 + 6669 +Пример запроса: 6670 + 6671 +((( 6672 +((( 6673 +{ 6674 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6675 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6676 + 0 6677 + ] 6678 +} 6679 +))) 6680 + 6681 +((( 6682 + 6683 +))) 6684 + 6685 +((( 6686 +Пример ответа : 6687 +))) 6688 + 6689 +((( 6690 + 6691 +))) 6692 + 6693 +((( 6694 +200 ~/~/ Success 6695 +))) 6696 +))) 6697 + 6698 + 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]] **