Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/09/11 10:51
<
>
edited by Андрей Калиновский
on 2025/03/25 13:59
on 2025/03/25 13:59
edited by Андрей Калиновский
on 2025/09/09 14:38
on 2025/09/09 14:38
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,6 +2515,8 @@ 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 ~/~/ Расход топлива в движении 2520 2520 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне ... ... @@ -2644,194 +2644,241 @@ 2644 2644 В заголовках запроса: X-Auth: Токен авторизации 2645 2645 2646 2646 2647 -В теле запроса перечисляетемассив id объектов, вквадратных скобкахчерез запятую.2572 +В массиве указываем id объектов через запятую 2648 2648 2649 2649 Ответ: 2575 + 2576 +[ 2650 2650 { 2651 - "vehicleId": 0, ~/~/Идентификатор объекта.2652 - "vehicleGuid": " 3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификаторобъекта.2653 - "vehicleNumber": " string",~/~/Номер объекта.2654 - "receiveTime": "202 4-02-27T14:11:00.315Z",~/~/Времяполучениязаписи на сервере,т.е. время срабатывания+ время передачи от устройствана сервер2655 - "recordTime": "202 4-02-27T14:11:00.315Z",~/~/Времязаписиотустройства, т.е. время фактическогособытия натранспортном средстве.2656 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.2657 - "speed": 0,~/~/Скорость объекта.2658 - "course": 0,~/~/Курс движения [0;360]2659 - "latitude": 0,~/~/Широта [-90°;90°].2660 - "longitude": 0,~/~/Долгота [-180°;180°]. 2661 - "address": " string",~/~/Адрес.2662 - "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": [ ~/~/ Сведения по геозонам. 2663 2663 { 2664 - "id": 0, 2665 - "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" ~/~/ Наименование геозоны 2666 2666 } 2614 + ] 2615 + } 2667 2667 2668 2668 2669 -= (%style="color:#000000;font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%)=2618 += = 2670 2670 2671 -= =(% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==2620 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2672 2672 2622 +== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2623 + 2673 2673 (% class="box infomessage" %) 2674 2674 ((( 2675 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/find**2626 +**POST /api/v3/notifications/find** 2676 2676 ))) 2677 2677 2678 - (% style="color:#000000" %)Методпозволяетполучитьсписокгеообъектовклиента.Возвращает массивгеообъектовсо всей информациейоних.2629 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2679 2679 2680 -(% style="color:#000000" %)Метод запроса: **POST** 2631 +(% style="text-align: left;" %) 2632 +Метод запроса **POST** 2681 2681 2682 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2634 +(% style="text-align: left;" %) 2635 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2683 2683 2637 +(% style="text-align: left;" %) 2684 2684 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2685 2685 2686 -(% style="text-align:left" %) 2687 -Тело запроса: 2688 - 2689 -(% style="text-align:left" %) 2690 2690 { 2691 - "parentId": " 3fa85f64-5717-4562-b3fc-2c963f66afa6"2641 + "parentId": "" ~/~/ id клиента 2692 2692 } 2693 2693 2694 -(% style="text-align:left" %) 2695 2695 Ответ: 2696 2696 2697 2697 [ 2698 2698 { 2699 - "id": 0, ~/~/ Идентификатор объекта геозоны 2700 - "name": "string", ~/~/ Название объекта геозоны 2701 - "type": 0, ~/~/ Тип объекта геозоны 2702 - "fname": "string", ~/~/ Имя файла 2703 - "parentId": "string", ~/~/ Идентификатор клиента 2704 - "radius": 0, ~/~/ Радиус геообъекта 2705 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2706 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2707 - "description": "string", ~/~/ Описание 2708 - "area": 0, ~/~/ Площадь, м^^2^^ 2709 - "perimetr": 0, ~/~/ Периметр, м 2710 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2648 + "id": 0, ~/~/ ID уведомления 2649 + "name": "string", ~/~/ Название уведомления 2650 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2651 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2652 + "userId": "", ~/~/ Пользователь, создавший уведомление 2653 + "parentId": "", ~/~/ Идентификатор клиента 2654 + "parentName": "string" ~/~/ Имя клиента 2711 2711 } 2712 2712 ] 2713 2713 2714 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2715 2715 2659 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2660 + 2716 2716 (% class="box infomessage" %) 2717 2717 ((( 2718 - (% style="color:#000000; line-height:100%" %)****(% lang="en-US" %)**POST**(%%)**/api/v3/gis/intersections/vehicles**2663 +**POST /api/v3/notifications** 2719 2719 ))) 2720 2720 2721 - (% style="color:#000000" %)Методпозволяетполучить список пересечений выбранныхобъектовсо всеми геообъектамиза выбранный период.2666 +Метод запроса **POST** 2722 2722 2723 -(% style="color:#000000" %)Метод запроса: **POST** 2668 +(% style="text-align: left;" %) 2669 +(% style="color:#000000" %)Пример запроса 2724 2724 2725 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2726 - 2727 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2728 - 2729 -(% style="text-align:left" %) 2730 -Тело запроса: 2731 - 2671 +((( 2732 2732 { 2733 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2734 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2735 - "ids": [ ], ~/~/ Массив id объектов 2736 - "byTime": 0, ~/~/ Объединение событий по времени 2737 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2738 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2739 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2673 + "id": 0, ~/~/ ID правила 2674 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2675 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2676 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2677 + "name": "string", ~/~/ Имя правила 2678 + "active": true, ~/~/ Активность правила 2679 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2680 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2681 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2682 + ], 2683 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2684 + 0 2685 + ], 2686 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2687 + 0 2688 + ], 2689 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2690 + 0 2691 + ], 2692 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2693 + "additionalProp1": "string", 2694 + "additionalProp2": "string", 2695 + "additionalProp3": "string" 2696 + }, 2697 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2698 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2699 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2700 + ], 2701 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2702 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2703 + "string" 2704 + ], 2705 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2706 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2707 + { 2708 + "id": 0, ~/~/ Идентификатор участника чата. 2709 + "info": "string" ~/~/ Дополнительные сведения. 2710 + } 2711 + ], 2712 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2713 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2714 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2715 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2716 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2717 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2718 + "timezone": 0, ~/~/ часовой пояс 2719 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2720 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2721 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2722 + { 2723 + "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 - Срок действия правила истек 2724 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2725 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2726 + "additionalProp1": "string", 2727 + "additionalProp2": "string", 2728 + "additionalProp3": "string" 2729 + } 2730 + } 2731 + ] 2740 2740 } 2733 +))) 2741 2741 2742 -Ответ: 2743 -[ 2744 - { 2745 - "geozoneId": 0, ~/~/ ID геообъекта 2746 - "geozoneName": "string", ~/~/ Название геообъекта 2747 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2748 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2749 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2750 - "vehicleId": 0, ~/~/ ID объекта 2751 - "vehicleName": "string" ~/~/ Имя объекта 2752 - } 2753 -] 2754 - 2755 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2756 - 2757 -(% class="box infomessage" %) 2758 2758 ((( 2759 - (%style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**2736 + 2760 2760 ))) 2761 2761 2762 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2763 - 2764 -(% style="color:#000000" %)Метод запроса: **POST** 2765 - 2766 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2767 - 2768 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2769 - 2770 -(% style="text-align:left" %) 2771 -Тело запроса: 2772 - 2773 -{ 2774 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2775 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2776 - "ids": [ ], ~/~/ Массив id геообъектов 2777 - "byTime": 0, ~/~/ Объединение событий по времени 2778 - "byDist": 0, ~/~/ Объединение событий по расстоянию 2779 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2780 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2781 -} 2782 - 2783 -Ответ: 2784 - 2785 -[ 2786 - { 2787 - "geozoneId": 0, ~/~/ ID геообъекта 2788 - "geozoneName": "string", ~/~/ Название геообъекта 2789 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2790 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2791 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2792 - "vehicleId": 0, ~/~/ ID объекта 2793 - "vehicleName": "string" ~/~/ Имя объекта 2794 - } 2795 -] 2796 - 2797 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2798 - 2799 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2800 - 2801 -(% class="box infomessage" %) 2802 2802 ((( 2803 - **POST/api/v3/notifications/find**2740 + 2804 2804 ))) 2805 2805 2806 - Методвозвращаетинформацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.2743 +Ответ: 2807 2807 2808 -(% style="text-align: left;" %) 2809 -Метод запроса **POST** 2810 - 2811 -(% style="text-align: left;" %) 2812 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2813 - 2814 -(% style="text-align: left;" %) 2815 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2816 - 2817 2817 { 2818 - "parentId": "" ~/~/ id клиента 2746 + "id": 0, ~/~/ ID правила 2747 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2748 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2749 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2750 + "name": "string", ~/~/ Имя правила 2751 + "active": true, ~/~/ Активность правила 2752 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2753 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2754 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2755 + ], 2756 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2757 + 0 2758 + ], 2759 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2760 + 0 2761 + ], 2762 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2763 + 0 2764 + ], 2765 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2766 + "additionalProp1": "string", 2767 + "additionalProp2": "string", 2768 + "additionalProp3": "string" 2769 + }, 2770 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2771 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2772 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2773 + ], 2774 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2775 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2776 + "string" 2777 + ], 2778 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2779 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2780 + { 2781 + "id": 0, ~/~/ Идентификатор участника чата. 2782 + "info": "string" ~/~/ Дополнительные сведения. 2783 + } 2784 + ], 2785 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2786 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2787 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2788 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2789 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2790 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2791 + "timezone": 0, ~/~/ часовой пояс 2792 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2793 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2794 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2795 + { 2796 + "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 - Срок действия правила истек 2797 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2798 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2799 + "additionalProp1": "string", 2800 + "additionalProp2": "string", 2801 + "additionalProp3": "string" 2802 + } 2803 + } 2804 + ] 2819 2819 } 2820 2820 2821 -Ответ: 2822 - 2823 -[ 2824 - { 2825 - "id": 0, ~/~/ ID уведомления 2826 - "name": "string", ~/~/ Название уведомления 2827 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 2828 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2829 - "userId": "", ~/~/ Пользователь, создавший уведомление 2830 - "parentId": "", ~/~/ Идентификатор клиента 2831 - "parentName": "string" ~/~/ Имя клиента 2832 - } 2833 -] 2834 - 2835 2835 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2836 2836 2837 2837 (% class="box infomessage" %) ... ... @@ -4049,16 +4049,12 @@ 4049 4049 Тело запроса: 4050 4050 4051 4051 { 4052 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4053 - "Balance": 0 4024 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4025 + "Balance": 0 ~/~/ Значение баланса. 4054 4054 } 4055 4055 4056 4056 Ответ: Success 4057 4057 4058 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4059 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4060 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4061 - 4062 4062 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4063 4063 4064 4064 (% class="box warningmessage" %) ... ... @@ -4070,16 +4070,29 @@ 4070 4070 4071 4071 Тело запроса: 4072 4072 4041 +((( 4073 4073 { 4074 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4075 - " Balance": 04043 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4044 + "amount": 0 ~/~/ Сумма пополнения баланса 4076 4076 } 4046 +))) 4077 4077 4048 +((( 4049 + 4050 +))) 4051 + 4078 4078 Ответ: Success 4079 4079 4080 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4081 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4082 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4054 +((( 4055 +{ 4056 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4057 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4058 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4059 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4060 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4061 + "Description": "string" ~/~/ Описание корректировки. 4062 +} 4063 +))) 4083 4083 4084 4084 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4085 4085 ... ... @@ -4092,16 +4092,25 @@ 4092 4092 4093 4093 Тело запроса: 4094 4094 4076 +((( 4095 4095 { 4096 - " ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",4097 - " Balance": 04078 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4079 + "amount": 0 ~/~/ Сумма списания с баланса 4098 4098 } 4081 +))) 4099 4099 4100 4100 Ответ: Success 4101 4101 4102 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4103 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4104 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4085 +((( 4086 +{ 4087 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4088 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4089 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4090 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4091 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4092 + "Description": "string" ~/~/ Описание корректировки 4093 +} 4094 +))) 4105 4105 4106 4106 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4107 4107 ... ... @@ -4112,28 +4112,35 @@ 4112 4112 4113 4113 Тело запроса: 4114 4114 4105 +((( 4115 4115 { 4116 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4117 - "CalculationType": 0, 4118 - "PermissibleBalance": 0, 4119 - "DefermentDays": 0, 4120 - "SendUiNotifications": true, 4121 - "SendEmailNotifications": true, 4122 - "IsPrivate": true, 4107 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4108 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4109 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4110 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4111 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4112 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4123 4123 } 4114 +))) 4124 4124 4116 +((( 4117 + 4118 +))) 4119 + 4125 4125 Ответ: Success 4126 4126 4127 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4128 -|ClientId|Идентификатор клиента 4129 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4130 -|PermissibleBalance|Допустимый баланс 4131 -|DefermentDays|((( 4132 -Отсрочка, количество дней 4122 +((( 4123 +{ 4124 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4125 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4126 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4127 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4128 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4129 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4130 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4131 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4132 +} 4133 4133 ))) 4134 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4135 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4136 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4137 4137 4138 4138 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4139 4139 ... ... @@ -4145,35 +4145,68 @@ 4145 4145 Тело запроса: 4146 4146 4147 4147 { 4148 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4149 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4150 - "Features": [ 4145 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4146 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4147 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4151 4151 { 4152 - "Feature": "string", 4153 - "IsEnabled": true, 4154 - "IsFactual": true, 4155 - "Limit": 0, 4156 - "Price": 0, 4157 - "DebitDate": "2023-10-18T13:26:58.987Z", 4158 - "PeriodValue": 0, 4159 - "PeriodType": 0 4149 + "Feature": "string", ~/~/ Код услуги. 4150 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4151 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4152 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4153 + "Price": 0, ~/~/ Цена за единицу. 4154 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4155 + "PeriodValue": 0, ~/~/ Значение периода. 4156 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4160 4160 } 4161 4161 ] 4162 4162 } 4163 4163 4161 + 4164 4164 Ответ: Success 4165 4165 4166 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4167 -|ClientId|Идентификатор клиента 4168 -|PlanId|Идентификатор тарифного плана 4169 -|Feature|Код услуги 4170 -|IsEnabled|Признак, определяющий активирована ли услуга 4171 -|IsFactual|Признак, определяющий расчёт по факту 4172 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4173 -|Price|Цена за единицу. 4174 -|DebitDate|Следующий момент времени списания с баланса за услугу. 4175 -|PeriodValue|Значение периода. 4176 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4164 +((( 4165 +{ 4166 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4167 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4168 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4169 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4170 + "Name": "string", ~/~/ Наименование. 4171 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4172 + "Constraint": { ~/~/ Ограничения по тарифу 4173 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4174 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4175 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4176 + }, 4177 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4178 + { 4179 + "Feature": "string", ~/~/Код услуги. 4180 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4181 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4182 + "Price": 0, ~/~/ Цена за единицу. 4183 + "PeriodValue": 0, ~/~/ Значение периода. 4184 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4185 + } 4186 + ], 4187 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4188 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4189 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4190 + }, 4191 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4192 + { 4193 + "Feature": "string", ~/~/ Код услуги. 4194 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4195 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4196 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4197 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4198 + "Price": 0, ~/~/ Цена за единицу. 4199 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4200 + "PeriodValue": 0, ~/~/ Значение периода. 4201 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4202 + "Quantity": 0 ~/~/ Количество использования услуги. 4203 + } 4204 + ] 4205 +} 4206 +))) 4177 4177 4178 4178 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4179 4179 ... ... @@ -4278,6 +4278,43 @@ 4278 4278 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4279 4279 |msgCount|Кол-во обработанных сообщений всего 4280 4280 4311 +== **Импортировать историю ТС (Асинхронный запрос)** == 4312 + 4313 +(% class="box successmessage" %) 4314 +((( 4315 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4316 +))) 4317 + 4318 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4319 + 4320 +Метод запроса: **POST** 4321 + 4322 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4323 + 4324 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4325 + 4326 + 4327 +Ответ: 4328 + 4329 +{ 4330 + 4331 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4332 + 4333 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4334 + 4335 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4336 + 4337 + "Message": "string", ~/~/ Информация о выполнении запроса 4338 + 4339 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4340 + 4341 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4342 + 4343 + "Data": "string" ~/~/ Данные 4344 + 4345 +} 4346 + 4347 + 4281 4281 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4282 4282 4283 4283 (% class="box infomessage" %) ... ... @@ -4295,10 +4295,59 @@ 4295 4295 "message": "string" 4296 4296 } 4297 4297 4298 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4299 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4300 -|progress|Guid ТС 4365 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4366 +**Параметр** 4367 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4368 +**Описание** 4369 +))) 4370 +|((( 4371 +activity 4372 +)))|((( 4373 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4374 +))) 4375 +|((( 4376 +progress 4377 +)))|((( 4378 +Guid ТС 4379 +))) 4301 4301 4381 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4382 + 4383 +(% class="box infomessage" %) 4384 +((( 4385 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4386 +))) 4387 + 4388 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4389 + 4390 +Метод запроса: **GET** 4391 + 4392 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4393 + 4394 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4395 + 4396 + 4397 +Ответ: 4398 + 4399 +{ 4400 + 4401 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4402 + 4403 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4404 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4405 + 4406 + "Message": "string", ~/~/ Информация о выполнении запроса 4407 + 4408 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4409 + 4410 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4411 + 4412 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4413 + 4414 + "Data": "string" ~/~/ Данные 4415 + 4416 +} 4417 + 4302 4302 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4303 4303 4304 4304 (% class="box infomessage" %) ... ... @@ -4810,8 +4810,51 @@ 4810 4810 } 4811 4811 ] 4812 4812 } 4929 + 4930 + 4931 +== **Превышение скорости** == 4932 + 4933 +(% class="box infomessage" %) 4934 +((( 4935 +**POST /api/v3/Reports/overSpeedDuration** 4813 4813 ))) 4814 4814 4938 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4939 + 4940 +Пример запроса: 4941 + 4942 +((( 4943 +{ 4944 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4945 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4946 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4947 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4948 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4949 +} 4950 +))) 4951 + 4952 +((( 4953 + 4954 +))) 4955 + 4956 +((( 4957 +Пример ответа: 4958 +))) 4959 + 4960 +((( 4961 +((( 4962 +[ 4963 + { 4964 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4965 + "duration": 0, ~/~/ Продолжительность события в секундах 4966 + "maxSpeed": 0, ~/~/ Максимальная скорость 4967 + "speedLimit": 0 ~/~/ Ограничение скорости 4968 + } 4969 +] 4970 +))) 4971 +))) 4972 +))) 4973 + 4815 4815 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4816 4816 4817 4817 ... ... @@ -5117,33 +5117,9 @@ 5117 5117 ))) 5118 5118 5119 5119 5120 -== **Удаление существующего поля** == 5121 - 5122 -(% class="box errormessage" %) 5123 5123 ((( 5124 -**DELETE /api/v3/agroLands/{id}** 5125 -))) 5126 - 5127 -Пример запроса: 5128 -id ~/~/ Идентификатор поля 5129 - 5130 -Пример ответа: 5131 - 5132 5132 ((( 5133 -200 ~/~/ Успех 5134 -))) 5135 - 5136 5136 ((( 5137 - 5138 -))) 5139 - 5140 -((( 5141 -((( 5142 -((( 5143 - 5144 -))) 5145 - 5146 -((( 5147 5147 == **Изменение поля** == 5148 5148 5149 5149 (% class="box infomessage" %) ... ... @@ -5389,9 +5389,102 @@ 5389 5389 "perimetr": 0, ~/~/ ериметр, м 5390 5390 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5391 5391 } 5527 + 5528 + 5529 +== **Какие поля посещал объект** == 5530 + 5531 +(% class="box successmessage" %) 5532 +((( 5533 +**POST /api/v3/agroLands/visitingByVehicle** 5392 5392 ))) 5393 5393 5536 +Пример запроса: 5394 5394 5538 +{ 5539 + "vehicleId": 0, ~/~/ id объекта 5540 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5541 + "byTime": 0, ~/~/ Объединение событий по времени 5542 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5543 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5544 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5545 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5546 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5547 +} 5548 + 5549 +Пример ответа: 5550 + 5551 +[ 5552 + { 5553 + "fieldId": 0, ~/~/ id объекта 5554 + "vehicleName": "string", ~/~/ Наименование объекта 5555 + "fieldName": "string", ~/~/ Наименование поля 5556 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5557 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5558 + "vehicleId": 0, ~/~/ Идентификатор ТС 5559 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5560 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5561 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5562 + "mileage": 0 ~/~/ Пробег 5563 + } 5564 +] 5565 +))) 5566 + 5567 + 5568 +== **Посещение поля объектами ** == 5569 + 5570 +(% class="box successmessage" %) 5571 +((( 5572 +**POST /api/v3/agroLands/visitingByField** 5573 +))) 5574 + 5575 +Пример запроса: 5576 +{ 5577 + "fieldId": 0, ~/~/ ID поля 5578 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5579 + "byTime": 0, ~/~/ Объединение событий по времени 5580 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5581 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5582 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5583 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5584 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5585 +} 5586 + 5587 +Пример ответа: 5588 + 5589 +[ 5590 + { 5591 + "fieldId": 0, ~/~/ ID поля 5592 + "vehicleName": "string", ~/~/ Наименование объекта 5593 + "fieldName": "string", ~/~/ Имя поля 5594 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5595 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5596 + "vehicleId": 0, ~/~/ Идентификатор ТС 5597 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5598 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5599 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5600 + "mileage": 0 ~/~/ Пробег 5601 + } 5602 +] 5603 + 5604 + 5605 +== **Удаление существующего поля** == 5606 + 5607 +(% class="box errormessage" %) 5608 +((( 5609 +**DELETE /api/v3/agroLands/{id}** 5610 +))) 5611 + 5612 +Пример запроса: 5613 +id ~/~/ Идентификатор поля 5614 + 5615 +Пример ответа: 5616 + 5617 +((( 5618 +200 ~/~/ Успех 5619 + 5620 + 5621 +))) 5622 + 5395 5395 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5396 5396 ))) 5397 5397 ))) ... ... @@ -5816,49 +5816,129 @@ 5816 5816 ))) 5817 5817 5818 5818 6047 += **Раздел: Роли** = 6048 + 6049 +== **Получение списка клиентских и системных ролей пользователя ** == 6050 + 6051 +(% class="box successmessage" %) 6052 +((( 6053 +**POST /api/v3/groups/find** 6054 +))) 6055 + 6056 +Пример запроса: 6057 + 6058 +((( 6059 +{ 6060 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6061 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6062 +} 6063 +))) 6064 + 6065 +((( 6066 + 6067 +))) 6068 + 6069 +((( 6070 +Пример ответа: 6071 +))) 6072 + 6073 +((( 6074 +((( 6075 +{ 6076 + "groups": [ ~/~/ Системные роли пользователя 6077 + { 6078 + "code": "string", ~/~/ Код роли. 6079 + "name": "string", ~/~/ Имя 6080 + "shortName": "string" ~/~/ Короткое имя 6081 + } 6082 + ], 6083 + "customGroups": [ ~/~/ Системные роли пользователя 6084 + { 6085 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6086 + "name": "string", ~/~/ Наименование 6087 + "shortName": "string", ~/~/ Короткое наименование 6088 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6089 + } 6090 + ] 6091 +} 6092 +))) 6093 +))) 6094 + 6095 +((( 6096 + 6097 +))) 6098 + 6099 +((( 6100 + 6101 +))) 6102 + 5819 5819 = **Раздел: Локатор ** = 5820 5820 5821 5821 5822 -== **Получение списка локаторов,доступных пользователю** ==6106 +== **Получение данных по локатору** == 5823 5823 5824 5824 (% class="box infomessage" %) 5825 5825 ((( 5826 -**GET /api/v3/locators** 6110 +**GET /api/v3/locators/{locatorId}** 5827 5827 ))) 5828 5828 5829 -В за головкахзапроса:X-Auth:Токен авторизации6113 +В запросе указывается locatorid - идентификатор локатора 5830 5830 5831 5831 5832 5832 Пример ответа: 5833 5833 5834 5834 ((( 5835 -[ 5836 - { 5837 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5838 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5839 - "agentName": "string", ~/~/ Наименование агента. 5840 - "isEnabled": true, ~/~/ Активен 5841 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5842 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5843 - "name": "string", ~/~/ Наименование 5844 - "status": 0, ~/~/ 5845 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5846 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5847 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5848 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5849 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5850 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5851 - "url": "string", ~/~/ Ссылка 5852 - "language": 0, ~/~/ Язык. 5853 - "vehiclesCount": 0, ~/~/ Количество объектов. 5854 - "geozonesCount": 0, ~/~/ Количество геозон. 5855 - "fieldsCount": 0 ~/~/ Количество полей. 5856 - } 5857 -] 6119 +((( 6120 +{ 6121 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6122 + 0 6123 + ], 6124 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6125 + 0 6126 + ], 6127 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6128 + 0 6129 + ], 6130 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6131 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6132 + "agentName": "string", ~/~/ Наименование агента. 6133 + "isEnabled": true, ~/~/ Активность 6134 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6135 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6136 + "name": "string", ~/~/ Наименование. 6137 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6138 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6139 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6140 + "validity": 0, ~/~/ Значение срока действия 6141 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6142 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6143 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6144 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6145 + "url": "string", ~/~/ Ссылка 6146 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6147 + 6148 + "showVehicleName": true, ~/~/ Наименование объекта 6149 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6150 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6151 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6152 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6153 + "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ГИС) 6154 + 6155 + 1 6156 + 6157 + ] 6158 +} 5858 5858 ))) 6160 +))) 5859 5859 5860 5860 6163 +((( 6164 +((( 6165 + 6166 +))) 6167 +))) 5861 5861 6169 + 5862 5862 == **Создание локатора** == 5863 5863 5864 5864 (% class="box successmessage" %) ... ... @@ -5870,7 +5870,6 @@ 5870 5870 5871 5871 ((( 5872 5872 { 5873 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5874 5874 "isEnabled": true, ~/~/ Активность 5875 5875 "name": "string", ~/~/ Наименование локатора 5876 5876 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) ... ... @@ -5877,8 +5877,28 @@ 5877 5877 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5878 5878 "validity": 0, ~/~/ Срок действия в днях (1-90) 5879 5879 "autoProlongation": true, ~/~/ Автопродление срока действия. 5880 - "url": "string", ~/~/ Ссылка 5881 - "language": 0 ~/~/ Язык 6187 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6188 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6189 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6190 + 0 6191 + ], 6192 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6193 + 0 6194 + ], 6195 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6196 + 0 6197 + ], 6198 + 6199 + "showVehicleName": true, ~/~/ Наименование объекта 6200 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6201 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6202 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6203 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6204 + "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ГИС) 6205 + 6206 + 1 6207 + 6208 + ] 5882 5882 } 5883 5883 ))) 5884 5884 ... ... @@ -5890,7 +5890,69 @@ 5890 5890 ))) 5891 5891 5892 5892 6220 +== **Выводит список локаторов ** == 5893 5893 6222 +(% class="box successmessage" %) 6223 +((( 6224 +**POST /api/v3/locators/find** 6225 +))) 6226 + 6227 +Пример запроса: 6228 + 6229 +((( 6230 +{ 6231 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6232 +} 6233 +))) 6234 + 6235 +((( 6236 + 6237 +))) 6238 + 6239 +((( 6240 + 6241 +))) 6242 + 6243 + 6244 +Пример ответа: 6245 + 6246 +((( 6247 +[ 6248 + { 6249 + "vehiclesCount": 0, ~/~/ Количество объектов. 6250 + "geozonesCount": 0, ~/~/ Количество геозон. 6251 + "fieldsCount": 0, ~/~/ Количество полей. 6252 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6253 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6254 + "agentName": "string", ~/~/ Наименование агента. 6255 + "isEnabled": true, ~/~/ Активность локатора 6256 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6257 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6258 + "name": "string", ~/~/ Наименование локатора 6259 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6260 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6261 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6262 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6263 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6264 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6265 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6266 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6267 + "url": "string", ~/~/ ссылка на локатор 6268 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6269 + "showVehicleName": true, ~/~/ Наименование объекта 6270 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6271 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6272 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6273 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6274 + "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ГИС) 6275 + 6276 + 0 6277 + ] 6278 + } 6279 +] 6280 +))) 6281 + 6282 + 5894 5894 == **Изменение локатора** == 5895 5895 5896 5896 (% class="box infomessage" %) ... ... @@ -5909,12 +5909,31 @@ 5909 5909 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5910 5910 "validity": 0, ~/~/ Срок действия в днях (1-90) 5911 5911 "autoProlongation": true, ~/~/ Автопродление срока действия 5912 - "url": "string", ~/~/ Ссылка 5913 - "language": 0 ~/~/ Язык 6301 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6302 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6303 + 0 6304 + ], 6305 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6306 + 0 6307 + ], 6308 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6309 + 0 6310 + ], 6311 + "showVehicleName": true, ~/~/ Наименование объекта 6312 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6313 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6314 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6315 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6316 + "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ГИС) 6317 + 6318 + 0 6319 + 6320 + ] 5914 5914 } 6322 + 6323 + 5915 5915 ))) 5916 5916 5917 - 5918 5918 Пример ответа: 5919 5919 5920 5920 200 ~/~/ Success ... ... @@ -5936,8 +5936,201 @@ 5936 5936 ))) 5937 5937 5938 5938 6347 += **Раздел: Яндекс Маршруты** = 5939 5939 5940 5940 6350 +== **Возвращение списка маршрутов** == 6351 + 6352 +(% class="box infomessage" %) 6353 +((( 6354 +**GET /api/v3/TransportRoutes** 6355 +))) 6356 + 6357 +Пример запроса: 6358 +Id ~/~/ Идентификатор поля 6359 + 6360 +Пример ответа: 6361 + 6362 +((( 6363 +[ 6364 + { 6365 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6366 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6367 + "name": "string", ~/~/ Наименование маршрута. 6368 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6369 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6370 + 0 6371 + ] 6372 + } 6373 +] 6374 +))) 6375 + 6376 + 6377 +== **Добавить маршрут** == 6378 + 6379 +(% class="box infomessage" %) 6380 +((( 6381 +**POST /api/v3/TransportRoutes** 6382 +))) 6383 + 6384 +Пример запроса: 6385 +{ 6386 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6387 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6388 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6389 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6390 + 0 6391 + ] 6392 +} 6393 + 6394 + 6395 +Пример ответа: 6396 + 6397 +((( 6398 +{ 6399 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6400 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6401 + "name": "string", ~/~/ Определяет наименование маршрута 6402 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6403 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6404 + 0 6405 + ] 6406 +} 6407 +))) 6408 + 6409 + 6410 +== **Обновление маршрута** == 6411 + 6412 +(% class="box successmessage" %) 6413 +((( 6414 +**PUT /api/v3/TransportRoutes** 6415 +))) 6416 + 6417 +Пример запроса: 6418 + 6419 +((( 6420 +{ 6421 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6422 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6423 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6424 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6425 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6426 + 0 6427 + ] 6428 +} 6429 +))) 6430 + 6431 +Пример ответа: 6432 + 6433 +((( 6434 +{ 6435 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6436 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6437 + "name": "string", ~/~/ Определяет наименование маршрута 6438 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6439 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6440 + 0 6441 + ] 6442 +} 6443 +))) 6444 + 6445 + 6446 +== **Получить связки маршрутов ТС** == 6447 + 6448 +(% class="box infomessage" %) 6449 +((( 6450 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6451 +))) 6452 + 6453 +Пример запроса: 6454 + 6455 +((( 6456 +[ 6457 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6458 +] 6459 +))) 6460 + 6461 +Пример ответа: 6462 + 6463 +((( 6464 +[ 6465 + { 6466 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6467 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6468 + } 6469 +] 6470 +))) 6471 + 6472 + 6473 +== **Удалить маршрут** == 6474 + 6475 +(% class="box warningmessage" %) 6476 +((( 6477 +**DELETE /api/v3/TransportRoutes/{id}** 6478 +))) 6479 + 6480 +Пример запроса: 6481 +Id ~/~/ Идентификатор поля 6482 + 6483 + 6484 += **Раздел: Управление доступа к машинам** = 6485 + 6486 + 6487 +== Получение списка транспортных средств видимых пользователю == 6488 + 6489 +(% class="box infomessage" %) 6490 +((( 6491 +**GET /api/v3/UserVisibleVehicles/{userId}** 6492 +))) 6493 + 6494 +Пример ответа: 6495 + 6496 +((( 6497 +{ 6498 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6499 + 0 6500 + ] 6501 +} 6502 +))) 6503 + 6504 + 6505 +== Задает видимость транспортных средств пользователю == 6506 + 6507 +(% class="box infomessage" %) 6508 +((( 6509 +**POST /api/v3/UserVisibleVehicles** 6510 +))) 6511 + 6512 +Пример запроса: 6513 + 6514 +((( 6515 +((( 6516 +{ 6517 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6518 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6519 + 0 6520 + ] 6521 +} 6522 +))) 6523 + 6524 +((( 6525 + 6526 +))) 6527 + 6528 +((( 6529 +Пример ответа : 6530 +))) 6531 + 6532 +((( 6533 + 6534 +))) 6535 + 6536 +((( 6537 +200 ~/~/ Success 6538 +))) 6539 +))) 6540 + 6541 + 5941 5941 (% class="box" lang="en-US" style="text-align: center;" %) 5942 5942 ((( 5943 5943 (% 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]] **