Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/10 15:42
<
>
edited by Андрей Калиновский
on 2025/03/12 10:23
on 2025/03/12 10:23
edited by Андрей Калиновский
on 2025/05/26 14:43
on 2025/05/26 14:43
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" %)Идентификатор клиента-родителя ... ... @@ -860,7 +860,7 @@ 860 860 { 861 861 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 862 862 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 863 - "deleted": true,880 + "deleted": false, 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": true,899 + "deleted": false, 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" %)Метод позволяет изменить статус пользователя, указанного в запросе.933 +(% 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" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1000 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 984 984 985 985 (% style="color:#000000" %)Метод запроса: **DELETE** 986 986 ... ... @@ -1611,77 +1611,6 @@ 1611 1611 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1612 1612 1613 1613 1614 -== **Импортировать историю ТС (Асинхронный запрос)** == 1615 - 1616 -(% class="box successmessage" %) 1617 -((( 1618 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1619 -))) 1620 - 1621 -Метод запроса: **POST** 1622 - 1623 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1624 - 1625 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1626 - 1627 - 1628 -Ответ: 1629 - 1630 -{ 1631 - 1632 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1633 - 1634 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1635 - 1636 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1637 - 1638 - "Message": "string", ~/~/ Информация о выполнении запроса 1639 - 1640 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1641 - 1642 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1643 - 1644 - "Data": "string" ~/~/ Данные 1645 - 1646 -} 1647 - 1648 - 1649 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1650 - 1651 -(% class="box infomessage" %) 1652 -((( 1653 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1654 -))) 1655 - 1656 -Метод запроса: **GET** 1657 - 1658 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1659 - 1660 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1661 - 1662 - 1663 -Ответ: 1664 - 1665 -{ 1666 - 1667 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1668 - 1669 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1670 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1671 - 1672 - "Message": "string", ~/~/ Информация о выполнении запроса 1673 - 1674 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1675 - 1676 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1677 - 1678 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1679 - 1680 - "Data": "string" ~/~/ Данные 1681 - 1682 -} 1683 - 1684 - 1685 1685 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1686 1686 1687 1687 (% class="box infomessage" %) ... ... @@ -1827,7 +1827,6 @@ 1827 1827 "stage": "", ~/~/ Состояние 1828 1828 (% style="color:#000000" %) } 1829 1829 1830 -== == 1831 1831 1832 1832 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1833 1833 ... ... @@ -2512,6 +2512,8 @@ 2512 2512 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2513 2513 "fuelConsumption": 0, ~/~/ Расход топлива 2514 2514 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2460 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2461 + 2515 2515 } 2516 2516 ] 2517 2517 } ... ... @@ -2557,7 +2557,8 @@ 2557 2557 "model": "string", ~/~/ Модель объекта 2558 2558 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2559 2559 { 2560 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2507 + "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 2508 + 2561 2561 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2562 2562 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2563 2563 "valueFuel": 0, ~/~/ Количество ... ... @@ -2786,6 +2786,35 @@ 2786 2786 } 2787 2787 ] 2788 2788 2737 + 2738 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2739 + 2740 +(% class="box successmessage" %) 2741 +((( 2742 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2743 +))) 2744 + 2745 +(% style="color:#000000" %)Метод запроса: **PUT** 2746 + 2747 +Пример запроса: 2748 + 2749 +((( 2750 +{ 2751 + "id": 0, ~/~/ Идентификатор объекта геозоны 2752 + "name": "string", ~/~/ Наименование объекта геозоны 2753 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2754 + "description": "string", ~/~/ Описание объекта геозоны 2755 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2756 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2757 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2758 +} 2759 +))) 2760 + 2761 + 2762 +Пример ответа: 2763 + 2764 +200 ~/~/ Success 2765 + 2789 2789 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2790 2790 2791 2791 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -4270,6 +4270,43 @@ 4270 4270 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4271 4271 |msgCount|Кол-во обработанных сообщений всего 4272 4272 4250 +== **Импортировать историю ТС (Асинхронный запрос)** == 4251 + 4252 +(% class="box successmessage" %) 4253 +((( 4254 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4255 +))) 4256 + 4257 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4258 + 4259 +Метод запроса: **POST** 4260 + 4261 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4262 + 4263 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4264 + 4265 + 4266 +Ответ: 4267 + 4268 +{ 4269 + 4270 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4271 + 4272 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4273 + 4274 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4275 + 4276 + "Message": "string", ~/~/ Информация о выполнении запроса 4277 + 4278 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4279 + 4280 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4281 + 4282 + "Data": "string" ~/~/ Данные 4283 + 4284 +} 4285 + 4286 + 4273 4273 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4274 4274 4275 4275 (% class="box infomessage" %) ... ... @@ -4287,10 +4287,59 @@ 4287 4287 "message": "string" 4288 4288 } 4289 4289 4290 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4291 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4292 -|progress|Guid ТС 4304 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4305 +**Параметр** 4306 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4307 +**Описание** 4308 +))) 4309 +|((( 4310 +activity 4311 +)))|((( 4312 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4313 +))) 4314 +|((( 4315 +progress 4316 +)))|((( 4317 +Guid ТС 4318 +))) 4293 4293 4320 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4321 + 4322 +(% class="box infomessage" %) 4323 +((( 4324 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4325 +))) 4326 + 4327 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4328 + 4329 +Метод запроса: **GET** 4330 + 4331 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4332 + 4333 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4334 + 4335 + 4336 +Ответ: 4337 + 4338 +{ 4339 + 4340 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4341 + 4342 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4343 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4344 + 4345 + "Message": "string", ~/~/ Информация о выполнении запроса 4346 + 4347 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4348 + 4349 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4350 + 4351 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4352 + 4353 + "Data": "string" ~/~/ Данные 4354 + 4355 +} 4356 + 4294 4294 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4295 4295 4296 4296 (% class="box infomessage" %) ... ... @@ -4802,8 +4802,51 @@ 4802 4802 } 4803 4803 ] 4804 4804 } 4868 + 4869 + 4870 +== **Превышение скорости** == 4871 + 4872 +(% class="box infomessage" %) 4873 +((( 4874 +**POST /api/v3/Reports/overSpeedDuration** 4805 4805 ))) 4806 4806 4877 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4878 + 4879 +Пример запроса: 4880 + 4881 +((( 4882 +{ 4883 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4884 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4885 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4886 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4887 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4888 +} 4889 +))) 4890 + 4891 +((( 4892 + 4893 +))) 4894 + 4895 +((( 4896 +Пример ответа: 4897 +))) 4898 + 4899 +((( 4900 +((( 4901 +[ 4902 + { 4903 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4904 + "duration": 0, ~/~/ Продолжительность события в секундах 4905 + "maxSpeed": 0, ~/~/ Максимальная скорость 4906 + "speedLimit": 0 ~/~/ Ограничение скорости 4907 + } 4908 +] 4909 +))) 4910 +))) 4911 +))) 4912 + 4807 4807 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4808 4808 4809 4809 ... ... @@ -4878,13 +4878,16 @@ 4878 4878 **POST /api/v3/agroLands** 4879 4879 ))) 4880 4880 4987 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4988 +X-agent - ID клиента 4989 + 4881 4881 Пример запроса: 4882 4882 4883 4883 ((( 4884 4884 { 4885 4885 "extId": "string", 4886 - "shape": " string", ~/~/ Форма поля4887 - "shapeFormat": "s tring", ~/~/ Формат, в котором представлена форма поля4995 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 4996 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4888 4888 "display": "string", ~/~/ Настройки отображения 4889 4889 "year": 0, ~/~/ Год поля 4890 4890 "name": "string", ~/~/ Наименование ... ... @@ -5821,33 +5821,84 @@ 5821 5821 Пример ответа: 5822 5822 5823 5823 ((( 5933 +((( 5934 +{ 5935 + "vehiclesIds": [ ~/~/ Объекты 5936 + 0 5937 + ], 5938 + "geoIds": [ ~/~/ Геозоны 5939 + 0 5940 + ], 5941 + "fieldsIds": [ ~/~/ Поля 5942 + 0 5943 + ], 5944 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5945 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5946 + "agentName": "string", ~/~/ Наименование агента. 5947 + "isEnabled": true, ~/~/ Активность 5948 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 5949 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 5950 + "name": "string", ~/~/ Наименование. 5951 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5952 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 5953 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 5954 + "validity": 0, ~/~/ Значение срока действия 5955 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 5956 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5957 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5958 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5959 + "url": "string", ~/~/ Ссылка 5960 + "language": 0, ~/~/ Язык 5961 + "showVehicleName": true, ~/~/ Наименование объекта 5962 + "showVehicleDirection": true, ~/~/ Направление движения на треке 5963 + "allowTrackReport": true, ~/~/ Трек 5964 + "showTrackTracing": true, ~/~/ Трассировка трека 5965 + "showSensors": true, ~/~/ Датчик 5966 + "availableMapLayers": [ ~/~/ Слои на карте 5967 + 0 5968 + ] 5969 +} 5970 +))) 5971 +))) 5972 + 5973 + 5974 +== **Получение перечня моделей ** == 5975 + 5976 +(% class="box successmessage" %) 5977 +((( 5978 +**POST /api/v3/models/find** 5979 +))) 5980 + 5981 +Пример запроса: 5982 + 5983 +((( 5984 +((( 5985 +{ 5986 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5987 + "name": "string", ~/~/ Наименование локатора 5988 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор пользователя, для которого надо получить данные 5989 +} 5990 +))) 5991 + 5992 + 5993 + 5994 + Пример ответа: 5995 + 5996 + 5997 +((( 5824 5824 [ 5825 5825 { 5826 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5827 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5828 - "agentName": "string", ~/~/ Наименование агента. 5829 - "isEnabled": true, ~/~/ Активен 5830 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5831 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5832 - "name": "string", ~/~/ Наименование 5833 - "status": 0, ~/~/ 5834 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5835 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5836 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5837 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5838 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5839 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5840 - "url": "string", ~/~/ Ссылка 5841 - "language": 0, ~/~/ Язык. 5842 - "vehiclesCount": 0, ~/~/ Количество объектов. 5843 - "geozonesCount": 0, ~/~/ Количество геозон. 5844 - "fieldsCount": 0 ~/~/ Количество полей. 6000 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6001 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6002 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6003 + "name": "string", ~/~/ Наименование локатора 6004 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 5845 5845 } 5846 5846 ] 5847 5847 ))) 6008 +))) 5848 5848 5849 5849 5850 - 5851 5851 == **Создание локатора** == 5852 5852 5853 5853 (% class="box successmessage" %) ... ... @@ -5868,6 +5868,24 @@ 5868 5868 "autoProlongation": true, ~/~/ Автопродление срока действия. 5869 5869 "url": "string", ~/~/ Ссылка 5870 5870 "language": 0 ~/~/ Язык 6031 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6032 + "vehiclesIds": [ ~/~/ Oбъекты 6033 + 0 6034 + ], 6035 + "geoIds": [ ~/~/ Геозоны 6036 + 0 6037 + ], 6038 + "fieldsIds": [ ~/~/ Поля 6039 + 0 6040 + ], 6041 + "showVehicleName": true, ~/~/ Наименование объекта 6042 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6043 + "allowTrackReport": true, ~/~/ Трек 6044 + "showTrackTracing": true, ~/~/ Трассировка трека 6045 + "showSensors": true, ~/~/ Датчик 6046 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6047 + 0 6048 + ] 5871 5871 } 5872 5872 ))) 5873 5873 ... ... @@ -5900,10 +5900,29 @@ 5900 5900 "autoProlongation": true, ~/~/ Автопродление срока действия 5901 5901 "url": "string", ~/~/ Ссылка 5902 5902 "language": 0 ~/~/ Язык 6081 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6082 + "vehiclesIds": [ ~/~/ Oбъекты 6083 + 0 6084 + ], 6085 + "geoIds": [ ~/~/ Геозоны 6086 + 0 6087 + ], 6088 + "fieldsIds": [ ~/~/ Поля 6089 + 0 6090 + ], 6091 + "showVehicleName": true, ~/~/ Наименование объекта 6092 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6093 + "allowTrackReport": true, ~/~/ Трек 6094 + "showTrackTracing": true, ~/~/ Трассировка трека 6095 + "showSensors": true, ~/~/ Датчик 6096 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6097 + 0 6098 + ] 5903 5903 } 6100 + 6101 + 5904 5904 ))) 5905 5905 5906 - 5907 5907 Пример ответа: 5908 5908 5909 5909 200 ~/~/ Success ... ... @@ -5926,7 +5926,215 @@ 5926 5926 5927 5927 5928 5928 6126 += **Раздел: Яндекс Маршруты** = 5929 5929 6128 + 6129 +== **Возвращение списка маршрутов** == 6130 + 6131 +(% class="box infomessage" %) 6132 +((( 6133 +**GET /api/v3/TransportRoutes** 6134 +))) 6135 + 6136 +Пример запроса: 6137 +Id ~/~/ Идентификатор поля 6138 + 6139 + 6140 +Пример ответа: 6141 + 6142 +((( 6143 +[ 6144 + { 6145 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6146 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6147 + "name": "string", ~/~/ Наименование маршрута. 6148 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6149 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6150 + 0 6151 + ] 6152 + } 6153 +] 6154 +))) 6155 + 6156 + 6157 + 6158 +== **Добавить маршрут** == 6159 + 6160 +(% class="box infomessage" %) 6161 +((( 6162 +**POST /api/v3/TransportRoutes** 6163 +))) 6164 + 6165 +Пример запроса: 6166 +{ 6167 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6168 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6169 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6170 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6171 + 0 6172 + ] 6173 +} 6174 + 6175 + 6176 +Пример ответа: 6177 + 6178 +((( 6179 +{ 6180 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6181 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6182 + "name": "string", ~/~/ Определяет наименование маршрута 6183 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6184 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6185 + 0 6186 + ] 6187 +} 6188 +))) 6189 + 6190 + 6191 +== **Обновление маршрута** == 6192 + 6193 +(% class="box successmessage" %) 6194 +((( 6195 +**PUT /api/v3/TransportRoutes** 6196 +))) 6197 + 6198 +Пример запроса: 6199 + 6200 +((( 6201 +{ 6202 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6203 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6204 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6205 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6206 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6207 + 0 6208 + ] 6209 +} 6210 +))) 6211 + 6212 + 6213 +Пример ответа: 6214 + 6215 +((( 6216 +{ 6217 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6218 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6219 + "name": "string", ~/~/ Определяет наименование маршрута 6220 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6221 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6222 + 0 6223 + ] 6224 +} 6225 +))) 6226 + 6227 + 6228 +== **Получить связки маршрутов ТС** == 6229 + 6230 +(% class="box infomessage" %) 6231 +((( 6232 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6233 +))) 6234 + 6235 +Пример запроса: 6236 + 6237 +((( 6238 +[ 6239 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6240 +] 6241 +))) 6242 + 6243 + 6244 +Пример ответа: 6245 + 6246 +((( 6247 +[ 6248 + { 6249 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6250 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6251 + } 6252 +] 6253 +))) 6254 + 6255 + 6256 +== **Удалить маршрут** == 6257 + 6258 +(% class="box warningmessage" %) 6259 +((( 6260 +**DELETE /api/v3/TransportRoutes/{id}** 6261 +))) 6262 + 6263 +Пример запроса: 6264 +Id ~/~/ Идентификатор поля 6265 + 6266 + 6267 + 6268 += **Раздел: Управление доступа к машинам** = 6269 + 6270 + 6271 +== Получение списка транспортных средств видимых пользователю == 6272 + 6273 +(% class="box infomessage" %) 6274 +((( 6275 +**GET /api/v3/UserVisibleVehicles/{userId}** 6276 +))) 6277 + 6278 +Пример ответа: 6279 + 6280 +((( 6281 +{ 6282 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6283 + 0 6284 + ] 6285 +} 6286 +))) 6287 + 6288 + 6289 + 6290 +== Задает видимость транспортных средств пользователю == 6291 + 6292 +(% class="box infomessage" %) 6293 +((( 6294 +**POST /api/v3/UserVisibleVehicles** 6295 +))) 6296 + 6297 +Пример запроса: 6298 + 6299 +((( 6300 +((( 6301 +{ 6302 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6303 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6304 + 0 6305 + ] 6306 +} 6307 +))) 6308 + 6309 +((( 6310 + 6311 +))) 6312 + 6313 +((( 6314 + 6315 +))) 6316 + 6317 +((( 6318 +Пример ответа : 6319 +))) 6320 + 6321 +((( 6322 + 6323 +))) 6324 + 6325 +((( 6326 +200 ~/~/ Success 6327 +))) 6328 +))) 6329 + 6330 + 6331 + 6332 + 6333 + 6334 + 5930 5930 (% class="box" lang="en-US" style="text-align: center;" %) 5931 5931 ((( 5932 5932 (% 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]] **