Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Андрей Калиновский 2025/09/16 11:13
<
>
отредактировано Андрей Калиновский
на 2025/03/19 13:51
на 2025/03/19 13:51
отредактировано Андрей Калиновский
на 2025/09/16 10:57
на 2025/09/16 10:57
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Содержимое
-
... ... @@ -13,12 +13,10 @@ 13 13 14 14 (% class="box infomessage" %) 15 15 ((( 16 -**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в пользовательских настройках. 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 17 17 ))) 18 18 19 -При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 20 - 21 - 22 22 **Содержание страницы:** 23 23 ))) 24 24 ... ... @@ -125,29 +125,41 @@ 125 125 Запрос должен содержать данные параметра "**agentId**" 126 126 127 127 (% style="color:#000000" %)Ответ: 126 + 127 +((( 128 128 { 129 - "agentId": "", (%%) 130 - "parentId": "", 131 - "parentName": "string", 132 - "name": "string", 133 - "fullName": "string", 134 - "agentInfoType": 0, 135 - "isForeign": true/false, 136 - "district": "string", 137 - "region": "string", 138 - "city": "string", 139 - "inn": "string", 140 - "kpp": "string", 141 - "address": "string", 142 - "addressFact": "string", 143 - "email": "string", 144 - "director": "string", 145 - "bankName": "string", 146 - "bankBIK": "string", 147 - "bankRS": "string", 148 - "bankKS": "string" 149 - } 129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента 130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя 131 + "parentName": "string", ~/~/ Наименование агента 132 + "name": "string", ~/~/ Имя клиента 133 + "fullName": "string", ~/~/ ФИО клиента 134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%)) 135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент" 136 + "district": "string", ~/~/ Район 137 + "region": "string", ~/~/ Область 138 + "city": "string", ~/~/ Город 139 + "email": "string", ~/~/ Email 140 + "director": "string", ~/~/ Руководитель 141 + "RegionalData": [ ~/~/ Определяет региональные сведения. 142 + { 143 + "Country": 0, ~/~/ Страна 144 + "groups": [ ~/~/ Список групп 145 + { 146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 147 + "fields": [ ~/~/ Список значений полей 148 + { 149 + "name": "string", ~/~/ Имя поля формы 150 + "value": "string" ~/~/ Значение поля формы 151 + } 152 + ] 153 + } 154 + ] 155 + } 156 + ] 157 +} 158 +))) 150 150 160 + 151 151 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 152 152 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 153 153 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -277,28 +277,6 @@ 277 277 "bankKS": "string" ~/~/ корр. счёт 278 278 } 279 279 280 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 281 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 282 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 283 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 284 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 285 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 286 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 287 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 288 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 289 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 290 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 291 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 292 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 293 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 294 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 295 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 296 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 297 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 298 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 299 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 300 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 301 - 302 302 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 303 303 304 304 (% class="box warningmessage" %) ... ... @@ -444,7 +444,7 @@ 444 444 [ 445 445 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 446 446 ], 447 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 448 448 } 449 449 { 450 450 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -756,6 +756,11 @@ 756 756 (% style="text-align:left" %) 757 757 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 758 758 747 +(% class="wikigeneratedid" id="H" %) 748 +((( 749 + 750 +))) 751 + 759 759 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 760 760 761 761 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == ... ... @@ -867,7 +867,7 @@ 867 867 { 868 868 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 869 869 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 870 - "deleted": true,863 + "deleted": false, 871 871 "extId": "string", 872 872 "name": "string", 873 873 "picture": "string", ... ... @@ -886,7 +886,7 @@ 886 886 { 887 887 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 888 888 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 889 - "deleted": true,882 + "deleted": false, 890 890 "extId": "string", 891 891 "name": "string", 892 892 "picture": "string", ... ... @@ -920,7 +920,7 @@ 920 920 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 921 921 ))) 922 922 923 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 924 924 925 925 (% style="color:#000000" %)Метод запроса: **PUT** 926 926 ... ... @@ -987,7 +987,7 @@ 987 987 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 988 988 ))) 989 989 990 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 991 991 992 992 (% style="color:#000000" %)Метод запроса: **DELETE** 993 993 ... ... @@ -1618,77 +1618,6 @@ 1618 1618 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1619 1619 1620 1620 1621 -== **Импортировать историю ТС (Асинхронный запрос)** == 1622 - 1623 -(% class="box successmessage" %) 1624 -((( 1625 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1626 -))) 1627 - 1628 -Метод запроса: **POST** 1629 - 1630 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1631 - 1632 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1633 - 1634 - 1635 -Ответ: 1636 - 1637 -{ 1638 - 1639 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1640 - 1641 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1642 - 1643 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1644 - 1645 - "Message": "string", ~/~/ Информация о выполнении запроса 1646 - 1647 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1648 - 1649 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1650 - 1651 - "Data": "string" ~/~/ Данные 1652 - 1653 -} 1654 - 1655 - 1656 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1657 - 1658 -(% class="box infomessage" %) 1659 -((( 1660 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1661 -))) 1662 - 1663 -Метод запроса: **GET** 1664 - 1665 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1666 - 1667 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1668 - 1669 - 1670 -Ответ: 1671 - 1672 -{ 1673 - 1674 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1675 - 1676 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1677 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1678 - 1679 - "Message": "string", ~/~/ Информация о выполнении запроса 1680 - 1681 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1682 - 1683 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1684 - 1685 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1686 - 1687 - "Data": "string" ~/~/ Данные 1688 - 1689 -} 1690 - 1691 - 1692 1692 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1693 1693 1694 1694 (% class="box infomessage" %) ... ... @@ -1834,7 +1834,6 @@ 1834 1834 "stage": "", ~/~/ Состояние 1835 1835 (% style="color:#000000" %) } 1836 1836 1837 -== == 1838 1838 1839 1839 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1840 1840 ... ... @@ -2451,7 +2451,7 @@ 2451 2451 Тело запроса: 2452 2452 2453 2453 { 2454 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2455 2455 "vehicleIds": [0], ~/~/ Список ID объектов 2456 2456 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2457 2457 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2498,7 +2498,6 @@ 2498 2498 Тело запроса: 2499 2499 2500 2500 { 2501 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2502 2502 "vehicleIds": [0], ~/~/ Список ID объектов 2503 2503 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2504 2504 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2517,8 +2517,12 @@ 2517 2517 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2518 2518 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2519 2519 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2440 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2441 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2520 2520 "fuelConsumption": 0, ~/~/ Расход топлива 2521 2521 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2444 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2445 + 2522 2522 } 2523 2523 ] 2524 2524 } ... ... @@ -2564,12 +2564,21 @@ 2564 2564 "model": "string", ~/~/ Модель объекта 2565 2565 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2566 2566 { 2567 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2491 + "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 2492 + 2493 +((( 2568 2568 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2569 2569 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2570 2570 "valueFuel": 0, ~/~/ Количество 2571 2571 "fuelStart": 0, ~/~/ Уровень топлива на начало события 2572 2572 "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2499 +))) 2500 + 2501 +((( 2502 + "latitude": 0, ~/~/ Широта. 2503 + "longitude": 0 ~/~/ Долгота. 2504 +))) 2505 + 2573 2573 } 2574 2574 ] 2575 2575 } ... ... @@ -2643,194 +2643,241 @@ 2643 2643 В заголовках запроса: X-Auth: Токен авторизации 2644 2644 2645 2645 2646 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2579 +В массиве указываем id объектов через запятую 2647 2647 2648 2648 Ответ: 2582 + 2583 +[ 2649 2649 { 2650 - "vehicleId": 0, ~/~/Идентификатор объекта.2651 - "vehicleGuid": " 3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификаторобъекта.2652 - "vehicleNumber": " string",~/~/Номер объекта.2653 - "receiveTime": "202 4-02-27T14:11:00.315Z",~/~/Времяполучениязаписи на сервере,т.е. время срабатывания+ время передачи от устройствана сервер2654 - "recordTime": "202 4-02-27T14:11:00.315Z",~/~/Времязаписиотустройства, т.е. время фактическогособытия натранспортном средстве.2655 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.2656 - "speed": 0,~/~/Скорость объекта.2657 - "course": 0,~/~/Курс движения [0;360]2658 - "latitude": 0,~/~/Широта [-90°;90°].2659 - "longitude": 0,~/~/Долгота [-180°;180°]. 2660 - "address": " string",~/~/Адрес.2661 - "geozones": [ ~/~/Сведения по геозонам. 2585 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2586 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2587 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2588 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2589 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2590 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2591 + "speed": 31, ~/~/ Скорость объекта 2592 + "course": 116, ~/~/ Курс движения [0;360] 2593 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2594 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2595 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2596 + "geozones": [ ~/~/ Сведения по геозонам. 2662 2662 { 2663 - "id": 0, 2664 - "name": "string" 2598 + "id": 10225647, ~/~/ ID Геозоны 2599 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2600 + }, 2601 + { 2602 + "id": 10282875, ~/~/ ID Геозоны 2603 + "name": "Ё2" ~/~/ Наименование геозоны 2604 + }, 2605 + { 2606 + "id": 10226240, ~/~/ ID Геозоны 2607 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2608 + }, 2609 + { 2610 + "id": 9747869, ~/~/ ID Геозоны 2611 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2612 + }, 2613 + { 2614 + "id": 10221123, ~/~/ ID Геозоны 2615 + "name": "53r" ~/~/ Наименование геозоны 2616 + }, 2617 + { 2618 + "id": 10197638, ~/~/ ID Геозоны 2619 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2665 2665 } 2621 + ] 2622 + } 2666 2666 2667 2667 2668 -= (%style="color:#000000;font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%)=2625 += = 2669 2669 2670 -= =(% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==2627 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2671 2671 2629 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2630 + 2672 2672 (% class="box infomessage" %) 2673 2673 ((( 2674 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/find**2633 +**POST /api/v3/notifications/find** 2675 2675 ))) 2676 2676 2677 - (% style="color:#000000" %)Методпозволяетполучитьсписокгеообъектовклиента.Возвращает массивгеообъектовсо всей информациейоних.2636 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2678 2678 2679 -(% style="color:#000000" %)Метод запроса: **POST** 2638 +(% style="text-align: left;" %) 2639 +Метод запроса **POST** 2680 2680 2681 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2641 +(% style="text-align: left;" %) 2642 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2682 2682 2644 +(% style="text-align: left;" %) 2683 2683 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2684 2684 2685 -(% style="text-align:left" %) 2686 -Тело запроса: 2687 - 2688 -(% style="text-align:left" %) 2689 2689 { 2690 - "parentId": " 3fa85f64-5717-4562-b3fc-2c963f66afa6"2648 + "parentId": "" ~/~/ id клиента 2691 2691 } 2692 2692 2693 -(% style="text-align:left" %) 2694 2694 Ответ: 2695 2695 2696 2696 [ 2697 2697 { 2698 - "id": 0, ~/~/ Идентификатор объекта геозоны 2699 - "name": "string", ~/~/ Название объекта геозоны 2700 - "type": 0, ~/~/ Тип объекта геозоны 2701 - "fname": "string", ~/~/ Имя файла 2702 - "parentId": "string", ~/~/ Идентификатор клиента 2703 - "radius": 0, ~/~/ Радиус геообъекта 2704 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2705 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2706 - "description": "string", ~/~/ Описание 2707 - "area": 0, ~/~/ Площадь, м^^2^^ 2708 - "perimetr": 0, ~/~/ Периметр, м 2709 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2655 + "id": 0, ~/~/ ID уведомления 2656 + "name": "string", ~/~/ Название уведомления 2657 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2658 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2659 + "userId": "", ~/~/ Пользователь, создавший уведомление 2660 + "parentId": "", ~/~/ Идентификатор клиента 2661 + "parentName": "string" ~/~/ Имя клиента 2710 2710 } 2711 2711 ] 2712 2712 2713 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2714 2714 2666 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2667 + 2715 2715 (% class="box infomessage" %) 2716 2716 ((( 2717 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/intersections/vehicles**2670 +**POST /api/v3/notifications** 2718 2718 ))) 2719 2719 2720 - (% style="color:#000000" %)Методпозволяетполучить список пересечений выбранныхобъектовсо всеми геообъектамиза выбранный период.2673 +Метод запроса **POST** 2721 2721 2722 -(% style="color:#000000" %)Метод запроса: **POST** 2675 +(% style="text-align: left;" %) 2676 +(% style="color:#000000" %)Пример запроса 2723 2723 2724 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2725 - 2726 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2727 - 2728 -(% style="text-align:left" %) 2729 -Тело запроса: 2730 - 2678 +((( 2731 2731 { 2732 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2733 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2734 - "ids": [ ], ~/~/ Массив id объектов 2735 - "byTime": 0, ~/~/ Объединение событий по времени 2736 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2737 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2738 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2680 + "id": 0, ~/~/ ID правила 2681 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2682 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2683 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2684 + "name": "string", ~/~/ Имя правила 2685 + "active": true, ~/~/ Активность правила 2686 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2687 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2688 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2689 + ], 2690 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2691 + 0 2692 + ], 2693 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2694 + 0 2695 + ], 2696 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2697 + 0 2698 + ], 2699 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2700 + "additionalProp1": "string", 2701 + "additionalProp2": "string", 2702 + "additionalProp3": "string" 2703 + }, 2704 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2705 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2706 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2707 + ], 2708 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2709 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2710 + "string" 2711 + ], 2712 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2713 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2714 + { 2715 + "id": 0, ~/~/ Идентификатор участника чата. 2716 + "info": "string" ~/~/ Дополнительные сведения. 2717 + } 2718 + ], 2719 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2720 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2721 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2722 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2723 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2724 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2725 + "timezone": 0, ~/~/ часовой пояс 2726 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2727 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2728 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2729 + { 2730 + "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 - Срок действия правила истек 2731 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2732 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2733 + "additionalProp1": "string", 2734 + "additionalProp2": "string", 2735 + "additionalProp3": "string" 2736 + } 2737 + } 2738 + ] 2739 2739 } 2740 +))) 2740 2740 2741 -Ответ: 2742 -[ 2743 - { 2744 - "geozoneId": 0, ~/~/ ID геообъекта 2745 - "geozoneName": "string", ~/~/ Название геообъекта 2746 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2747 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2748 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2749 - "vehicleId": 0, ~/~/ ID объекта 2750 - "vehicleName": "string" ~/~/ Имя объекта 2751 - } 2752 -] 2753 - 2754 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2755 - 2756 -(% class="box infomessage" %) 2757 2757 ((( 2758 - (%style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**2743 + 2759 2759 ))) 2760 2760 2761 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2762 - 2763 -(% style="color:#000000" %)Метод запроса: **POST** 2764 - 2765 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2766 - 2767 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2768 - 2769 -(% style="text-align:left" %) 2770 -Тело запроса: 2771 - 2772 -{ 2773 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2774 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2775 - "ids": [ ], ~/~/ Массив id геообъектов 2776 - "byTime": 0, ~/~/ Объединение событий по времени 2777 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2778 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2779 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2780 -} 2781 - 2782 -Ответ: 2783 - 2784 -[ 2785 - { 2786 - "geozoneId": 0, ~/~/ ID геообъекта 2787 - "geozoneName": "string", ~/~/ Название геообъекта 2788 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2789 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2790 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2791 - "vehicleId": 0, ~/~/ ID объекта 2792 - "vehicleName": "string" ~/~/ Имя объекта 2793 - } 2794 -] 2795 - 2796 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2797 - 2798 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2799 - 2800 -(% class="box infomessage" %) 2801 2801 ((( 2802 - **POST/api/v3/notifications/find**2747 + 2803 2803 ))) 2804 2804 2805 - Методвозвращаетинформацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.2750 +Ответ: 2806 2806 2807 -(% style="text-align: left;" %) 2808 -Метод запроса **POST** 2809 - 2810 -(% style="text-align: left;" %) 2811 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2812 - 2813 -(% style="text-align: left;" %) 2814 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2815 - 2816 2816 { 2817 - "parentId": "" ~/~/ id клиента 2753 + "id": 0, ~/~/ ID правила 2754 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2755 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2756 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2757 + "name": "string", ~/~/ Имя правила 2758 + "active": true, ~/~/ Активность правила 2759 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2760 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2761 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2762 + ], 2763 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2764 + 0 2765 + ], 2766 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2767 + 0 2768 + ], 2769 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2770 + 0 2771 + ], 2772 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2773 + "additionalProp1": "string", 2774 + "additionalProp2": "string", 2775 + "additionalProp3": "string" 2776 + }, 2777 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2778 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2779 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2780 + ], 2781 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2782 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2783 + "string" 2784 + ], 2785 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2786 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2787 + { 2788 + "id": 0, ~/~/ Идентификатор участника чата. 2789 + "info": "string" ~/~/ Дополнительные сведения. 2790 + } 2791 + ], 2792 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2793 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2794 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2795 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2796 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2797 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2798 + "timezone": 0, ~/~/ часовой пояс 2799 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2800 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2801 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2802 + { 2803 + "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 - Срок действия правила истек 2804 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2805 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2806 + "additionalProp1": "string", 2807 + "additionalProp2": "string", 2808 + "additionalProp3": "string" 2809 + } 2810 + } 2811 + ] 2818 2818 } 2819 2819 2820 -Ответ: 2821 - 2822 -[ 2823 - { 2824 - "id": 0, ~/~/ ID уведомления 2825 - "name": "string", ~/~/ Название уведомления 2826 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 2827 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2828 - "userId": "", ~/~/ Пользователь, создавший уведомление 2829 - "parentId": "", ~/~/ Идентификатор клиента 2830 - "parentName": "string" ~/~/ Имя клиента 2831 - } 2832 -] 2833 - 2834 2834 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2835 2835 2836 2836 (% class="box infomessage" %) ... ... @@ -4048,16 +4048,12 @@ 4048 4048 Тело запроса: 4049 4049 4050 4050 { 4051 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4052 - "Balance": 0 4031 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4032 + "Balance": 0 ~/~/ Значение баланса. 4053 4053 } 4054 4054 4055 4055 Ответ: Success 4056 4056 4057 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4058 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4059 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4060 - 4061 4061 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4062 4062 4063 4063 (% class="box warningmessage" %) ... ... @@ -4069,16 +4069,29 @@ 4069 4069 4070 4070 Тело запроса: 4071 4071 4048 +((( 4072 4072 { 4073 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4074 - " Balance": 04050 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4051 + "amount": 0 ~/~/ Сумма пополнения баланса 4075 4075 } 4053 +))) 4076 4076 4055 +((( 4056 + 4057 +))) 4058 + 4077 4077 Ответ: Success 4078 4078 4079 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4080 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4081 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4061 +((( 4062 +{ 4063 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4064 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4065 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4066 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4067 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4068 + "Description": "string" ~/~/ Описание корректировки. 4069 +} 4070 +))) 4082 4082 4083 4083 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4084 4084 ... ... @@ -4091,16 +4091,25 @@ 4091 4091 4092 4092 Тело запроса: 4093 4093 4083 +((( 4094 4094 { 4095 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4096 - " Balance": 04085 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4086 + "amount": 0 ~/~/ Сумма списания с баланса 4097 4097 } 4088 +))) 4098 4098 4099 4099 Ответ: Success 4100 4100 4101 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4102 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4103 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4092 +((( 4093 +{ 4094 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4095 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4096 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4097 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4098 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4099 + "Description": "string" ~/~/ Описание корректировки 4100 +} 4101 +))) 4104 4104 4105 4105 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4106 4106 ... ... @@ -4111,28 +4111,35 @@ 4111 4111 4112 4112 Тело запроса: 4113 4113 4112 +((( 4114 4114 { 4115 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4116 - "CalculationType": 0, 4117 - "PermissibleBalance": 0, 4118 - "DefermentDays": 0, 4119 - "SendUiNotifications": true, 4120 - "SendEmailNotifications": true, 4121 - "IsPrivate": true, 4114 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4115 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4116 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4117 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4118 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4119 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4122 4122 } 4121 +))) 4123 4123 4123 +((( 4124 + 4125 +))) 4126 + 4124 4124 Ответ: Success 4125 4125 4126 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4127 -|ClientId|Идентификатор клиента 4128 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4129 -|PermissibleBalance|Допустимый баланс 4130 -|DefermentDays|((( 4131 -Отсрочка, количество дней 4129 +((( 4130 +{ 4131 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4132 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4133 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4134 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4135 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4136 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4137 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4138 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4139 +} 4132 4132 ))) 4133 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4134 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4135 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4136 4136 4137 4137 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4138 4138 ... ... @@ -4144,35 +4144,68 @@ 4144 4144 Тело запроса: 4145 4145 4146 4146 { 4147 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4148 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4149 - "Features": [ 4152 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4153 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4154 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4150 4150 { 4151 - "Feature": "string", 4152 - "IsEnabled": true, 4153 - "IsFactual": true, 4154 - "Limit": 0, 4155 - "Price": 0, 4156 - "DebitDate": "2023-10-18T13:26:58.987Z", 4157 - "PeriodValue": 0, 4158 - "PeriodType": 0 4156 + "Feature": "string", ~/~/ Код услуги. 4157 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4158 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4159 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4160 + "Price": 0, ~/~/ Цена за единицу. 4161 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4162 + "PeriodValue": 0, ~/~/ Значение периода. 4163 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4159 4159 } 4160 4160 ] 4161 4161 } 4162 4162 4168 + 4163 4163 Ответ: Success 4164 4164 4165 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4166 -|ClientId|Идентификатор клиента 4167 -|PlanId|Идентификатор тарифного плана 4168 -|Feature|Код услуги 4169 -|IsEnabled|Признак, определяющий активирована ли услуга 4170 -|IsFactual|Признак, определяющий расчёт по факту 4171 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4172 -|Price|Цена за единицу. 4173 -|DebitDate|Следующий момент времени списания с баланса за услугу. 4174 -|PeriodValue|Значение периода. 4175 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4171 +((( 4172 +{ 4173 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4174 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4175 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4176 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4177 + "Name": "string", ~/~/ Наименование. 4178 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4179 + "Constraint": { ~/~/ Ограничения по тарифу 4180 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4181 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4182 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4183 + }, 4184 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4185 + { 4186 + "Feature": "string", ~/~/Код услуги. 4187 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4188 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4189 + "Price": 0, ~/~/ Цена за единицу. 4190 + "PeriodValue": 0, ~/~/ Значение периода. 4191 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4192 + } 4193 + ], 4194 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4195 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4196 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4197 + }, 4198 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4199 + { 4200 + "Feature": "string", ~/~/ Код услуги. 4201 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4202 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4203 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4204 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4205 + "Price": 0, ~/~/ Цена за единицу. 4206 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4207 + "PeriodValue": 0, ~/~/ Значение периода. 4208 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4209 + "Quantity": 0 ~/~/ Количество использования услуги. 4210 + } 4211 + ] 4212 +} 4213 +))) 4176 4176 4177 4177 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4178 4178 ... ... @@ -4277,6 +4277,43 @@ 4277 4277 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4278 4278 |msgCount|Кол-во обработанных сообщений всего 4279 4279 4318 +== **Импортировать историю ТС (Асинхронный запрос)** == 4319 + 4320 +(% class="box successmessage" %) 4321 +((( 4322 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4323 +))) 4324 + 4325 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4326 + 4327 +Метод запроса: **POST** 4328 + 4329 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4330 + 4331 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4332 + 4333 + 4334 +Ответ: 4335 + 4336 +{ 4337 + 4338 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4339 + 4340 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4341 + 4342 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4343 + 4344 + "Message": "string", ~/~/ Информация о выполнении запроса 4345 + 4346 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4347 + 4348 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4349 + 4350 + "Data": "string" ~/~/ Данные 4351 + 4352 +} 4353 + 4354 + 4280 4280 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4281 4281 4282 4282 (% class="box infomessage" %) ... ... @@ -4294,10 +4294,59 @@ 4294 4294 "message": "string" 4295 4295 } 4296 4296 4297 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4298 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4299 -|progress|Guid ТС 4372 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4373 +**Параметр** 4374 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4375 +**Описание** 4376 +))) 4377 +|((( 4378 +activity 4379 +)))|((( 4380 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4381 +))) 4382 +|((( 4383 +progress 4384 +)))|((( 4385 +Guid ТС 4386 +))) 4300 4300 4388 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4389 + 4390 +(% class="box infomessage" %) 4391 +((( 4392 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4393 +))) 4394 + 4395 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4396 + 4397 +Метод запроса: **GET** 4398 + 4399 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4400 + 4401 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4402 + 4403 + 4404 +Ответ: 4405 + 4406 +{ 4407 + 4408 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4409 + 4410 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4411 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4412 + 4413 + "Message": "string", ~/~/ Информация о выполнении запроса 4414 + 4415 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4416 + 4417 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4418 + 4419 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4420 + 4421 + "Data": "string" ~/~/ Данные 4422 + 4423 +} 4424 + 4301 4301 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4302 4302 4303 4303 (% class="box infomessage" %) ... ... @@ -4809,8 +4809,51 @@ 4809 4809 } 4810 4810 ] 4811 4811 } 4936 + 4937 + 4938 +== **Превышение скорости** == 4939 + 4940 +(% class="box infomessage" %) 4941 +((( 4942 +**POST /api/v3/Reports/overSpeedDuration** 4812 4812 ))) 4813 4813 4945 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4946 + 4947 +Пример запроса: 4948 + 4949 +((( 4950 +{ 4951 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4952 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4953 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4954 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4955 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4956 +} 4957 +))) 4958 + 4959 +((( 4960 + 4961 +))) 4962 + 4963 +((( 4964 +Пример ответа: 4965 +))) 4966 + 4967 +((( 4968 +((( 4969 +[ 4970 + { 4971 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4972 + "duration": 0, ~/~/ Продолжительность события в секундах 4973 + "maxSpeed": 0, ~/~/ Максимальная скорость 4974 + "speedLimit": 0 ~/~/ Ограничение скорости 4975 + } 4976 +] 4977 +))) 4978 +))) 4979 +))) 4980 + 4814 4814 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4815 4815 4816 4816 ... ... @@ -5116,33 +5116,9 @@ 5116 5116 ))) 5117 5117 5118 5118 5119 -== **Удаление существующего поля** == 5120 - 5121 -(% class="box errormessage" %) 5122 5122 ((( 5123 -**DELETE /api/v3/agroLands/{id}** 5124 -))) 5125 - 5126 -Пример запроса: 5127 -id ~/~/ Идентификатор поля 5128 - 5129 -Пример ответа: 5130 - 5131 5131 ((( 5132 -200 ~/~/ Успех 5133 -))) 5134 - 5135 5135 ((( 5136 - 5137 -))) 5138 - 5139 -((( 5140 -((( 5141 -((( 5142 - 5143 -))) 5144 - 5145 -((( 5146 5146 == **Изменение поля** == 5147 5147 5148 5148 (% class="box infomessage" %) ... ... @@ -5388,9 +5388,102 @@ 5388 5388 "perimetr": 0, ~/~/ ериметр, м 5389 5389 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5390 5390 } 5534 + 5535 + 5536 +== **Какие поля посещал объект** == 5537 + 5538 +(% class="box successmessage" %) 5539 +((( 5540 +**POST /api/v3/agroLands/visitingByVehicle** 5391 5391 ))) 5392 5392 5543 +Пример запроса: 5393 5393 5545 +{ 5546 + "vehicleId": 0, ~/~/ id объекта 5547 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5548 + "byTime": 0, ~/~/ Объединение событий по времени 5549 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5550 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5551 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5552 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5553 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5554 +} 5555 + 5556 +Пример ответа: 5557 + 5558 +[ 5559 + { 5560 + "fieldId": 0, ~/~/ id объекта 5561 + "vehicleName": "string", ~/~/ Наименование объекта 5562 + "fieldName": "string", ~/~/ Наименование поля 5563 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5564 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5565 + "vehicleId": 0, ~/~/ Идентификатор ТС 5566 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5567 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5568 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5569 + "mileage": 0 ~/~/ Пробег 5570 + } 5571 +] 5572 +))) 5573 + 5574 + 5575 +== **Посещение поля объектами ** == 5576 + 5577 +(% class="box successmessage" %) 5578 +((( 5579 +**POST /api/v3/agroLands/visitingByField** 5580 +))) 5581 + 5582 +Пример запроса: 5583 +{ 5584 + "fieldId": 0, ~/~/ ID поля 5585 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5586 + "byTime": 0, ~/~/ Объединение событий по времени 5587 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5588 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5589 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5590 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5591 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5592 +} 5593 + 5594 +Пример ответа: 5595 + 5596 +[ 5597 + { 5598 + "fieldId": 0, ~/~/ ID поля 5599 + "vehicleName": "string", ~/~/ Наименование объекта 5600 + "fieldName": "string", ~/~/ Имя поля 5601 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5602 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5603 + "vehicleId": 0, ~/~/ Идентификатор ТС 5604 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5605 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5606 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5607 + "mileage": 0 ~/~/ Пробег 5608 + } 5609 +] 5610 + 5611 + 5612 +== **Удаление существующего поля** == 5613 + 5614 +(% class="box errormessage" %) 5615 +((( 5616 +**DELETE /api/v3/agroLands/{id}** 5617 +))) 5618 + 5619 +Пример запроса: 5620 +id ~/~/ Идентификатор поля 5621 + 5622 +Пример ответа: 5623 + 5624 +((( 5625 +200 ~/~/ Успех 5626 + 5627 + 5628 +))) 5629 + 5394 5394 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5395 5395 ))) 5396 5396 ))) ... ... @@ -5815,49 +5815,129 @@ 5815 5815 ))) 5816 5816 5817 5817 6054 += **Раздел: Роли** = 6055 + 6056 +== **Получение списка клиентских и системных ролей пользователя ** == 6057 + 6058 +(% class="box successmessage" %) 6059 +((( 6060 +**POST /api/v3/groups/find** 6061 +))) 6062 + 6063 +Пример запроса: 6064 + 6065 +((( 6066 +{ 6067 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6068 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6069 +} 6070 +))) 6071 + 6072 +((( 6073 + 6074 +))) 6075 + 6076 +((( 6077 +Пример ответа: 6078 +))) 6079 + 6080 +((( 6081 +((( 6082 +{ 6083 + "groups": [ ~/~/ Системные роли пользователя 6084 + { 6085 + "code": "string", ~/~/ Код роли. 6086 + "name": "string", ~/~/ Имя 6087 + "shortName": "string" ~/~/ Короткое имя 6088 + } 6089 + ], 6090 + "customGroups": [ ~/~/ Системные роли пользователя 6091 + { 6092 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6093 + "name": "string", ~/~/ Наименование 6094 + "shortName": "string", ~/~/ Короткое наименование 6095 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6096 + } 6097 + ] 6098 +} 6099 +))) 6100 +))) 6101 + 6102 +((( 6103 + 6104 +))) 6105 + 6106 +((( 6107 + 6108 +))) 6109 + 5818 5818 = **Раздел: Локатор ** = 5819 5819 5820 5820 5821 -== **Получение списка локаторов,доступных пользователю** ==6113 +== **Получение данных по локатору** == 5822 5822 5823 5823 (% class="box infomessage" %) 5824 5824 ((( 5825 -**GET /api/v3/locators** 6117 +**GET /api/v3/locators/{locatorId}** 5826 5826 ))) 5827 5827 5828 -В за головкахзапроса:X-Auth:Токен авторизации6120 +В запросе указывается locatorid - идентификатор локатора 5829 5829 5830 5830 5831 5831 Пример ответа: 5832 5832 5833 5833 ((( 5834 -[ 5835 - { 5836 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5837 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5838 - "agentName": "string", ~/~/ Наименование агента. 5839 - "isEnabled": true, ~/~/ Активен 5840 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5841 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5842 - "name": "string", ~/~/ Наименование 5843 - "status": 0, ~/~/ 5844 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5845 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5846 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5847 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5848 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5849 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5850 - "url": "string", ~/~/ Ссылка 5851 - "language": 0, ~/~/ Язык. 5852 - "vehiclesCount": 0, ~/~/ Количество объектов. 5853 - "geozonesCount": 0, ~/~/ Количество геозон. 5854 - "fieldsCount": 0 ~/~/ Количество полей. 5855 - } 5856 -] 6126 +((( 6127 +{ 6128 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6129 + 0 6130 + ], 6131 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6132 + 0 6133 + ], 6134 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6135 + 0 6136 + ], 6137 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6138 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6139 + "agentName": "string", ~/~/ Наименование агента. 6140 + "isEnabled": true, ~/~/ Активность 6141 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6142 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6143 + "name": "string", ~/~/ Наименование. 6144 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6145 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6146 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6147 + "validity": 0, ~/~/ Значение срока действия 6148 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6149 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6150 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6151 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6152 + "url": "string", ~/~/ Ссылка 6153 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6154 + 6155 + "showVehicleName": true, ~/~/ Наименование объекта 6156 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6157 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6158 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6159 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6160 + "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ГИС) 6161 + 6162 + 1 6163 + 6164 + ] 6165 +} 5857 5857 ))) 6167 +))) 5858 5858 5859 5859 6170 +((( 6171 +((( 6172 + 6173 +))) 6174 +))) 5860 5860 6176 + 5861 5861 == **Создание локатора** == 5862 5862 5863 5863 (% class="box successmessage" %) ... ... @@ -5869,7 +5869,6 @@ 5869 5869 5870 5870 ((( 5871 5871 { 5872 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5873 5873 "isEnabled": true, ~/~/ Активность 5874 5874 "name": "string", ~/~/ Наименование локатора 5875 5875 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) ... ... @@ -5876,8 +5876,28 @@ 5876 5876 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5877 5877 "validity": 0, ~/~/ Срок действия в днях (1-90) 5878 5878 "autoProlongation": true, ~/~/ Автопродление срока действия. 5879 - "url": "string", ~/~/ Ссылка 5880 - "language": 0 ~/~/ Язык 6194 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6195 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6196 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6197 + 0 6198 + ], 6199 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6200 + 0 6201 + ], 6202 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6203 + 0 6204 + ], 6205 + 6206 + "showVehicleName": true, ~/~/ Наименование объекта 6207 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6208 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6209 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6210 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6211 + "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ГИС) 6212 + 6213 + 1 6214 + 6215 + ] 5881 5881 } 5882 5882 ))) 5883 5883 ... ... @@ -5889,7 +5889,69 @@ 5889 5889 ))) 5890 5890 5891 5891 6227 +== **Выводит список локаторов ** == 5892 5892 6229 +(% class="box successmessage" %) 6230 +((( 6231 +**POST /api/v3/locators/find** 6232 +))) 6233 + 6234 +Пример запроса: 6235 + 6236 +((( 6237 +{ 6238 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6239 +} 6240 +))) 6241 + 6242 +((( 6243 + 6244 +))) 6245 + 6246 +((( 6247 + 6248 +))) 6249 + 6250 + 6251 +Пример ответа: 6252 + 6253 +((( 6254 +[ 6255 + { 6256 + "vehiclesCount": 0, ~/~/ Количество объектов. 6257 + "geozonesCount": 0, ~/~/ Количество геозон. 6258 + "fieldsCount": 0, ~/~/ Количество полей. 6259 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6260 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6261 + "agentName": "string", ~/~/ Наименование агента. 6262 + "isEnabled": true, ~/~/ Активность локатора 6263 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6264 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6265 + "name": "string", ~/~/ Наименование локатора 6266 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6267 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6268 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6269 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6270 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6271 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6272 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6273 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6274 + "url": "string", ~/~/ ссылка на локатор 6275 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6276 + "showVehicleName": true, ~/~/ Наименование объекта 6277 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6278 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6279 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6280 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6281 + "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ГИС) 6282 + 6283 + 0 6284 + ] 6285 + } 6286 +] 6287 +))) 6288 + 6289 + 5893 5893 == **Изменение локатора** == 5894 5894 5895 5895 (% class="box infomessage" %) ... ... @@ -5908,12 +5908,31 @@ 5908 5908 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5909 5909 "validity": 0, ~/~/ Срок действия в днях (1-90) 5910 5910 "autoProlongation": true, ~/~/ Автопродление срока действия 5911 - "url": "string", ~/~/ Ссылка 5912 - "language": 0 ~/~/ Язык 6308 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6309 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6310 + 0 6311 + ], 6312 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6313 + 0 6314 + ], 6315 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6316 + 0 6317 + ], 6318 + "showVehicleName": true, ~/~/ Наименование объекта 6319 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6320 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6321 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6322 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6323 + "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ГИС) 6324 + 6325 + 0 6326 + 6327 + ] 5913 5913 } 6329 + 6330 + 5914 5914 ))) 5915 5915 5916 - 5917 5917 Пример ответа: 5918 5918 5919 5919 200 ~/~/ Success ... ... @@ -5935,8 +5935,201 @@ 5935 5935 ))) 5936 5936 5937 5937 6354 += **Раздел: Яндекс Маршруты** = 5938 5938 5939 5939 6357 +== **Возвращение списка маршрутов** == 6358 + 6359 +(% class="box infomessage" %) 6360 +((( 6361 +**GET /api/v3/TransportRoutes** 6362 +))) 6363 + 6364 +Пример запроса: 6365 +Id ~/~/ Идентификатор поля 6366 + 6367 +Пример ответа: 6368 + 6369 +((( 6370 +[ 6371 + { 6372 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6373 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6374 + "name": "string", ~/~/ Наименование маршрута. 6375 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6376 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6377 + 0 6378 + ] 6379 + } 6380 +] 6381 +))) 6382 + 6383 + 6384 +== **Добавить маршрут** == 6385 + 6386 +(% class="box infomessage" %) 6387 +((( 6388 +**POST /api/v3/TransportRoutes** 6389 +))) 6390 + 6391 +Пример запроса: 6392 +{ 6393 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6394 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6395 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6396 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6397 + 0 6398 + ] 6399 +} 6400 + 6401 + 6402 +Пример ответа: 6403 + 6404 +((( 6405 +{ 6406 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6407 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6408 + "name": "string", ~/~/ Определяет наименование маршрута 6409 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6410 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6411 + 0 6412 + ] 6413 +} 6414 +))) 6415 + 6416 + 6417 +== **Обновление маршрута** == 6418 + 6419 +(% class="box successmessage" %) 6420 +((( 6421 +**PUT /api/v3/TransportRoutes** 6422 +))) 6423 + 6424 +Пример запроса: 6425 + 6426 +((( 6427 +{ 6428 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6429 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6430 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6431 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6432 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6433 + 0 6434 + ] 6435 +} 6436 +))) 6437 + 6438 +Пример ответа: 6439 + 6440 +((( 6441 +{ 6442 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6443 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6444 + "name": "string", ~/~/ Определяет наименование маршрута 6445 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6446 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6447 + 0 6448 + ] 6449 +} 6450 +))) 6451 + 6452 + 6453 +== **Получить связки маршрутов ТС** == 6454 + 6455 +(% class="box infomessage" %) 6456 +((( 6457 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6458 +))) 6459 + 6460 +Пример запроса: 6461 + 6462 +((( 6463 +[ 6464 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6465 +] 6466 +))) 6467 + 6468 +Пример ответа: 6469 + 6470 +((( 6471 +[ 6472 + { 6473 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6474 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6475 + } 6476 +] 6477 +))) 6478 + 6479 + 6480 +== **Удалить маршрут** == 6481 + 6482 +(% class="box warningmessage" %) 6483 +((( 6484 +**DELETE /api/v3/TransportRoutes/{id}** 6485 +))) 6486 + 6487 +Пример запроса: 6488 +Id ~/~/ Идентификатор поля 6489 + 6490 + 6491 += **Раздел: Управление доступа к машинам** = 6492 + 6493 + 6494 +== Получение списка транспортных средств видимых пользователю == 6495 + 6496 +(% class="box infomessage" %) 6497 +((( 6498 +**GET /api/v3/UserVisibleVehicles/{userId}** 6499 +))) 6500 + 6501 +Пример ответа: 6502 + 6503 +((( 6504 +{ 6505 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6506 + 0 6507 + ] 6508 +} 6509 +))) 6510 + 6511 + 6512 +== Задает видимость транспортных средств пользователю == 6513 + 6514 +(% class="box infomessage" %) 6515 +((( 6516 +**POST /api/v3/UserVisibleVehicles** 6517 +))) 6518 + 6519 +Пример запроса: 6520 + 6521 +((( 6522 +((( 6523 +{ 6524 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6525 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6526 + 0 6527 + ] 6528 +} 6529 +))) 6530 + 6531 +((( 6532 + 6533 +))) 6534 + 6535 +((( 6536 +Пример ответа : 6537 +))) 6538 + 6539 +((( 6540 + 6541 +))) 6542 + 6543 +((( 6544 +200 ~/~/ Success 6545 +))) 6546 +))) 6547 + 6548 + 5940 5940 (% class="box" lang="en-US" style="text-align: center;" %) 5941 5941 ((( 5942 5942 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **