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