Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/09/11 10:51
<
>
edited by Андрей Калиновский
on 2025/03/19 14:01
on 2025/03/19 14:01
edited by Андрей Калиновский
on 2025/09/03 09:05
on 2025/09/03 09:05
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,7 +2562,8 @@ 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 + 2566 2566 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2567 2567 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2568 2568 "valueFuel": 0, ~/~/ Количество ... ... @@ -2641,26 +2641,50 @@ 2641 2641 В заголовках запроса: X-Auth: Токен авторизации 2642 2642 2643 2643 2644 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2572 +В массиве указываем id объектов через запятую 2645 2645 2646 2646 Ответ: 2575 + 2576 +[ 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": [ ~/~/Сведения по геозонам. 2578 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2579 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2580 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2581 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2582 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2583 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2584 + "speed": 31, ~/~/ Скорость объекта 2585 + "course": 116, ~/~/ Курс движения [0;360] 2586 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2587 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2588 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2589 + "geozones": [ ~/~/ Сведения по геозонам. 2660 2660 { 2661 - "id": 0, 2662 - "name": "string" 2591 + "id": 10225647, ~/~/ ID Геозоны 2592 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2593 + }, 2594 + { 2595 + "id": 10282875, ~/~/ ID Геозоны 2596 + "name": "Ё2" ~/~/ Наименование геозоны 2597 + }, 2598 + { 2599 + "id": 10226240, ~/~/ ID Геозоны 2600 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2601 + }, 2602 + { 2603 + "id": 9747869, ~/~/ ID Геозоны 2604 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2605 + }, 2606 + { 2607 + "id": 10221123, ~/~/ ID Геозоны 2608 + "name": "53r" ~/~/ Наименование геозоны 2609 + }, 2610 + { 2611 + "id": 10197638, ~/~/ ID Геозоны 2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2663 2663 } 2614 + ] 2615 + } 2664 2664 2665 2665 2666 2666 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = ... ... @@ -2685,7 +2685,7 @@ 2685 2685 2686 2686 (% style="text-align:left" %) 2687 2687 { 2688 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2640 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента, для которого надо получить данные 2689 2689 } 2690 2690 2691 2691 (% style="text-align:left" %) ... ... @@ -2696,9 +2696,9 @@ 2696 2696 "id": 0, ~/~/ Идентификатор объекта геозоны 2697 2697 "name": "string", ~/~/ Название объекта геозоны 2698 2698 "type": 0, ~/~/ Тип объекта геозоны 2651 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2699 2699 "fname": "string", ~/~/ Имя файла 2700 2700 "parentId": "string", ~/~/ Идентификатор клиента 2701 - "radius": 0, ~/~/ Радиус геообъекта 2702 2702 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2703 2703 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2704 2704 "description": "string", ~/~/ Описание ... ... @@ -2791,6 +2791,40 @@ 2791 2791 } 2792 2792 ] 2793 2793 2746 + 2747 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2748 + 2749 +(% class="box successmessage" %) 2750 +((( 2751 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2752 +))) 2753 + 2754 +(% style="color:#000000" %)Метод запроса: **PUT** 2755 + 2756 +Пример запроса: 2757 + 2758 +((( 2759 +{ 2760 + "id": 0, ~/~/ Идентификатор объекта геозоны 2761 + "name": "string", ~/~/ Наименование объекта геозоны 2762 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2763 + "description": "string", ~/~/ Описание объекта геозоны 2764 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2765 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2766 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2767 + "type": 0, ~/~/ Тип геозоны - линия,полигон 2768 + "radius": 0, ~/~/ Радиус геозоны 2769 + "shape": "string", ~/~/ Координаты геозоны 2770 + "shape_format": "string" ~/~/ Формат xml,json 2771 + 2772 +} 2773 +))) 2774 + 2775 + 2776 +Пример ответа: 2777 + 2778 +200 ~/~/ Success 2779 + 2794 2794 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2795 2795 2796 2796 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2822,7 +2822,7 @@ 2822 2822 "id": 0, ~/~/ ID уведомления 2823 2823 "name": "string", ~/~/ Название уведомления 2824 2824 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2825 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2811 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2826 2826 "userId": "", ~/~/ Пользователь, создавший уведомление 2827 2827 "parentId": "", ~/~/ Идентификатор клиента 2828 2828 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2829,6 +2829,155 @@ 2829 2829 } 2830 2830 ] 2831 2831 2818 + 2819 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2820 + 2821 +(% class="box infomessage" %) 2822 +((( 2823 +**POST /api/v3/notifications** 2824 +))) 2825 + 2826 +Метод запроса **POST** 2827 + 2828 +(% style="text-align: left;" %) 2829 +(% style="color:#000000" %)Пример запроса 2830 + 2831 +((( 2832 +{ 2833 + "id": 0, ~/~/ ID правила 2834 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2835 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2836 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2837 + "name": "string", ~/~/ Имя правила 2838 + "active": true, ~/~/ Активность правила 2839 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2840 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2841 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2842 + ], 2843 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2844 + 0 2845 + ], 2846 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2847 + 0 2848 + ], 2849 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2850 + 0 2851 + ], 2852 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2853 + "additionalProp1": "string", 2854 + "additionalProp2": "string", 2855 + "additionalProp3": "string" 2856 + }, 2857 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2858 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2859 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2860 + ], 2861 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2862 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2863 + "string" 2864 + ], 2865 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2866 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2867 + { 2868 + "id": 0, ~/~/ Идентификатор участника чата. 2869 + "info": "string" ~/~/ Дополнительные сведения. 2870 + } 2871 + ], 2872 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2873 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2874 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2875 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2876 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2877 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2878 + "timezone": 0, ~/~/ часовой пояс 2879 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2880 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2881 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2882 + { 2883 + "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 - Срок действия правила истек 2884 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2885 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2886 + "additionalProp1": "string", 2887 + "additionalProp2": "string", 2888 + "additionalProp3": "string" 2889 + } 2890 + } 2891 + ] 2892 +} 2893 +))) 2894 + 2895 +((( 2896 + 2897 +))) 2898 + 2899 +((( 2900 + 2901 +))) 2902 + 2903 +Ответ: 2904 + 2905 +{ 2906 + "id": 0, ~/~/ ID правила 2907 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2908 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2909 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2910 + "name": "string", ~/~/ Имя правила 2911 + "active": true, ~/~/ Активность правила 2912 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2913 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2914 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2915 + ], 2916 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2917 + 0 2918 + ], 2919 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2920 + 0 2921 + ], 2922 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2923 + 0 2924 + ], 2925 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2926 + "additionalProp1": "string", 2927 + "additionalProp2": "string", 2928 + "additionalProp3": "string" 2929 + }, 2930 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2931 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2932 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2933 + ], 2934 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2935 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2936 + "string" 2937 + ], 2938 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2939 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2940 + { 2941 + "id": 0, ~/~/ Идентификатор участника чата. 2942 + "info": "string" ~/~/ Дополнительные сведения. 2943 + } 2944 + ], 2945 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2946 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2947 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2948 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2949 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2950 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2951 + "timezone": 0, ~/~/ часовой пояс 2952 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2953 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2954 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2955 + { 2956 + "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 - Срок действия правила истек 2957 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2958 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2959 + "additionalProp1": "string", 2960 + "additionalProp2": "string", 2961 + "additionalProp3": "string" 2962 + } 2963 + } 2964 + ] 2965 +} 2966 + 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 4184 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4185 + "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 4201 +((( 4070 4070 { 4071 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4072 - " Balance": 04203 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4204 + "amount": 0 ~/~/ Сумма пополнения баланса 4073 4073 } 4206 +))) 4074 4074 4208 +((( 4209 + 4210 +))) 4211 + 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" %)Значение баланса 4214 +((( 4215 +{ 4216 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4217 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4218 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4219 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4220 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4221 + "Description": "string" ~/~/ Описание корректировки. 4222 +} 4223 +))) 4080 4080 4081 4081 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4082 4082 ... ... @@ -4089,16 +4089,25 @@ 4089 4089 4090 4090 Тело запроса: 4091 4091 4236 +((( 4092 4092 { 4093 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4094 - " Balance": 04238 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4239 + "amount": 0 ~/~/ Сумма списания с баланса 4095 4095 } 4241 +))) 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" %)Значение баланса 4245 +((( 4246 +{ 4247 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4248 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4249 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4250 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4251 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4252 + "Description": "string" ~/~/ Описание корректировки 4253 +} 4254 +))) 4102 4102 4103 4103 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4104 4104 ... ... @@ -4109,28 +4109,35 @@ 4109 4109 4110 4110 Тело запроса: 4111 4111 4265 +((( 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, 4267 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4268 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4269 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4270 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4271 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4272 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4120 4120 } 4274 +))) 4121 4121 4276 +((( 4277 + 4278 +))) 4279 + 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 -Отсрочка, количество дней 4282 +((( 4283 +{ 4284 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4285 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4286 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4287 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4288 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4289 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4290 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4291 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4292 +} 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": [ 4305 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4306 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4307 + "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 4309 + "Feature": "string", ~/~/ Код услуги. 4310 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4311 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4312 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4313 + "Price": 0, ~/~/ Цена за единицу. 4314 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4315 + "PeriodValue": 0, ~/~/ Значение периода. 4316 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4157 4157 } 4158 4158 ] 4159 4159 } 4160 4160 4321 + 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 - Месяцы 4324 +((( 4325 +{ 4326 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4327 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4328 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4329 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4330 + "Name": "string", ~/~/ Наименование. 4331 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4332 + "Constraint": { ~/~/ Ограничения по тарифу 4333 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4334 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4335 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4336 + }, 4337 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4338 + { 4339 + "Feature": "string", ~/~/Код услуги. 4340 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4341 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4342 + "Price": 0, ~/~/ Цена за единицу. 4343 + "PeriodValue": 0, ~/~/ Значение периода. 4344 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4345 + } 4346 + ], 4347 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4348 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4349 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4350 + }, 4351 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4352 + { 4353 + "Feature": "string", ~/~/ Код услуги. 4354 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4355 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4356 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4357 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4358 + "Price": 0, ~/~/ Цена за единицу. 4359 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4360 + "PeriodValue": 0, ~/~/ Значение периода. 4361 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4362 + "Quantity": 0 ~/~/ Количество использования услуги. 4363 + } 4364 + ] 4365 +} 4366 +))) 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 4471 +== **Импортировать историю ТС (Асинхронный запрос)** == 4472 + 4473 +(% class="box successmessage" %) 4474 +((( 4475 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4476 +))) 4477 + 4478 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4479 + 4480 +Метод запроса: **POST** 4481 + 4482 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4483 + 4484 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4485 + 4486 + 4487 +Ответ: 4488 + 4489 +{ 4490 + 4491 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4492 + 4493 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4494 + 4495 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4496 + 4497 + "Message": "string", ~/~/ Информация о выполнении запроса 4498 + 4499 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4500 + 4501 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4502 + 4503 + "Data": "string" ~/~/ Данные 4504 + 4505 +} 4506 + 4507 + 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 ТС 4525 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4526 +**Параметр** 4527 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4528 +**Описание** 4529 +))) 4530 +|((( 4531 +activity 4532 +)))|((( 4533 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4534 +))) 4535 +|((( 4536 +progress 4537 +)))|((( 4538 +Guid ТС 4539 +))) 4298 4298 4541 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4542 + 4543 +(% class="box infomessage" %) 4544 +((( 4545 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4546 +))) 4547 + 4548 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4549 + 4550 +Метод запроса: **GET** 4551 + 4552 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4553 + 4554 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4555 + 4556 + 4557 +Ответ: 4558 + 4559 +{ 4560 + 4561 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4562 + 4563 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4564 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4565 + 4566 + "Message": "string", ~/~/ Информация о выполнении запроса 4567 + 4568 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4569 + 4570 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4571 + 4572 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4573 + 4574 + "Data": "string" ~/~/ Данные 4575 + 4576 +} 4577 + 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 } 5089 + 5090 + 5091 +== **Превышение скорости** == 5092 + 5093 +(% class="box infomessage" %) 5094 +((( 5095 +**POST /api/v3/Reports/overSpeedDuration** 4810 4810 ))) 4811 4811 5098 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5099 + 5100 +Пример запроса: 5101 + 5102 +((( 5103 +{ 5104 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5105 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5106 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5107 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5108 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5109 +} 5110 +))) 5111 + 5112 +((( 5113 + 5114 +))) 5115 + 5116 +((( 5117 +Пример ответа: 5118 +))) 5119 + 5120 +((( 5121 +((( 5122 +[ 5123 + { 5124 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5125 + "duration": 0, ~/~/ Продолжительность события в секундах 5126 + "maxSpeed": 0, ~/~/ Максимальная скорость 5127 + "speedLimit": 0 ~/~/ Ограничение скорости 5128 + } 5129 +] 5130 +))) 5131 +))) 5132 +))) 5133 + 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 } 5687 + 5688 + 5689 +== **Какие поля посещал объект** == 5690 + 5691 +(% class="box successmessage" %) 5692 +((( 5693 +**POST /api/v3/agroLands/visitingByVehicle** 5389 5389 ))) 5390 5390 5696 +Пример запроса: 5391 5391 5698 +{ 5699 + "vehicleId": 0, ~/~/ id объекта 5700 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5701 + "byTime": 0, ~/~/ Объединение событий по времени 5702 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5703 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5704 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5705 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5706 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5707 +} 5708 + 5709 +Пример ответа: 5710 + 5711 +[ 5712 + { 5713 + "fieldId": 0, ~/~/ id объекта 5714 + "vehicleName": "string", ~/~/ Наименование объекта 5715 + "fieldName": "string", ~/~/ Наименование поля 5716 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5717 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5718 + "vehicleId": 0, ~/~/ Идентификатор ТС 5719 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5720 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5721 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5722 + "mileage": 0 ~/~/ Пробег 5723 + } 5724 +] 5725 +))) 5726 + 5727 + 5728 +== **Посещение поля объектами ** == 5729 + 5730 +(% class="box successmessage" %) 5731 +((( 5732 +**POST /api/v3/agroLands/visitingByField** 5733 +))) 5734 + 5735 +Пример запроса: 5736 +{ 5737 + "fieldId": 0, ~/~/ ID поля 5738 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5739 + "byTime": 0, ~/~/ Объединение событий по времени 5740 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5741 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5742 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5743 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5744 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5745 +} 5746 + 5747 +Пример ответа: 5748 + 5749 +[ 5750 + { 5751 + "fieldId": 0, ~/~/ ID поля 5752 + "vehicleName": "string", ~/~/ Наименование объекта 5753 + "fieldName": "string", ~/~/ Имя поля 5754 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5755 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5756 + "vehicleId": 0, ~/~/ Идентификатор ТС 5757 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5758 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5759 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5760 + "mileage": 0 ~/~/ Пробег 5761 + } 5762 +] 5763 + 5764 + 5765 +== **Удаление существующего поля** == 5766 + 5767 +(% class="box errormessage" %) 5768 +((( 5769 +**DELETE /api/v3/agroLands/{id}** 5770 +))) 5771 + 5772 +Пример запроса: 5773 +id ~/~/ Идентификатор поля 5774 + 5775 +Пример ответа: 5776 + 5777 +((( 5778 +200 ~/~/ Успех 5779 + 5780 + 5781 +))) 5782 + 5392 5392 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5393 5393 ))) 5394 5394 ))) ... ... @@ -5813,49 +5813,129 @@ 5813 5813 ))) 5814 5814 5815 5815 6207 += **Раздел: Роли** = 6208 + 6209 +== **Получение списка клиентских и системных ролей пользователя ** == 6210 + 6211 +(% class="box successmessage" %) 6212 +((( 6213 +**POST /api/v3/groups/find** 6214 +))) 6215 + 6216 +Пример запроса: 6217 + 6218 +((( 6219 +{ 6220 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6221 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6222 +} 6223 +))) 6224 + 6225 +((( 6226 + 6227 +))) 6228 + 6229 +((( 6230 +Пример ответа: 6231 +))) 6232 + 6233 +((( 6234 +((( 6235 +{ 6236 + "groups": [ ~/~/ Системные роли пользователя 6237 + { 6238 + "code": "string", ~/~/ Код роли. 6239 + "name": "string", ~/~/ Имя 6240 + "shortName": "string" ~/~/ Короткое имя 6241 + } 6242 + ], 6243 + "customGroups": [ ~/~/ Системные роли пользователя 6244 + { 6245 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6246 + "name": "string", ~/~/ Наименование 6247 + "shortName": "string", ~/~/ Короткое наименование 6248 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6249 + } 6250 + ] 6251 +} 6252 +))) 6253 +))) 6254 + 6255 +((( 6256 + 6257 +))) 6258 + 6259 +((( 6260 + 6261 +))) 6262 + 5816 5816 = **Раздел: Локатор ** = 5817 5817 5818 5818 5819 -== **Получение списка локаторов,доступных пользователю** ==6266 +== **Получение данных по локатору** == 5820 5820 5821 5821 (% class="box infomessage" %) 5822 5822 ((( 5823 -**GET /api/v3/locators** 6270 +**GET /api/v3/locators/{locatorId}** 5824 5824 ))) 5825 5825 5826 -В за головкахзапроса:X-Auth:Токен авторизации6273 +В запросе указывается 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 -] 6279 +((( 6280 +{ 6281 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6282 + 0 6283 + ], 6284 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6285 + 0 6286 + ], 6287 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6288 + 0 6289 + ], 6290 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6291 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6292 + "agentName": "string", ~/~/ Наименование агента. 6293 + "isEnabled": true, ~/~/ Активность 6294 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6295 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6296 + "name": "string", ~/~/ Наименование. 6297 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6298 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6299 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6300 + "validity": 0, ~/~/ Значение срока действия 6301 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6302 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6303 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6304 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6305 + "url": "string", ~/~/ Ссылка 6306 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6307 + 6308 + "showVehicleName": true, ~/~/ Наименование объекта 6309 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6310 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6311 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6312 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6313 + "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ГИС) 6314 + 6315 + 1 6316 + 6317 + ] 6318 +} 5855 5855 ))) 6320 +))) 5856 5856 5857 5857 6323 +((( 6324 +((( 6325 + 6326 +))) 6327 +))) 5858 5858 6329 + 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 ~/~/ Язык 6347 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6348 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6349 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6350 + 0 6351 + ], 6352 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6353 + 0 6354 + ], 6355 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6356 + 0 6357 + ], 6358 + 6359 + "showVehicleName": true, ~/~/ Наименование объекта 6360 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6361 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6362 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6363 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6364 + "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ГИС) 6365 + 6366 + 1 6367 + 6368 + ] 5879 5879 } 5880 5880 ))) 5881 5881 ... ... @@ -5887,7 +5887,69 @@ 5887 5887 ))) 5888 5888 5889 5889 6380 +== **Выводит список локаторов ** == 5890 5890 6382 +(% class="box successmessage" %) 6383 +((( 6384 +**POST /api/v3/locators/find** 6385 +))) 6386 + 6387 +Пример запроса: 6388 + 6389 +((( 6390 +{ 6391 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6392 +} 6393 +))) 6394 + 6395 +((( 6396 + 6397 +))) 6398 + 6399 +((( 6400 + 6401 +))) 6402 + 6403 + 6404 +Пример ответа: 6405 + 6406 +((( 6407 +[ 6408 + { 6409 + "vehiclesCount": 0, ~/~/ Количество объектов. 6410 + "geozonesCount": 0, ~/~/ Количество геозон. 6411 + "fieldsCount": 0, ~/~/ Количество полей. 6412 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6413 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6414 + "agentName": "string", ~/~/ Наименование агента. 6415 + "isEnabled": true, ~/~/ Активность локатора 6416 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6417 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6418 + "name": "string", ~/~/ Наименование локатора 6419 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6420 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6421 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6422 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6423 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6424 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6425 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6426 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6427 + "url": "string", ~/~/ ссылка на локатор 6428 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6429 + "showVehicleName": true, ~/~/ Наименование объекта 6430 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6431 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6432 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6433 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6434 + "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ГИС) 6435 + 6436 + 0 6437 + ] 6438 + } 6439 +] 6440 +))) 6441 + 6442 + 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 ~/~/ Язык 6461 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6462 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6463 + 0 6464 + ], 6465 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6466 + 0 6467 + ], 6468 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6469 + 0 6470 + ], 6471 + "showVehicleName": true, ~/~/ Наименование объекта 6472 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6473 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6474 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6475 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6476 + "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ГИС) 6477 + 6478 + 0 6479 + 6480 + ] 5911 5911 } 6482 + 6483 + 5912 5912 ))) 5913 5913 5914 - 5915 5915 Пример ответа: 5916 5916 5917 5917 200 ~/~/ Success ... ... @@ -5933,8 +5933,201 @@ 5933 5933 ))) 5934 5934 5935 5935 6507 += **Раздел: Яндекс Маршруты** = 5936 5936 5937 5937 6510 +== **Возвращение списка маршрутов** == 6511 + 6512 +(% class="box infomessage" %) 6513 +((( 6514 +**GET /api/v3/TransportRoutes** 6515 +))) 6516 + 6517 +Пример запроса: 6518 +Id ~/~/ Идентификатор поля 6519 + 6520 +Пример ответа: 6521 + 6522 +((( 6523 +[ 6524 + { 6525 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6526 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6527 + "name": "string", ~/~/ Наименование маршрута. 6528 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6529 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6530 + 0 6531 + ] 6532 + } 6533 +] 6534 +))) 6535 + 6536 + 6537 +== **Добавить маршрут** == 6538 + 6539 +(% class="box infomessage" %) 6540 +((( 6541 +**POST /api/v3/TransportRoutes** 6542 +))) 6543 + 6544 +Пример запроса: 6545 +{ 6546 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6547 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6548 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6549 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6550 + 0 6551 + ] 6552 +} 6553 + 6554 + 6555 +Пример ответа: 6556 + 6557 +((( 6558 +{ 6559 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6560 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6561 + "name": "string", ~/~/ Определяет наименование маршрута 6562 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6563 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6564 + 0 6565 + ] 6566 +} 6567 +))) 6568 + 6569 + 6570 +== **Обновление маршрута** == 6571 + 6572 +(% class="box successmessage" %) 6573 +((( 6574 +**PUT /api/v3/TransportRoutes** 6575 +))) 6576 + 6577 +Пример запроса: 6578 + 6579 +((( 6580 +{ 6581 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6582 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6583 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6584 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6585 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6586 + 0 6587 + ] 6588 +} 6589 +))) 6590 + 6591 +Пример ответа: 6592 + 6593 +((( 6594 +{ 6595 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6596 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6597 + "name": "string", ~/~/ Определяет наименование маршрута 6598 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6599 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6600 + 0 6601 + ] 6602 +} 6603 +))) 6604 + 6605 + 6606 +== **Получить связки маршрутов ТС** == 6607 + 6608 +(% class="box infomessage" %) 6609 +((( 6610 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6611 +))) 6612 + 6613 +Пример запроса: 6614 + 6615 +((( 6616 +[ 6617 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6618 +] 6619 +))) 6620 + 6621 +Пример ответа: 6622 + 6623 +((( 6624 +[ 6625 + { 6626 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6627 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6628 + } 6629 +] 6630 +))) 6631 + 6632 + 6633 +== **Удалить маршрут** == 6634 + 6635 +(% class="box warningmessage" %) 6636 +((( 6637 +**DELETE /api/v3/TransportRoutes/{id}** 6638 +))) 6639 + 6640 +Пример запроса: 6641 +Id ~/~/ Идентификатор поля 6642 + 6643 + 6644 += **Раздел: Управление доступа к машинам** = 6645 + 6646 + 6647 +== Получение списка транспортных средств видимых пользователю == 6648 + 6649 +(% class="box infomessage" %) 6650 +((( 6651 +**GET /api/v3/UserVisibleVehicles/{userId}** 6652 +))) 6653 + 6654 +Пример ответа: 6655 + 6656 +((( 6657 +{ 6658 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6659 + 0 6660 + ] 6661 +} 6662 +))) 6663 + 6664 + 6665 +== Задает видимость транспортных средств пользователю == 6666 + 6667 +(% class="box infomessage" %) 6668 +((( 6669 +**POST /api/v3/UserVisibleVehicles** 6670 +))) 6671 + 6672 +Пример запроса: 6673 + 6674 +((( 6675 +((( 6676 +{ 6677 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6678 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6679 + 0 6680 + ] 6681 +} 6682 +))) 6683 + 6684 +((( 6685 + 6686 +))) 6687 + 6688 +((( 6689 +Пример ответа : 6690 +))) 6691 + 6692 +((( 6693 + 6694 +))) 6695 + 6696 +((( 6697 +200 ~/~/ Success 6698 +))) 6699 +))) 6700 + 6701 + 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]] **