Изменения документа Методы API для работы с ГЛОНАССSoft
Редактировал(а) Михаил Жучков 2025/10/30 11:26
<
отредактировано Михаил Жучков
на 2025/10/30 11:26
на 2025/10/30 11:26
отредактировано Андрей Калиновский
на 2025/03/25 13:59
на 2025/03/25 13:59
Изменить комментарий:
К данной версии нет комментариев
Комментарий
Подробности
- Свойства страницы
-
- Автор документа
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. SupportZhuchkov1 +XWiki.Gadmin - Содержимое
-
... ... @@ -123,41 +123,29 @@ 123 123 Запрос должен содержать данные параметра "**agentId**" 124 124 125 125 (% style="color:#000000" %)Ответ: 126 - 127 -((( 128 128 { 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 -))) 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 + } 159 159 160 - 161 161 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 162 162 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 163 163 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -202,7 +202,7 @@ 202 202 (% style="color:#000000" %)Параметр запроса: 203 203 204 204 (% style="color:#000000" %){ 205 - "parentId": " (%%)string(% style="color:#000000" %)" ~/~/ для получение собственного parentId отправьте пустой запрос (пример "parentId": "" )193 + "parentId": "string" 206 206 } 207 207 208 208 (% style="color:#000000" %)Ответ: ... ... @@ -287,6 +287,28 @@ 287 287 "bankKS": "string" ~/~/ корр. счёт 288 288 } 289 289 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 + 290 290 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 291 291 292 292 (% class="box warningmessage" %) ... ... @@ -432,7 +432,7 @@ 432 432 [ 433 433 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 434 434 ], 435 - "language": 1~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский445 + "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 436 436 } 437 437 { 438 438 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -744,11 +744,6 @@ 744 744 (% style="text-align:left" %) 745 745 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 746 746 747 -(% class="wikigeneratedid" id="H" %) 748 -((( 749 - 750 -))) 751 - 752 752 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 753 753 754 754 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == ... ... @@ -860,7 +860,7 @@ 860 860 { 861 861 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 862 862 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 863 - "deleted": false,868 + "deleted": true, 864 864 "extId": "string", 865 865 "name": "string", 866 866 "picture": "string", ... ... @@ -879,7 +879,7 @@ 879 879 { 880 880 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 881 881 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 882 - "deleted": false,887 + "deleted": true, 883 883 "extId": "string", 884 884 "name": "string", 885 885 "picture": "string", ... ... @@ -913,7 +913,7 @@ 913 913 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 914 914 ))) 915 915 916 -(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.921 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 917 917 918 918 (% style="color:#000000" %)Метод запроса: **PUT** 919 919 ... ... @@ -980,7 +980,7 @@ 980 980 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 981 981 ))) 982 982 983 -(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалитьмодель, указанного в строке запроса.988 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 984 984 985 985 (% style="color:#000000" %)Метод запроса: **DELETE** 986 986 ... ... @@ -1057,12 +1057,6 @@ 1057 1057 "forTooltip": true, ~/~/ Отображать в подсказке 1058 1058 "forReport": true ~/~/ Отображать в отчете 1059 1059 } 1060 - ], 1061 - "vehicleGroups": [ ~/~/ Группы ТС 1062 - { 1063 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1064 - "name": "string" ~/~/ Наименование группы ТС 1065 - } 1066 1066 1067 1067 ], ~/~/ Данные с вкладки нормы 1068 1068 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) ... ... @@ -1113,7 +1113,7 @@ 1113 1113 "type": 0, ~/~/ Тип датчика 1114 1114 "name": "string", ~/~/ Имя датчика 1115 1115 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1116 - "p arameterName":"string", ~/~/Имяпараметра(взамен связки Input type + port number)1115 + "inputNumber": 0, ~/~/ Номер входа 1117 1117 "pseudonym": "string", ~/~/ Псевдоним 1118 1118 "medianDegree": 0, ~/~/ Медианная фильтрация 1119 1119 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. ... ... @@ -1146,31 +1146,27 @@ 1146 1146 "additionalProp3": "string" 1147 1147 }, 1148 1148 1149 - "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1150 - "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1151 - { 1152 - "from": 0, ~/~/ С какого значения 1153 - "color": "string", ~/~/ Каким цветом 1154 - "text": "string" ~/~/ Текст подписи к этому интервалу 1155 - } 1156 - ], 1157 - "disableEmissionsValidation": true, ~/~/ Нужно ли валидировать выбросы значений. Применяется для датчиков с типом "Накопительный" 1158 - "unitOfMeasure": 0 ~/~/ Единица измерения значений датчика. (0 - по умолчанию, 1 - секунды, 2 - часы) 1159 - } 1160 - ], 1148 +~/~/ Характерные для произвольного: 1149 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1150 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1151 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1152 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1153 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1154 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1155 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1156 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1157 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1158 +~/~/ "ValueOn": "Вкл.", 1159 +~/~/ "ValueOff": "Выкл." 1160 + "summaryMaxValue": 0 ~/~/ Макс. значение 1161 + } 1161 1161 "drivers": [ ~/~/ Водители 1162 1162 { 1163 1163 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1164 1164 "name": "string", ~/~/ Наименование 1165 - "description": "string", ~/~/ Описание 1166 - "assignments": [ ~/~/ Информация по назначениям 1167 - { 1168 - "beginTime": "2025-10-21T12:28:41.021Z", ~/~/Момент времени начала назначения. 1169 - "endTime": "2025-10-21T12:28:41.021Z", ~/~/ Момент времени окончания назначения. 1170 - "createTime": "2025-10-21T12:28:41.021Z" ~/~/ Момент времени создания назначения. 1166 + "description": "string", 1167 + "isDefault": true ~/~/ По умолчанию 1171 1171 } 1172 - ] 1173 - } 1174 1174 ], 1175 1175 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1176 1176 { ... ... @@ -1621,6 +1621,77 @@ 1621 1621 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1622 1622 1623 1623 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 + 1624 1624 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1625 1625 1626 1626 (% class="box infomessage" %) ... ... @@ -1766,6 +1766,7 @@ 1766 1766 "stage": "", ~/~/ Состояние 1767 1767 (% style="color:#000000" %) } 1768 1768 1835 +== == 1769 1769 1770 1770 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1771 1771 ... ... @@ -2382,7 +2382,7 @@ 2382 2382 Тело запроса: 2383 2383 2384 2384 { 2385 - "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.2452 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2386 2386 "vehicleIds": [0], ~/~/ Список ID объектов 2387 2387 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2388 2388 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2412,7 +2412,7 @@ 2412 2412 } 2413 2413 ] 2414 2414 2415 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе т оплива транспортнымсредством**(%%) ==2482 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2416 2416 2417 2417 (% class="box infomessage" %) 2418 2418 ((( ... ... @@ -2429,8 +2429,7 @@ 2429 2429 Тело запроса: 2430 2430 2431 2431 { 2432 - 2433 - "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2499 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2434 2434 "vehicleIds": [0], ~/~/ Список ID объектов 2435 2435 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2436 2436 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -2449,8 +2449,6 @@ 2449 2449 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2450 2450 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2451 2451 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2452 - "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2453 - "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2454 2454 "fuelConsumption": 0, ~/~/ Расход топлива 2455 2455 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2456 2456 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне ... ... @@ -2463,6 +2463,7 @@ 2463 2463 (% class="box warningmessage" %) 2464 2464 ((( 2465 2465 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2530 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2466 2466 ))) 2467 2467 2468 2468 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == ... ... @@ -2501,19 +2501,11 @@ 2501 2501 { 2502 2502 "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 2503 2503 2504 -((( 2505 2505 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2506 2506 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2507 2507 "valueFuel": 0, ~/~/ Количество 2508 2508 "fuelStart": 0, ~/~/ Уровень топлива на начало события 2509 2509 "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2510 -))) 2511 - 2512 -((( 2513 - "latitude": 0, ~/~/ Широта. 2514 - "longitude": 0 ~/~/ Долгота. 2515 -))) 2516 - 2517 2517 } 2518 2518 ] 2519 2519 } ... ... @@ -2587,241 +2587,194 @@ 2587 2587 В заголовках запроса: X-Auth: Токен авторизации 2588 2588 2589 2589 2590 -В массивеуказываемid объектов через запятую2647 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2591 2591 2592 2592 Ответ: 2593 - 2594 -[ 2595 2595 { 2596 - "vehicleId": 55728, ~/~/Идентификатор объекта2597 - "vehicleGuid": "fa 9c0357-9b9f-44b9-a89c-20a2cb80a9ad",~/~/Guidобъекта2598 - "vehicleNumber": " 0105 КМ",~/~/Номер объекта2599 - "receiveTime": "202 5-06-27T12:37:46.7782735Z",~/~/Время идатапоступления данных2600 - "recordTime": "202 5-06-27T12:37:19Z",~/~/Время идатаформированиеданных2601 - "state": 4,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.2602 - "speed": 31,~/~/Скорость объекта2603 - "course": 116,~/~/Курс движения [0;360]2604 - "latitude": 45.722128,~/~/Широта [-90°;90°].2605 - "longitude": 39.800432,~/~/Долгота [-180°;180°].2606 - "address": " \"Краснодарский край Россия 45,722128°, 39,800432°\"",~/~/Адрес2607 - "geozones": [ ~/~/ Сведения по геозонам.2651 + "vehicleId": 0, ~/~/Идентификатор объекта. 2652 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2653 + "vehicleNumber": "string",~/~/Номер объекта. 2654 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2655 + "recordTime": "2024-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": [ ~/~/Сведения по геозонам. 2608 2608 { 2609 - "id": 10225647, ~/~/ ID Геозоны 2610 - "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2611 - }, 2612 - { 2613 - "id": 10282875, ~/~/ ID Геозоны 2614 - "name": "Ё2" ~/~/ Наименование геозоны 2615 - }, 2616 - { 2617 - "id": 10226240, ~/~/ ID Геозоны 2618 - "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2619 - }, 2620 - { 2621 - "id": 9747869, ~/~/ ID Геозоны 2622 - "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2623 - }, 2624 - { 2625 - "id": 10221123, ~/~/ ID Геозоны 2626 - "name": "53r" ~/~/ Наименование геозоны 2627 - }, 2628 - { 2629 - "id": 10197638, ~/~/ ID Геозоны 2630 - "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2664 + "id": 0, 2665 + "name": "string" 2631 2631 } 2632 - ] 2633 - } 2634 2634 2635 2635 2636 -= = 2669 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2637 2637 2638 -= (% style="color:#000000; font-size:1 8.6667px" %)Раздел:**Уведомления**(%%) =2671 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2639 2639 2640 -== (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 2641 - 2642 2642 (% class="box infomessage" %) 2643 2643 ((( 2644 -**POST /api/v3/ notifications/find**2675 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2645 2645 ))) 2646 2646 2647 -Метод возвращаетинформациюобуведомлениях переданногоклиента иегоклиентов нижепо иерархии.2678 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2648 2648 2649 -(% style="text-align: left;" %) 2650 -Метод запроса **POST** 2680 +(% style="color:#000000" %)Метод запроса: **POST** 2651 2651 2652 -(% style="text-align: left;" %) 2653 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find 2682 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2654 2654 2655 -(% style="text-align: left;" %) 2656 2656 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2657 2657 2686 +(% style="text-align:left" %) 2687 +Тело запроса: 2688 + 2689 +(% style="text-align:left" %) 2658 2658 { 2659 - "parentId": "" ~/~/ id клиента2691 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2660 2660 } 2661 2661 2694 +(% style="text-align:left" %) 2662 2662 Ответ: 2663 2663 2664 2664 [ 2665 2665 { 2666 - "id": 0, ~/~/ ID уведомления 2667 - "name": "string", ~/~/ Название уведомления 2668 - "active": true, ~/~/ Состояние true - активен, false - деактивирован 2669 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2670 - "userId": "", ~/~/ Пользователь, создавший уведомление 2671 - "parentId": "", ~/~/ Идентификатор клиента 2672 - "parentName": "string" ~/~/ Имя клиента 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", ~/~/ Дата создания 2673 2673 } 2674 2674 ] 2675 2675 2714 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2676 2676 2677 -== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2678 - 2679 2679 (% class="box infomessage" %) 2680 2680 ((( 2681 -**POST /api/v3/ notifications**2718 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2682 2682 ))) 2683 2683 2684 -Метод з апроса**POST**2721 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2685 2685 2686 -(% style="text-align: left;" %) 2687 -(% style="color:#000000" %)Пример запроса 2723 +(% style="color:#000000" %)Метод запроса: **POST** 2688 2688 2689 -((( 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 + 2690 2690 { 2691 - "id": 0, ~/~/ ID правила 2692 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2693 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2694 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2695 - "name": "string", ~/~/ Имя правила 2696 - "active": true, ~/~/ Активность правила 2697 - "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2698 - "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2699 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2700 - ], 2701 - "vehicleIds": [ ~/~/ Список объектов для анализа. 2702 - 0 2703 - ], 2704 - "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2705 - 0 2706 - ], 2707 - "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2708 - 0 2709 - ], 2710 - "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2711 - "additionalProp1": "string", 2712 - "additionalProp2": "string", 2713 - "additionalProp3": "string" 2714 - }, 2715 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2716 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2717 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2718 - ], 2719 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2720 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2721 - "string" 2722 - ], 2723 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2724 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2725 - { 2726 - "id": 0, ~/~/ Идентификатор участника чата. 2727 - "info": "string" ~/~/ Дополнительные сведения. 2728 - } 2729 - ], 2730 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2731 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2732 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2733 - "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2734 - "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2735 - "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2736 - "timezone": 0, ~/~/ часовой пояс 2737 - "validity": 0, ~/~/ Срок действия в днях (1-90). 2738 - "autoProlongation": true, ~/~/ Автопродление срока действия. 2739 - "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2740 - { 2741 - "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 - Срок действия правила истек 2742 - "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2743 - "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2744 - "additionalProp1": "string", 2745 - "additionalProp2": "string", 2746 - "additionalProp3": "string" 2747 - } 2748 - } 2749 - ] 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 ~/~/ Фильтрация событий по пробегу половины периметра 2750 2750 } 2751 -))) 2752 2752 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" %) 2753 2753 ((( 2754 - 2759 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2755 2755 ))) 2756 2756 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" %) 2757 2757 ((( 2758 - 2803 +**POST /api/v3/notifications/find** 2759 2759 ))) 2760 2760 2761 - Ответ:2806 +Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 2762 2762 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 + 2763 2763 { 2764 - "id": 0, ~/~/ ID правила 2765 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2766 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2767 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2768 - "name": "string", ~/~/ Имя правила 2769 - "active": true, ~/~/ Активность правила 2770 - "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2771 - "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2772 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2773 - ], 2774 - "vehicleIds": [ ~/~/ Список объектов для анализа. 2775 - 0 2776 - ], 2777 - "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2778 - 0 2779 - ], 2780 - "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2781 - 0 2782 - ], 2783 - "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2784 - "additionalProp1": "string", 2785 - "additionalProp2": "string", 2786 - "additionalProp3": "string" 2787 - }, 2788 - "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2789 - "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2790 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2791 - ], 2792 - "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2793 - "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2794 - "string" 2795 - ], 2796 - "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2797 - "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2798 - { 2799 - "id": 0, ~/~/ Идентификатор участника чата. 2800 - "info": "string" ~/~/ Дополнительные сведения. 2801 - } 2802 - ], 2803 - "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2804 - "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2805 - "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2806 - "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2807 - "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2808 - "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2809 - "timezone": 0, ~/~/ часовой пояс 2810 - "validity": 0, ~/~/ Срок действия в днях (1-90). 2811 - "autoProlongation": true, ~/~/ Автопродление срока действия. 2812 - "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2813 - { 2814 - "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 - Срок действия правила истек 2815 - "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2816 - "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2817 - "additionalProp1": "string", 2818 - "additionalProp2": "string", 2819 - "additionalProp3": "string" 2820 - } 2821 - } 2822 - ] 2818 + "parentId": "" ~/~/ id клиента 2823 2823 } 2824 2824 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 + 2825 2825 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2826 2826 2827 2827 (% class="box infomessage" %) ... ... @@ -4039,12 +4039,16 @@ 4039 4039 Тело запроса: 4040 4040 4041 4041 { 4042 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.4043 - "Balance": 0 ~/~/ Значение баланса.4052 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4053 + "Balance": 0 4044 4044 } 4045 4045 4046 4046 Ответ: Success 4047 4047 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 + 4048 4048 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4049 4049 4050 4050 (% class="box warningmessage" %) ... ... @@ -4056,29 +4056,16 @@ 4056 4056 4057 4057 Тело запроса: 4058 4058 4059 -((( 4060 4060 { 4061 - " clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/ Идентификатор клиента.4062 - "a mount": 0~/~/ Сумма пополнения баланса4074 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4075 + "Balance": 0 4063 4063 } 4064 -))) 4065 4065 4066 -((( 4067 - 4068 -))) 4069 - 4070 4070 Ответ: Success 4071 4071 4072 -((( 4073 -{ 4074 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4075 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4076 - "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4077 - "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4078 - "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4079 - "Description": "string" ~/~/ Описание корректировки. 4080 -} 4081 -))) 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" %)Значение баланса 4082 4082 4083 4083 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4084 4084 ... ... @@ -4091,25 +4091,16 @@ 4091 4091 4092 4092 Тело запроса: 4093 4093 4094 -((( 4095 4095 { 4096 - " clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/ Идентификатор клиента.4097 - "a mount": 0~/~/ Сумма списания с баланса4096 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4097 + "Balance": 0 4098 4098 } 4099 -))) 4100 4100 4101 4101 Ответ: Success 4102 4102 4103 -((( 4104 -{ 4105 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4106 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4107 - "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4108 - "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4109 - "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4110 - "Description": "string" ~/~/ Описание корректировки 4111 -} 4112 -))) 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" %)Значение баланса 4113 4113 4114 4114 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4115 4115 ... ... @@ -4120,35 +4120,28 @@ 4120 4120 4121 4121 Тело запроса: 4122 4122 4123 -((( 4124 4124 { 4125 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4126 - "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4127 - "PermissibleBalance": 0, ~/~/ Допустимый баланс 4128 - "DefermentDays": 0, ~/~/ Отсрочка (дни). 4129 - "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4130 - "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 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, 4131 4131 } 4132 -))) 4133 4133 4134 -((( 4135 - 4136 -))) 4137 - 4138 4138 Ответ: Success 4139 4139 4140 -((( 4141 -{ 4142 - "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4143 - "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4144 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4145 - "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4146 - "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4147 - "DefermentDays": 0, ~/~/ Отсрочка (дни) 4148 - "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4149 - "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4150 -} 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 +Отсрочка, количество дней 4151 4151 ))) 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" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4152 4152 4153 4153 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4154 4154 ... ... @@ -4160,68 +4160,35 @@ 4160 4160 Тело запроса: 4161 4161 4162 4162 { 4163 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.4164 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.4165 - "Features": [ ~/~/ Набор услуг по тарифу клиента.4148 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4149 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4150 + "Features": [ 4166 4166 { 4167 - "Feature": "string", ~/~/ Код услуги.4168 - "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.4169 - "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.4170 - "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование4171 - "Price": 0, ~/~/ Цена за единицу.4172 - "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.4173 - "PeriodValue": 0, ~/~/ Значение периода.4174 - "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)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 4175 4175 } 4176 4176 ] 4177 4177 } 4178 4178 4179 - 4180 4180 Ответ: Success 4181 4181 4182 -((( 4183 -{ 4184 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4185 - "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4186 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4187 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4188 - "Name": "string", ~/~/ Наименование. 4189 - "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4190 - "Constraint": { ~/~/ Ограничения по тарифу 4191 - "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4192 - "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4193 - "DefermentDays": 0 ~/~/ Отсрочка (дни) 4194 - }, 4195 - "Features": [ ~/~/ Набор услуг по тарифному плану. 4196 - { 4197 - "Feature": "string", ~/~/Код услуги. 4198 - "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4199 - "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4200 - "Price": 0, ~/~/ Цена за единицу. 4201 - "PeriodValue": 0, ~/~/ Значение периода. 4202 - "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4203 - } 4204 - ], 4205 - "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4206 - "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4207 - "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4208 - }, 4209 - "Features": [ ~/~/ Набор услуг по тарифу клиента. 4210 - { 4211 - "Feature": "string", ~/~/ Код услуги. 4212 - "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4213 - "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4214 - "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4215 - "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4216 - "Price": 0, ~/~/ Цена за единицу. 4217 - "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4218 - "PeriodValue": 0, ~/~/ Значение периода. 4219 - "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4220 - "Quantity": 0 ~/~/ Количество использования услуги. 4221 - } 4222 - ] 4223 -} 4224 -))) 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 - Месяцы 4225 4225 4226 4226 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4227 4227 ... ... @@ -4326,43 +4326,6 @@ 4326 4326 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4327 4327 |msgCount|Кол-во обработанных сообщений всего 4328 4328 4329 -== **Импортировать историю ТС (Асинхронный запрос)** == 4330 - 4331 -(% class="box successmessage" %) 4332 -((( 4333 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4334 -))) 4335 - 4336 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4337 - 4338 -Метод запроса: **POST** 4339 - 4340 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4341 - 4342 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4343 - 4344 - 4345 -Ответ: 4346 - 4347 -{ 4348 - 4349 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4350 - 4351 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4352 - 4353 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4354 - 4355 - "Message": "string", ~/~/ Информация о выполнении запроса 4356 - 4357 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4358 - 4359 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4360 - 4361 - "Data": "string" ~/~/ Данные 4362 - 4363 -} 4364 - 4365 - 4366 4366 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4367 4367 4368 4368 (% class="box infomessage" %) ... ... @@ -4380,59 +4380,10 @@ 4380 4380 "message": "string" 4381 4381 } 4382 4382 4383 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4384 -**Параметр** 4385 -)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4386 -**Описание** 4387 -))) 4388 -|((( 4389 -activity 4390 -)))|((( 4391 -Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4392 -))) 4393 -|((( 4394 -progress 4395 -)))|((( 4396 -Guid ТС 4397 -))) 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 ТС 4398 4398 4399 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 4400 - 4401 -(% class="box infomessage" %) 4402 -((( 4403 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4404 -))) 4405 - 4406 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4407 - 4408 -Метод запроса: **GET** 4409 - 4410 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4411 - 4412 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4413 - 4414 - 4415 -Ответ: 4416 - 4417 -{ 4418 - 4419 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4420 - 4421 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 4422 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4423 - 4424 - "Message": "string", ~/~/ Информация о выполнении запроса 4425 - 4426 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4427 - 4428 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4429 - 4430 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4431 - 4432 - "Data": "string" ~/~/ Данные 4433 - 4434 -} 4435 - 4436 4436 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4437 4437 4438 4438 (% class="box infomessage" %) ... ... @@ -4944,51 +4944,8 @@ 4944 4944 } 4945 4945 ] 4946 4946 } 4947 - 4948 - 4949 -== **Превышение скорости** == 4950 - 4951 -(% class="box infomessage" %) 4952 -((( 4953 -**POST /api/v3/Reports/overSpeedDuration** 4954 4954 ))) 4955 4955 4956 - Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4957 - 4958 -Пример запроса: 4959 - 4960 -((( 4961 -{ 4962 - "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4963 - "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4964 - "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4965 - "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4966 - "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4967 -} 4968 -))) 4969 - 4970 -((( 4971 - 4972 -))) 4973 - 4974 -((( 4975 -Пример ответа: 4976 -))) 4977 - 4978 -((( 4979 -((( 4980 -[ 4981 - { 4982 - "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4983 - "duration": 0, ~/~/ Продолжительность события в секундах 4984 - "maxSpeed": 0, ~/~/ Максимальная скорость 4985 - "speedLimit": 0 ~/~/ Ограничение скорости 4986 - } 4987 -] 4988 -))) 4989 -))) 4990 -))) 4991 - 4992 4992 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4993 4993 4994 4994 ... ... @@ -5294,9 +5294,33 @@ 5294 5294 ))) 5295 5295 5296 5296 5120 +== **Удаление существующего поля** == 5121 + 5122 +(% class="box errormessage" %) 5297 5297 ((( 5124 +**DELETE /api/v3/agroLands/{id}** 5125 +))) 5126 + 5127 +Пример запроса: 5128 +id ~/~/ Идентификатор поля 5129 + 5130 +Пример ответа: 5131 + 5298 5298 ((( 5133 +200 ~/~/ Успех 5134 +))) 5135 + 5299 5299 ((( 5137 + 5138 +))) 5139 + 5140 +((( 5141 +((( 5142 +((( 5143 + 5144 +))) 5145 + 5146 +((( 5300 5300 == **Изменение поля** == 5301 5301 5302 5302 (% class="box infomessage" %) ... ... @@ -5542,102 +5542,9 @@ 5542 5542 "perimetr": 0, ~/~/ ериметр, м 5543 5543 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5544 5544 } 5545 - 5546 - 5547 -== **Какие поля посещал объект** == 5548 - 5549 -(% class="box successmessage" %) 5550 -((( 5551 -**POST /api/v3/agroLands/visitingByVehicle** 5552 5552 ))) 5553 5553 5554 -Пример запроса: 5555 5555 5556 -{ 5557 - "vehicleId": 0, ~/~/ id объекта 5558 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5559 - "byTime": 0, ~/~/ Объединение событий по времени 5560 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5561 - "byDist": 0, ~/~/ Объединение событий по расстоянию 5562 - "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5563 - "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5564 - "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5565 -} 5566 - 5567 -Пример ответа: 5568 - 5569 -[ 5570 - { 5571 - "fieldId": 0, ~/~/ id объекта 5572 - "vehicleName": "string", ~/~/ Наименование объекта 5573 - "fieldName": "string", ~/~/ Наименование поля 5574 - "fuelUsage": 0, ~/~/ Расход топлива, л/га 5575 - "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5576 - "vehicleId": 0, ~/~/ Идентификатор ТС 5577 - "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5578 - "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5579 - "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5580 - "mileage": 0 ~/~/ Пробег 5581 - } 5582 -] 5583 -))) 5584 - 5585 - 5586 -== **Посещение поля объектами ** == 5587 - 5588 -(% class="box successmessage" %) 5589 -((( 5590 -**POST /api/v3/agroLands/visitingByField** 5591 -))) 5592 - 5593 -Пример запроса: 5594 -{ 5595 - "fieldId": 0, ~/~/ ID поля 5596 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5597 - "byTime": 0, ~/~/ Объединение событий по времени 5598 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5599 - "byDist": 0, ~/~/ Объединение событий по расстоянию 5600 - "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5601 - "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5602 - "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5603 -} 5604 - 5605 -Пример ответа: 5606 - 5607 -[ 5608 - { 5609 - "fieldId": 0, ~/~/ ID поля 5610 - "vehicleName": "string", ~/~/ Наименование объекта 5611 - "fieldName": "string", ~/~/ Имя поля 5612 - "fuelUsage": 0, ~/~/ Расход топлива, л/га 5613 - "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5614 - "vehicleId": 0, ~/~/ Идентификатор ТС 5615 - "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5616 - "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5617 - "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5618 - "mileage": 0 ~/~/ Пробег 5619 - } 5620 -] 5621 - 5622 - 5623 -== **Удаление существующего поля** == 5624 - 5625 -(% class="box errormessage" %) 5626 -((( 5627 -**DELETE /api/v3/agroLands/{id}** 5628 -))) 5629 - 5630 -Пример запроса: 5631 -id ~/~/ Идентификатор поля 5632 - 5633 -Пример ответа: 5634 - 5635 -((( 5636 -200 ~/~/ Успех 5637 - 5638 - 5639 -))) 5640 - 5641 5641 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5642 5642 ))) 5643 5643 ))) ... ... @@ -6062,129 +6062,49 @@ 6062 6062 ))) 6063 6063 6064 6064 6065 -= **Раздел: Роли** = 6066 - 6067 -== **Получение списка клиентских и системных ролей пользователя ** == 6068 - 6069 -(% class="box successmessage" %) 6070 -((( 6071 -**POST /api/v3/groups/find** 6072 -))) 6073 - 6074 -Пример запроса: 6075 - 6076 -((( 6077 -{ 6078 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6079 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6080 -} 6081 -))) 6082 - 6083 -((( 6084 - 6085 -))) 6086 - 6087 -((( 6088 -Пример ответа: 6089 -))) 6090 - 6091 -((( 6092 -((( 6093 -{ 6094 - "groups": [ ~/~/ Системные роли пользователя 6095 - { 6096 - "code": "string", ~/~/ Код роли. 6097 - "name": "string", ~/~/ Имя 6098 - "shortName": "string" ~/~/ Короткое имя 6099 - } 6100 - ], 6101 - "customGroups": [ ~/~/ Системные роли пользователя 6102 - { 6103 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6104 - "name": "string", ~/~/ Наименование 6105 - "shortName": "string", ~/~/ Короткое наименование 6106 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6107 - } 6108 - ] 6109 -} 6110 -))) 6111 -))) 6112 - 6113 -((( 6114 - 6115 -))) 6116 - 6117 -((( 6118 - 6119 -))) 6120 - 6121 6121 = **Раздел: Локатор ** = 6122 6122 6123 6123 6124 -== **Получение данных полокатору** ==5822 +== **Получение списка локаторов, доступных пользователю ** == 6125 6125 6126 6126 (% class="box infomessage" %) 6127 6127 ((( 6128 -**GET /api/v3/locators /{locatorId}**5826 +**GET /api/v3/locators** 6129 6129 ))) 6130 6130 6131 -В за просе указываетсяlocatorid- идентификаторлокатора5829 +В заголовках запроса: X-Auth: Токен авторизации 6132 6132 6133 6133 6134 6134 Пример ответа: 6135 6135 6136 6136 ((( 6137 -((( 6138 -{ 6139 - "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6140 - 0 6141 - ], 6142 - "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6143 - 0 6144 - ], 6145 - "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6146 - 0 6147 - ], 6148 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6149 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6150 - "agentName": "string", ~/~/ Наименование агента. 6151 - "isEnabled": true, ~/~/ Активность 6152 - "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6153 - "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6154 - "name": "string", ~/~/ Наименование. 6155 - "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6156 - "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6157 - "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6158 - "validity": 0, ~/~/ Значение срока действия 6159 - "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6160 - "autoProlongation": true, ~/~/ Автопродление срока действия. 6161 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6162 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6163 - "url": "string", ~/~/ Ссылка 6164 - "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6165 - 6166 - "showVehicleName": true, ~/~/ Наименование объекта 6167 - "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6168 - "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6169 - "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6170 - "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6171 - "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ГИС) 6172 - 6173 - 1 6174 - 6175 - ] 6176 -} 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 +] 6177 6177 ))) 6178 -))) 6179 6179 6180 6180 6181 -((( 6182 -((( 6183 - 6184 -))) 6185 -))) 6186 6186 6187 - 6188 6188 == **Создание локатора** == 6189 6189 6190 6190 (% class="box successmessage" %) ... ... @@ -6196,6 +6196,7 @@ 6196 6196 6197 6197 ((( 6198 6198 { 5873 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6199 6199 "isEnabled": true, ~/~/ Активность 6200 6200 "name": "string", ~/~/ Наименование локатора 6201 6201 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) ... ... @@ -6202,28 +6202,8 @@ 6202 6202 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6203 6203 "validity": 0, ~/~/ Срок действия в днях (1-90) 6204 6204 "autoProlongation": true, ~/~/ Автопродление срока действия. 6205 - "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6206 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6207 - "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6208 - 0 6209 - ], 6210 - "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6211 - 0 6212 - ], 6213 - "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6214 - 0 6215 - ], 6216 - 6217 - "showVehicleName": true, ~/~/ Наименование объекта 6218 - "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6219 - "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6220 - "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6221 - "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6222 - "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ГИС) 6223 - 6224 - 1 6225 - 6226 - ] 5880 + "url": "string", ~/~/ Ссылка 5881 + "language": 0 ~/~/ Язык 6227 6227 } 6228 6228 ))) 6229 6229 ... ... @@ -6235,69 +6235,7 @@ 6235 6235 ))) 6236 6236 6237 6237 6238 -== **Выводит список локаторов ** == 6239 6239 6240 -(% class="box successmessage" %) 6241 -((( 6242 -**POST /api/v3/locators/find** 6243 -))) 6244 - 6245 -Пример запроса: 6246 - 6247 -((( 6248 -{ 6249 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6250 -} 6251 -))) 6252 - 6253 -((( 6254 - 6255 -))) 6256 - 6257 -((( 6258 - 6259 -))) 6260 - 6261 - 6262 -Пример ответа: 6263 - 6264 -((( 6265 -[ 6266 - { 6267 - "vehiclesCount": 0, ~/~/ Количество объектов. 6268 - "geozonesCount": 0, ~/~/ Количество геозон. 6269 - "fieldsCount": 0, ~/~/ Количество полей. 6270 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6271 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6272 - "agentName": "string", ~/~/ Наименование агента. 6273 - "isEnabled": true, ~/~/ Активность локатора 6274 - "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6275 - "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6276 - "name": "string", ~/~/ Наименование локатора 6277 - "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6278 - "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6279 - "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6280 - "validity": 0, ~/~/ Срок действия в днях (1-90) 6281 - "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6282 - "autoProlongation": true, ~/~/ Автоматическая пролонгация 6283 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6284 - "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6285 - "url": "string", ~/~/ ссылка на локатор 6286 - "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6287 - "showVehicleName": true, ~/~/ Наименование объекта 6288 - "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6289 - "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6290 - "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6291 - "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6292 - "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ГИС) 6293 - 6294 - 0 6295 - ] 6296 - } 6297 -] 6298 -))) 6299 - 6300 - 6301 6301 == **Изменение локатора** == 6302 6302 6303 6303 (% class="box infomessage" %) ... ... @@ -6316,31 +6316,12 @@ 6316 6316 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6317 6317 "validity": 0, ~/~/ Срок действия в днях (1-90) 6318 6318 "autoProlongation": true, ~/~/ Автопродление срока действия 6319 - "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6320 - "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6321 - 0 6322 - ], 6323 - "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6324 - 0 6325 - ], 6326 - "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6327 - 0 6328 - ], 6329 - "showVehicleName": true, ~/~/ Наименование объекта 6330 - "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6331 - "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6332 - "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6333 - "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6334 - "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ГИС) 6335 - 6336 - 0 6337 - 6338 - ] 5912 + "url": "string", ~/~/ Ссылка 5913 + "language": 0 ~/~/ Язык 6339 6339 } 6340 - 6341 - 6342 6342 ))) 6343 6343 5917 + 6344 6344 Пример ответа: 6345 6345 6346 6346 200 ~/~/ Success ... ... @@ -6362,201 +6362,8 @@ 6362 6362 ))) 6363 6363 6364 6364 6365 -= **Раздел: Яндекс Маршруты** = 6366 6366 6367 6367 6368 -== **Возвращение списка маршрутов** == 6369 - 6370 -(% class="box infomessage" %) 6371 -((( 6372 -**GET /api/v3/TransportRoutes** 6373 -))) 6374 - 6375 -Пример запроса: 6376 -Id ~/~/ Идентификатор поля 6377 - 6378 -Пример ответа: 6379 - 6380 -((( 6381 -[ 6382 - { 6383 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6384 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6385 - "name": "string", ~/~/ Наименование маршрута. 6386 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6387 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6388 - 0 6389 - ] 6390 - } 6391 -] 6392 -))) 6393 - 6394 - 6395 -== **Добавить маршрут** == 6396 - 6397 -(% class="box infomessage" %) 6398 -((( 6399 -**POST /api/v3/TransportRoutes** 6400 -))) 6401 - 6402 -Пример запроса: 6403 -{ 6404 - "name": "string", ~/~/ Опредлеляет наименование маршрута. 6405 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6406 - "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6407 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6408 - 0 6409 - ] 6410 -} 6411 - 6412 - 6413 -Пример ответа: 6414 - 6415 -((( 6416 -{ 6417 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6418 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6419 - "name": "string", ~/~/ Определяет наименование маршрута 6420 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6421 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6422 - 0 6423 - ] 6424 -} 6425 -))) 6426 - 6427 - 6428 -== **Обновление маршрута** == 6429 - 6430 -(% class="box successmessage" %) 6431 -((( 6432 -**PUT /api/v3/TransportRoutes** 6433 -))) 6434 - 6435 -Пример запроса: 6436 - 6437 -((( 6438 -{ 6439 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6440 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6441 - "name": "string", ~/~/ Опредлеляет наименование маршрута. 6442 - "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6443 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6444 - 0 6445 - ] 6446 -} 6447 -))) 6448 - 6449 -Пример ответа: 6450 - 6451 -((( 6452 -{ 6453 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6454 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6455 - "name": "string", ~/~/ Определяет наименование маршрута 6456 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6457 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6458 - 0 6459 - ] 6460 -} 6461 -))) 6462 - 6463 - 6464 -== **Получить связки маршрутов ТС** == 6465 - 6466 -(% class="box infomessage" %) 6467 -((( 6468 -**POST /api/v3/TransportRoutes/getroutesvehicles** 6469 -))) 6470 - 6471 -Пример запроса: 6472 - 6473 -((( 6474 -[ 6475 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6476 -] 6477 -))) 6478 - 6479 -Пример ответа: 6480 - 6481 -((( 6482 -[ 6483 - { 6484 - "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6485 - "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6486 - } 6487 -] 6488 -))) 6489 - 6490 - 6491 -== **Удалить маршрут** == 6492 - 6493 -(% class="box warningmessage" %) 6494 -((( 6495 -**DELETE /api/v3/TransportRoutes/{id}** 6496 -))) 6497 - 6498 -Пример запроса: 6499 -Id ~/~/ Идентификатор поля 6500 - 6501 - 6502 -= **Раздел: Управление доступа к машинам** = 6503 - 6504 - 6505 -== Получение списка транспортных средств видимых пользователю == 6506 - 6507 -(% class="box infomessage" %) 6508 -((( 6509 -**GET /api/v3/UserVisibleVehicles/{userId}** 6510 -))) 6511 - 6512 -Пример ответа: 6513 - 6514 -((( 6515 -{ 6516 - "vehicleIds": [ ~/~/ Идентификаторы ТС 6517 - 0 6518 - ] 6519 -} 6520 -))) 6521 - 6522 - 6523 -== Задает видимость транспортных средств пользователю == 6524 - 6525 -(% class="box infomessage" %) 6526 -((( 6527 -**POST /api/v3/UserVisibleVehicles** 6528 -))) 6529 - 6530 -Пример запроса: 6531 - 6532 -((( 6533 -((( 6534 -{ 6535 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6536 - "vehicleIds": [ ~/~/ Идентификаторы ТС 6537 - 0 6538 - ] 6539 -} 6540 -))) 6541 - 6542 -((( 6543 - 6544 -))) 6545 - 6546 -((( 6547 -Пример ответа : 6548 -))) 6549 - 6550 -((( 6551 - 6552 -))) 6553 - 6554 -((( 6555 -200 ~/~/ Success 6556 -))) 6557 -))) 6558 - 6559 - 6560 6560 (% class="box" lang="en-US" style="text-align: center;" %) 6561 6561 ((( 6562 6562 (% 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]] **