Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/05/06 12:41
<
>
edited by Андрей Калиновский
on 2024/12/20 16:41
on 2024/12/20 16:41
edited by Андрей Калиновский
on 2025/05/06 12:37
on 2025/05/06 12:37
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -11,6 +11,11 @@ 11 11 12 12 В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 13 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 14 14 15 15 **Содержание страницы:** 16 16 ))) ... ... @@ -118,29 +118,41 @@ 118 118 Запрос должен содержать данные параметра "**agentId**" 119 119 120 120 (% style="color:#000000" %)Ответ: 126 + 127 +((( 121 121 { 122 - "agentId": "", (%%) 123 - "parentId": "", 124 - "parentName": "string", 125 - "name": "string", 126 - "fullName": "string", 127 - "agentInfoType": 0, 128 - "isForeign": true/false, 129 - "district": "string", 130 - "region": "string", 131 - "city": "string", 132 - "inn": "string", 133 - "kpp": "string", 134 - "address": "string", 135 - "addressFact": "string", 136 - "email": "string", 137 - "director": "string", 138 - "bankName": "string", 139 - "bankBIK": "string", 140 - "bankRS": "string", 141 - "bankKS": "string" 142 - } 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 +))) 143 143 160 + 144 144 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 145 145 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 146 146 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -1021,6 +1021,17 @@ 1021 1021 1022 1022 ((( 1023 1023 { 1041 + 1042 +((( 1043 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1044 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1045 +))) 1046 + 1047 +((( 1048 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1049 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1050 +))) 1051 + 1024 1024 "vehicleId": "", ~/~/ ID объекта 1025 1025 "name": "", ~/~/ Имя объекта 1026 1026 "imei": "", ~/~/ IMEI объекта ... ... @@ -1115,6 +1115,7 @@ 1115 1115 ], 1116 1116 "showInTooltip": true, ~/~/ Отображать в подсказке 1117 1117 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1146 + "color": "string", ~/~/ Код цвета датчиков 1118 1118 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1119 1119 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1120 1120 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1172,11 +1172,21 @@ 1172 1172 "date": "2023-05-22T09:57:39.562Z", 1173 1173 "description": "string", 1174 1174 "additionalInfo": "string" 1175 - }1176 - ]1204 + 1205 +((( 1177 1177 } 1207 + ], 1208 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1209 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1178 1178 ))) 1179 1179 1212 +((( 1213 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1214 +} 1215 + 1216 +))) 1217 +))) 1218 + 1180 1180 (% style="text-align:left" %) 1181 1181 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1182 1182 ... ... @@ -1269,7 +1269,13 @@ 1269 1269 1270 1270 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1271 1271 1272 -(% style="color:#000000" %){(%%) 1311 +(% style="color:#000000" %){ 1312 + 1313 + 1314 +((( 1315 + "vehicleId": 0, ~/~/ ID ТС 1316 +))) 1317 + 1273 1273 "parentId": "" , ~/~/ ID клиента 1274 1274 "name": "" , ~/~/ имя ТС 1275 1275 "imei": "" , ~/~/ IMEI ... ... @@ -1362,6 +1362,7 @@ 1362 1362 ], 1363 1363 "showInTooltip": true, ~/~/ Отображать в подсказке 1364 1364 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1410 + "color": "string", ~/~/ код цвета датчиков 1365 1365 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1366 1366 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1367 1367 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1411,10 +1411,19 @@ 1411 1411 "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1412 1412 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1413 1413 "forReport": true ~/~/ Отобразить произвольное поле в отчете 1414 - } 1415 - ] 1460 + 1461 +((( 1462 + } 1463 + ], 1464 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1465 +))) 1466 + 1467 +((( 1468 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1416 1416 } 1470 +))) 1417 1417 1472 + 1418 1418 (% style="color:#000000" %)Ответ: 1419 1419 1420 1420 ... ... @@ -1523,6 +1523,7 @@ 1523 1523 ], 1524 1524 "showInTooltip": true, ~/~/ Отображение в подсказке 1525 1525 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1581 + "color": "string", ~/~/ код цвета датчиков 1526 1526 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1527 1527 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1528 1528 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION ... ... @@ -1559,7 +1559,7 @@ 1559 1559 "forReport": true ~/~/ Отобразить произвольное поле в отчете 1560 1560 } 1561 1561 ], 1562 - "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 -ByMotohoursSensor, 2 -ByRelativeMotohoursSensor1618 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1563 1563 } 1564 1564 ))) 1565 1565 ))) ... ... @@ -1572,81 +1572,10 @@ 1572 1572 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1573 1573 1574 1574 1575 -= =**ИмпортироватьисториюТС(Асинхронныйзапрос)**==1631 +(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами** 1576 1576 1577 -(% class="box successmessage" %) 1578 -((( 1579 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1580 -))) 1581 - 1582 -Метод запроса: **POST** 1583 - 1584 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1585 - 1586 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1587 - 1588 - 1589 -Ответ: 1590 - 1591 -{ 1592 - 1593 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1594 - 1595 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1596 - 1597 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1598 - 1599 - "Message": "string", ~/~/ Информация о выполнении запроса 1600 - 1601 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1602 - 1603 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1604 - 1605 - "Data": "string" ~/~/ Данные 1606 - 1607 -} 1608 - 1609 - 1610 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1611 - 1612 1612 (% class="box infomessage" %) 1613 1613 ((( 1614 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1615 -))) 1616 - 1617 -Метод запроса: **GET** 1618 - 1619 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1620 - 1621 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1622 - 1623 - 1624 -Ответ: 1625 - 1626 -{ 1627 - 1628 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1629 - 1630 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1631 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1632 - 1633 - "Message": "string", ~/~/ Информация о выполнении запроса 1634 - 1635 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1636 - 1637 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1638 - 1639 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1640 - 1641 - "Data": "string" ~/~/ Данные 1642 - 1643 -} 1644 - 1645 - 1646 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1647 - 1648 -(% class="box infomessage" %) 1649 -((( 1650 1650 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1651 1651 ))) 1652 1652 ... ... @@ -1865,9 +1865,19 @@ 1865 1865 1866 1866 "drivers": [ ~/~/ Водители 1867 1867 { 1868 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1869 - "isDefault": true 1870 - } 1853 + 1854 +((( 1855 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1856 + "inputNumber": 0, ~/~/ № входа. 1857 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1858 + "comment": "string", ~/~/ Комментарий. 1859 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1860 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1861 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1862 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1863 +))) 1864 + 1865 + } 1871 1871 ], 1872 1872 "commandTemplates": [ ~/~/ Шаблон команды 1873 1873 { ... ... @@ -1903,6 +1903,11 @@ 1903 1903 ], 1904 1904 "showInTooltip": true, ~/~/ Отображать в подсказке 1905 1905 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1901 + 1902 +((( 1903 + "color": "string",** ~/~/ **Цвет датчика 1904 +))) 1905 + 1906 1906 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1907 1907 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1908 1908 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1949,7 +1949,12 @@ 1949 1949 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1950 1950 "forReport": true ~/~/ Отобразить произвольное поле в отчете 1951 1951 } 1952 - ] 1952 + 1953 +((( 1954 + ], 1955 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1956 +))) 1957 + 1953 1953 } 1954 1954 1955 1955 ... ... @@ -2087,6 +2087,11 @@ 2087 2087 ], 2088 2088 "showInTooltip": true, ~/~/ Отображение в подсказке 2089 2089 "showLastValid": true, ~/~/ Отображать последнее валидное значение 2095 + 2096 +((( 2097 + "color": "string", ~/~/ цвет уведомлений 2098 +))) 2099 + 2090 2090 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2091 2091 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2092 2092 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION ... ... @@ -2403,6 +2403,8 @@ 2403 2403 "motohours": 0, ~/~/ Моточасы за период, секунды 2404 2404 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2405 2405 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2416 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2417 + 2406 2406 } 2407 2407 ] 2408 2408 } ... ... @@ -2446,6 +2446,8 @@ 2446 2446 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2447 2447 "fuelConsumption": 0, ~/~/ Расход топлива 2448 2448 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2461 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2462 + 2449 2449 } 2450 2450 ] 2451 2451 } ... ... @@ -2491,7 +2491,8 @@ 2491 2491 "model": "string", ~/~/ Модель объекта 2492 2492 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2493 2493 { 2494 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2508 + "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 2509 + 2495 2495 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2496 2496 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2497 2497 "valueFuel": 0, ~/~/ Количество ... ... @@ -2720,6 +2720,35 @@ 2720 2720 } 2721 2721 ] 2722 2722 2738 + 2739 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2740 + 2741 +(% class="box successmessage" %) 2742 +((( 2743 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2744 +))) 2745 + 2746 +(% style="color:#000000" %)Метод запроса: **PUT** 2747 + 2748 +Пример запроса: 2749 + 2750 +((( 2751 +{ 2752 + "id": 0, ~/~/ Идентификатор объекта геозоны 2753 + "name": "string", ~/~/ Наименование объекта геозоны 2754 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2755 + "description": "string", ~/~/ Описание объекта геозоны 2756 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2757 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2758 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2759 +} 2760 +))) 2761 + 2762 + 2763 +Пример ответа: 2764 + 2765 +200 ~/~/ Success 2766 + 2723 2723 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2724 2724 2725 2725 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -4204,6 +4204,45 @@ 4204 4204 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4205 4205 |msgCount|Кол-во обработанных сообщений всего 4206 4206 4251 +== == 4252 + 4253 +== **Импортировать историю ТС (Асинхронный запрос)** == 4254 + 4255 +(% class="box successmessage" %) 4256 +((( 4257 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4258 +))) 4259 + 4260 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4261 + 4262 +Метод запроса: **POST** 4263 + 4264 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4265 + 4266 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4267 + 4268 + 4269 +Ответ: 4270 + 4271 +{ 4272 + 4273 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4274 + 4275 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4276 + 4277 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4278 + 4279 + "Message": "string", ~/~/ Информация о выполнении запроса 4280 + 4281 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4282 + 4283 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4284 + 4285 + "Data": "string" ~/~/ Данные 4286 + 4287 +} 4288 + 4289 + 4207 4207 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4208 4208 4209 4209 (% class="box infomessage" %) ... ... @@ -4221,10 +4221,60 @@ 4221 4221 "message": "string" 4222 4222 } 4223 4223 4224 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4225 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4226 -|progress|Guid ТС 4307 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4308 +**Параметр** 4309 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4310 +**Описание** 4311 +))) 4312 +|((( 4313 +activity 4314 +)))|((( 4315 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4316 +))) 4317 +|((( 4318 +progress 4319 +)))|((( 4320 +Guid ТС 4321 +))) 4227 4227 4323 + 4324 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4325 + 4326 +(% class="box infomessage" %) 4327 +((( 4328 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4329 +))) 4330 + 4331 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4332 + 4333 +Метод запроса: **GET** 4334 + 4335 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4336 + 4337 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4338 + 4339 + 4340 +Ответ: 4341 + 4342 +{ 4343 + 4344 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4345 + 4346 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4347 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4348 + 4349 + "Message": "string", ~/~/ Информация о выполнении запроса 4350 + 4351 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4352 + 4353 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4354 + 4355 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4356 + 4357 + "Data": "string" ~/~/ Данные 4358 + 4359 +} 4360 + 4228 4228 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4229 4229 4230 4230 (% class="box infomessage" %) ... ... @@ -4383,7 +4383,7 @@ 4383 4383 4384 4384 (% class="box infomessage" %) 4385 4385 ((( 4386 -POST /api/v3/fuelcards/transactions 4519 +**POST /api/v3/fuelcards/transactions** 4387 4387 ))) 4388 4388 4389 4389 Метод запроса: POST ... ... @@ -4421,7 +4421,32 @@ 4421 4421 "address": "string" ~/~/ Адрес АЗС 4422 4422 } 4423 4423 4557 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4424 4424 4559 +(% class="box infomessage" %) 4560 +((( 4561 +**GET /api/v3/fuelcards** 4562 +))) 4563 + 4564 +Метод запроса: GET 4565 + 4566 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4567 + 4568 +Ответ: 4569 + 4570 +[ 4571 + { 4572 + "Name": "string", ~/~/ Определяет наименование карты. 4573 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4574 + "Number": "string", ~/~/ Определяет № карты. 4575 + "Enabled": true, ~/~/ Определяет признак активности карты. 4576 + "Description": "string", ~/~/ Определяет описание карты. 4577 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4578 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4579 + "deleted": true ~/~/ Признак удаления 4580 + } 4581 +] 4582 + 4425 4425 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4426 4426 4427 4427 ... ... @@ -4672,6 +4672,90 @@ 4672 4672 ] 4673 4673 4674 4674 4833 +== **Отчет трек-датчики** == 4834 + 4835 +(% class="box infomessage" %) 4836 +((( 4837 +**POST /api/v3/Reports/sensorsWorks** 4838 +))) 4839 + 4840 +**Пример запроса:** 4841 + 4842 +{ 4843 + "vehicleIds": [ ~/~/ Список ID объектов 4844 + 0 4845 + ], 4846 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4847 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4848 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4849 +} 4850 + 4851 +**Пример ответа:** 4852 + 4853 +((( 4854 +{ 4855 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4856 + { 4857 + "vehicleId": 0, ~/~/ Идентификатор ТС 4858 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4859 + { 4860 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4861 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4862 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4863 + "name": "string", ~/~/ Наименование оборудования. 4864 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4865 + "totalMileage": 0, ~/~/ Общий пробег. 4866 + "avgSpeed": 0 ~/~/ Средняя скорость. 4867 + } 4868 + ] 4869 + } 4870 + ] 4871 +} 4872 + 4873 + 4874 +== **Превышение скорости** == 4875 + 4876 +(% class="box infomessage" %) 4877 +((( 4878 +**POST /api/v3/Reports/overSpeedDuration** 4879 +))) 4880 + 4881 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4882 + 4883 +Пример запроса: 4884 + 4885 +((( 4886 +{ 4887 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4888 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4889 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4890 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4891 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4892 +} 4893 +))) 4894 + 4895 +((( 4896 + 4897 +))) 4898 + 4899 +((( 4900 +Пример ответа: 4901 +))) 4902 + 4903 +((( 4904 +((( 4905 +[ 4906 + { 4907 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4908 + "duration": 0, ~/~/ Продолжительность события в секундах 4909 + "maxSpeed": 0, ~/~/ Максимальная скорость 4910 + "speedLimit": 0 ~/~/ Ограничение скорости 4911 + } 4912 +] 4913 +))) 4914 +))) 4915 +))) 4916 + 4675 4675 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4676 4676 4677 4677 ... ... @@ -4746,13 +4746,16 @@ 4746 4746 **POST /api/v3/agroLands** 4747 4747 ))) 4748 4748 4991 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4992 +X-agent - ID клиента 4993 + 4749 4749 Пример запроса: 4750 4750 4751 4751 ((( 4752 4752 { 4753 4753 "extId": "string", 4754 - "shape": " string", ~/~/ Форма поля4755 - "shapeFormat": "s tring", ~/~/ Формат, в котором представлена форма поля4999 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5000 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4756 4756 "display": "string", ~/~/ Настройки отображения 4757 4757 "year": 0, ~/~/ Год поля 4758 4758 "name": "string", ~/~/ Наименование ... ... @@ -5249,7 +5249,7 @@ 5249 5249 ))) 5250 5250 5251 5251 5252 -= =(% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) ==5497 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5253 5253 ))) 5254 5254 ))) 5255 5255 ))) ... ... @@ -5294,7 +5294,7 @@ 5294 5294 ] 5295 5295 5296 5296 5297 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 5542 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5298 5298 5299 5299 (% class="box infomessage" %) 5300 5300 ((( ... ... @@ -5392,7 +5392,618 @@ 5392 5392 ] 5393 5393 5394 5394 5640 += **Раздел: Журнал заданий ** = 5395 5395 5642 + 5643 +== **Создание задания в Журнале заданий** == 5644 + 5645 +(% class="box infomessage" %) 5646 +((( 5647 +**POST /api/v3/vehicletasks** 5648 +))) 5649 + 5650 +Пример запроса: 5651 + 5652 +((( 5653 +{ 5654 + "vehicleId": 0, ~/~/ Идентификатор ТС 5655 + "description": "string", ~/~/ Описание 5656 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5657 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5658 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5659 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5660 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5661 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5662 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5663 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5664 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5665 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5666 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5667 + "cost": { 5668 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5669 + "Name": "string", ~/~/ Наименование 5670 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5671 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5672 + "Norm": 0 ~/~/ Норма внесения 5673 + }, 5674 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5675 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5676 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5677 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5678 + "deleted": true, ~/~/ Признак удаления 5679 + "extId": "string", 5680 + "GeoIds": [ ~/~/ Cвязанные поля 5681 + 0 5682 + ] 5683 +} 5684 +))) 5685 + 5686 + 5687 +Пример ответа: 5688 + 5689 +{ 5690 + "vehicleId": 0, ~/~/ Идентификатор ТС 5691 + "description": "string", ~/~/ Описание 5692 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5693 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5694 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5695 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5696 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5697 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5698 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5699 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5700 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5701 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5702 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5703 + "cost": { 5704 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5705 + "Name": "string", ~/~/ Наименование 5706 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5707 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5708 + "Norm": 0 ~/~/ Норма внесения 5709 + }, 5710 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5711 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5712 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5713 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5714 + "deleted": true, ~/~/ Признак удаления 5715 + "extId": "string", ~/~/ ExtId 5716 + "GeoIds": [ ~/~/ Связанные поля 5717 + 0 5718 + ] 5719 +} 5720 + 5721 + 5722 +== **Редактирование задания в Журнале заданий** == 5723 + 5724 +(% class="box successmessage" %) 5725 +((( 5726 +**PUT /api/v3/vehicletasks** 5727 +))) 5728 + 5729 +Пример запроса: 5730 + 5731 +((( 5732 +{ 5733 + "vehicleId": 0, ~/~/ Идентификатор ТС 5734 + "description": "string", ~/~/ Описание 5735 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5736 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5737 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5738 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5739 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5740 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5741 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5742 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5743 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5744 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5745 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5746 + "cost": { 5747 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5748 + "Name": "string", ~/~/ Наименование 5749 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5750 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5751 + "Norm": 0 ~/~/ Норма внесения 5752 + }, 5753 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5754 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5755 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5756 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5757 + "deleted": true, ~/~/ Признак удаления 5758 + "extId": "string", ~/~/ ExtId 5759 + "GeoIds": [ ~/~/ Связанные поля 5760 + 0 5761 + ] 5762 +} 5763 +))) 5764 + 5765 + 5766 +Пример ответа: 5767 + 5768 +{ 5769 + "vehicleId": 0, ~/~/ Идентификатор ТС 5770 + "description": "string", ~/~/ Описание 5771 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5772 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5773 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5774 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5775 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5776 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5777 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5778 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5779 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5780 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5781 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5782 + "cost": { 5783 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5784 + "Name": "string", ~/~/ Наименование 5785 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5786 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5787 + "Norm": 0 ~/~/ Норма внесения 5788 + }, 5789 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5790 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5791 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5792 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5793 + "deleted": true, ~/~/ Признак удаления 5794 + "extId": "string", ~/~/ ExtId 5795 + "GeoIds": [ ~/~/ Связанные поля 5796 + 0 5797 + ] 5798 +} 5799 + 5800 + 5801 +== **Удаление задания в Журнале заданий** == 5802 + 5803 +(% class="box warningmessage" %) 5804 +((( 5805 +**DELETE /api/v3/vehicletasks** 5806 +))) 5807 + 5808 +Пример запроса: 5809 + 5810 +((( 5811 +[ 5812 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5813 +] 5814 +))) 5815 + 5816 +((( 5817 + 5818 +))) 5819 + 5820 +Пример ответа: 5821 + 5822 +{ 5823 + "vehicleId": 0, ~/~/ Идентификатор ТС 5824 + "description": "string", ~/~/ Описание 5825 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5826 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5827 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5828 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5829 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5830 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5831 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5832 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5833 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5834 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5835 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5836 + "cost": { 5837 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5838 + "Name": "string", ~/~/ Наименование 5839 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5840 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5841 + "Norm": 0 ~/~/ Норма внесения 5842 + }, 5843 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5844 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5845 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5846 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5847 + "deleted": true, ~/~/ Признак удаления 5848 + "extId": "string", ~/~/ ExtId 5849 + "GeoIds": [ ~/~/ Связанные поля 5850 + 0 5851 + ] 5852 +} 5853 + 5854 + 5855 +== **Получение списка Журнала заданий** == 5856 + 5857 +(% class="box infomessage" %) 5858 +((( 5859 +**POST /api/v3/vehicletasks/getbyperiod** 5860 +))) 5861 + 5862 +Пример запроса: 5863 + 5864 +((( 5865 +{ 5866 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 5867 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 5868 + "TimeZone": 0, ~/~/ Часовой пояс. 5869 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 5870 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 5871 + ], 5872 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 5873 + 0 5874 + ], 5875 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 5876 + 0 5877 + ], 5878 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 5879 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 5880 +} 5881 +))) 5882 + 5883 + 5884 +Пример ответа: 5885 + 5886 +((( 5887 +{ 5888 + "total": 0, ~/~/ Общее количество записей 5889 + "pages": 0, ~/~/ Общее количество страниц 5890 + "currentPage": 0, ~/~/ Текущая страница 5891 + "items": [ ~/~/ Записи 5892 + { 5893 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5894 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 5895 + "name": "string", ~/~/ Название задания. 5896 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 5897 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 5898 + "workKind": "string", ~/~/ Вид работ 5899 + "techOp": "string", ~/~/ Тех. операция 5900 + "trailerModel": "string", ~/~/ Модель агрегата 5901 + "width": "string", ~/~/ Ширина, м 5902 + "speed": "string", ~/~/ Тех. скорость 5903 + "fields": "string", ~/~/ Поля 5904 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 5905 + "vehicles": "string", ~/~/ Объект-модель 5906 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 5907 + "drivers": "string", ~/~/ Водители 5908 + "tmc": "string", ~/~/ ТМЦ 5909 + "client": "string", ~/~/ Клиент 5910 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5911 + "dep": "string", ~/~/ Подразделение 5912 + "geoIds": [ ~/~/ Связанные поля 5913 + 0 5914 + ] 5915 + } 5916 + ] 5917 +} 5918 +))) 5919 + 5920 + 5921 += **Раздел: Локатор ** = 5922 + 5923 + 5924 +== **Получение списка локаторов, доступных пользователю ** == 5925 + 5926 +(% class="box infomessage" %) 5927 +((( 5928 +**GET /api/v3/locators** 5929 +))) 5930 + 5931 +В заголовках запроса: X-Auth: Токен авторизации 5932 + 5933 + 5934 +Пример ответа: 5935 + 5936 +((( 5937 +[ 5938 + { 5939 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5940 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5941 + "agentName": "string", ~/~/ Наименование агента. 5942 + "isEnabled": true, ~/~/ Активен 5943 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5944 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5945 + "name": "string", ~/~/ Наименование 5946 + "status": 0, ~/~/ 5947 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5948 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5949 + "validity": 0, ~/~/ Срок действия в днях (1-90). 5950 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5951 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5952 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5953 + "url": "string", ~/~/ Ссылка 5954 + "language": 0, ~/~/ Язык. 5955 + "vehiclesCount": 0, ~/~/ Количество объектов. 5956 + "geozonesCount": 0, ~/~/ Количество геозон. 5957 + "fieldsCount": 0 ~/~/ Количество полей. 5958 + } 5959 +] 5960 +))) 5961 + 5962 + 5963 + 5964 +== **Создание локатора** == 5965 + 5966 +(% class="box successmessage" %) 5967 +((( 5968 +**POST /api/v3/locators** 5969 +))) 5970 + 5971 +Пример запроса: 5972 + 5973 +((( 5974 +{ 5975 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5976 + "isEnabled": true, ~/~/ Активность 5977 + "name": "string", ~/~/ Наименование локатора 5978 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 5979 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5980 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5981 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5982 + "url": "string", ~/~/ Ссылка 5983 + "language": 0 ~/~/ Язык 5984 +} 5985 +))) 5986 + 5987 + 5988 +Пример ответа: 5989 + 5990 +((( 5991 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 5992 +))) 5993 + 5994 + 5995 + 5996 +== **Изменение локатора** == 5997 + 5998 +(% class="box infomessage" %) 5999 +((( 6000 +**PUT /api/v3/locators** 6001 +))) 6002 + 6003 +Пример запроса: 6004 + 6005 +((( 6006 +{ 6007 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6008 + "isEnabled": true, ~/~/ Активность 6009 + "name": "string", ~/~/ Наименование 6010 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6011 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6012 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6013 + "autoProlongation": true, ~/~/ Автопродление срока действия 6014 + "url": "string", ~/~/ Ссылка 6015 + "language": 0 ~/~/ Язык 6016 +} 6017 +))) 6018 + 6019 + 6020 +Пример ответа: 6021 + 6022 +200 ~/~/ Success 6023 + 6024 + 6025 +== **Удалить локатор** == 6026 + 6027 +(% class="box warningmessage" %) 6028 +((( 6029 +**DELETE /api/v3/locators** 6030 +))) 6031 + 6032 +Пример запроса: 6033 + 6034 +((( 6035 +[ 6036 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6037 +] 6038 +))) 6039 + 6040 + 6041 + 6042 += **Раздел: Яндекс Маршруты** = 6043 + 6044 + 6045 +== **Возвращение списка маршрутов** == 6046 + 6047 +(% class="box infomessage" %) 6048 +((( 6049 +**GET /api/v3/TransportRoutes** 6050 +))) 6051 + 6052 +Пример запроса: 6053 +Id ~/~/ Идентификатор поля 6054 + 6055 + 6056 +Пример ответа: 6057 + 6058 +((( 6059 +[ 6060 + { 6061 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6062 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6063 + "name": "string", ~/~/ Наименование маршрута. 6064 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6065 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6066 + 0 6067 + ] 6068 + } 6069 +] 6070 +))) 6071 + 6072 + 6073 + 6074 +== **Добавить маршрут** == 6075 + 6076 +(% class="box infomessage" %) 6077 +((( 6078 +**POST /api/v3/TransportRoutes** 6079 +))) 6080 + 6081 +Пример запроса: 6082 +{ 6083 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6084 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6085 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6086 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6087 + 0 6088 + ] 6089 +} 6090 + 6091 + 6092 +Пример ответа: 6093 + 6094 +((( 6095 +{ 6096 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6097 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6098 + "name": "string", ~/~/ Определяет наименование маршрута 6099 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6100 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6101 + 0 6102 + ] 6103 +} 6104 +))) 6105 + 6106 + 6107 +== **Обновление маршрута** == 6108 + 6109 +(% class="box successmessage" %) 6110 +((( 6111 +**PUT /api/v3/TransportRoutes** 6112 +))) 6113 + 6114 +Пример запроса: 6115 + 6116 +((( 6117 +{ 6118 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6119 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6120 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6121 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6122 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6123 + 0 6124 + ] 6125 +} 6126 +))) 6127 + 6128 + 6129 +Пример ответа: 6130 + 6131 +((( 6132 +{ 6133 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6134 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6135 + "name": "string", ~/~/ Определяет наименование маршрута 6136 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6137 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6138 + 0 6139 + ] 6140 +} 6141 +))) 6142 + 6143 + 6144 +== **Получить связки маршрутов ТС** == 6145 + 6146 +(% class="box infomessage" %) 6147 +((( 6148 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6149 +))) 6150 + 6151 +Пример запроса: 6152 + 6153 +((( 6154 +[ 6155 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6156 +] 6157 +))) 6158 + 6159 + 6160 +Пример ответа: 6161 + 6162 +((( 6163 +[ 6164 + { 6165 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6166 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6167 + } 6168 +] 6169 +))) 6170 + 6171 + 6172 +== **Удалить маршрут** == 6173 + 6174 +(% class="box warningmessage" %) 6175 +((( 6176 +**DELETE /api/v3/TransportRoutes/{id}** 6177 +))) 6178 + 6179 +Пример запроса: 6180 +Id ~/~/ Идентификатор поля 6181 + 6182 + 6183 +==== ==== 6184 + 6185 += **Раздел: Управление доступа к машинам** = 6186 + 6187 + 6188 +== Получение списка транспортных средств видимых пользователю == 6189 + 6190 +(% class="box infomessage" %) 6191 +((( 6192 +**GET /api/v3/UserVisibleVehicles/{userId}** 6193 +))) 6194 + 6195 +Пример ответа: 6196 + 6197 +((( 6198 +{ 6199 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6200 + 0 6201 + ] 6202 +} 6203 +))) 6204 + 6205 + 6206 + 6207 +== Задает видимость транспортных средств пользователю == 6208 + 6209 +(% class="box infomessage" %) 6210 +((( 6211 +**POST /api/v3/UserVisibleVehicles** 6212 +))) 6213 + 6214 +Пример запроса: 6215 + 6216 +((( 6217 +((( 6218 +{ 6219 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6220 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6221 + 0 6222 + ] 6223 +} 6224 +))) 6225 + 6226 +((( 6227 + 6228 +))) 6229 + 6230 +((( 6231 + 6232 +))) 6233 + 6234 +((( 6235 +Пример ответа : 6236 +))) 6237 + 6238 +((( 6239 + 6240 +))) 6241 + 6242 +((( 6243 +200 ~/~/ Success 6244 +))) 6245 +))) 6246 + 6247 + 6248 + 6249 + 6250 + 6251 + 5396 5396 (% class="box" lang="en-US" style="text-align: center;" %) 5397 5397 ((( 5398 5398 (% 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]] **