Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/27 16:12
<
>
edited by Андрей Калиновский
on 2025/05/26 15:47
on 2025/05/26 15:47
edited by Андрей Калиновский
on 2025/03/19 14:01
on 2025/03/19 14:01
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -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" %)Идентификатор клиента-родителя ... ... @@ -877,7 +877,7 @@ 877 877 { 878 878 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 879 879 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 880 - "deleted": false,868 + "deleted": true, 881 881 "extId": "string", 882 882 "name": "string", 883 883 "picture": "string", ... ... @@ -896,7 +896,7 @@ 896 896 { 897 897 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 898 898 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 899 - "deleted": false,887 + "deleted": true, 900 900 "extId": "string", 901 901 "name": "string", 902 902 "picture": "string", ... ... @@ -930,7 +930,7 @@ 930 930 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 931 931 ))) 932 932 933 -(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.921 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 934 934 935 935 (% style="color:#000000" %)Метод запроса: **PUT** 936 936 ... ... @@ -997,7 +997,7 @@ 997 997 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 998 998 ))) 999 999 1000 -(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалитьмодель, указанного в строке запроса.988 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 1001 1001 1002 1002 (% style="color:#000000" %)Метод запроса: **DELETE** 1003 1003 ... ... @@ -1628,6 +1628,77 @@ 1628 1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1629 1629 1630 1630 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 + 1631 1631 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1632 1632 1633 1633 (% class="box infomessage" %) ... ... @@ -1773,6 +1773,7 @@ 1773 1773 "stage": "", ~/~/ Состояние 1774 1774 (% style="color:#000000" %) } 1775 1775 1835 +== == 1776 1776 1777 1777 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1778 1778 ... ... @@ -2455,12 +2455,8 @@ 2455 2455 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2456 2456 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2457 2457 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2458 - "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2459 - "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2460 2460 "fuelConsumption": 0, ~/~/ Расход топлива 2461 2461 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2462 - "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2463 - 2464 2464 } 2465 2465 ] 2466 2466 } ... ... @@ -2506,8 +2506,7 @@ 2506 2506 "model": "string", ~/~/ Модель объекта 2507 2507 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2508 2508 { 2509 - "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 2510 - 2565 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2511 2511 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2512 2512 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2513 2513 "valueFuel": 0, ~/~/ Количество ... ... @@ -2736,35 +2736,6 @@ 2736 2736 } 2737 2737 ] 2738 2738 2739 - 2740 -== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2741 - 2742 -(% class="box successmessage" %) 2743 -((( 2744 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2745 -))) 2746 - 2747 -(% style="color:#000000" %)Метод запроса: **PUT** 2748 - 2749 -Пример запроса: 2750 - 2751 -((( 2752 -{ 2753 - "id": 0, ~/~/ Идентификатор объекта геозоны 2754 - "name": "string", ~/~/ Наименование объекта геозоны 2755 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2756 - "description": "string", ~/~/ Описание объекта геозоны 2757 - "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2758 - "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2759 - "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2760 -} 2761 -))) 2762 - 2763 - 2764 -Пример ответа: 2765 - 2766 -200 ~/~/ Success 2767 - 2768 2768 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2769 2769 2770 2770 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -4249,43 +4249,6 @@ 4249 4249 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4250 4250 |msgCount|Кол-во обработанных сообщений всего 4251 4251 4252 -== **Импортировать историю ТС (Асинхронный запрос)** == 4253 - 4254 -(% class="box successmessage" %) 4255 -((( 4256 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4257 -))) 4258 - 4259 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4260 - 4261 -Метод запроса: **POST** 4262 - 4263 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4264 - 4265 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4266 - 4267 - 4268 -Ответ: 4269 - 4270 -{ 4271 - 4272 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4273 - 4274 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4275 - 4276 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4277 - 4278 - "Message": "string", ~/~/ Информация о выполнении запроса 4279 - 4280 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4281 - 4282 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4283 - 4284 - "Data": "string" ~/~/ Данные 4285 - 4286 -} 4287 - 4288 - 4289 4289 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4290 4290 4291 4291 (% class="box infomessage" %) ... ... @@ -4303,59 +4303,10 @@ 4303 4303 "message": "string" 4304 4304 } 4305 4305 4306 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4307 -**Параметр** 4308 -)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4309 -**Описание** 4310 -))) 4311 -|((( 4312 -activity 4313 -)))|((( 4314 -Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4315 -))) 4316 -|((( 4317 -progress 4318 -)))|((( 4319 -Guid ТС 4320 -))) 4295 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4296 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4297 +|progress|Guid ТС 4321 4321 4322 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 4323 - 4324 -(% class="box infomessage" %) 4325 -((( 4326 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4327 -))) 4328 - 4329 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4330 - 4331 -Метод запроса: **GET** 4332 - 4333 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4334 - 4335 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4336 - 4337 - 4338 -Ответ: 4339 - 4340 -{ 4341 - 4342 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4343 - 4344 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 4345 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4346 - 4347 - "Message": "string", ~/~/ Информация о выполнении запроса 4348 - 4349 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4350 - 4351 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4352 - 4353 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4354 - 4355 - "Data": "string" ~/~/ Данные 4356 - 4357 -} 4358 - 4359 4359 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4360 4360 4361 4361 (% class="box infomessage" %) ... ... @@ -4867,51 +4867,8 @@ 4867 4867 } 4868 4868 ] 4869 4869 } 4870 - 4871 - 4872 -== **Превышение скорости** == 4873 - 4874 -(% class="box infomessage" %) 4875 -((( 4876 -**POST /api/v3/Reports/overSpeedDuration** 4877 4877 ))) 4878 4878 4879 - Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4880 - 4881 -Пример запроса: 4882 - 4883 -((( 4884 -{ 4885 - "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4886 - "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4887 - "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4888 - "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4889 - "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4890 -} 4891 -))) 4892 - 4893 -((( 4894 - 4895 -))) 4896 - 4897 -((( 4898 -Пример ответа: 4899 -))) 4900 - 4901 -((( 4902 -((( 4903 -[ 4904 - { 4905 - "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4906 - "duration": 0, ~/~/ Продолжительность события в секундах 4907 - "maxSpeed": 0, ~/~/ Максимальная скорость 4908 - "speedLimit": 0 ~/~/ Ограничение скорости 4909 - } 4910 -] 4911 -))) 4912 -))) 4913 -))) 4914 - 4915 4915 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4916 4916 4917 4917 ... ... @@ -5916,62 +5916,6 @@ 5916 5916 ))) 5917 5917 5918 5918 5919 -= **Раздел: Роли** = 5920 - 5921 -== **Получение списка клиентских и системных ролей пользователя ** == 5922 - 5923 -(% class="box successmessage" %) 5924 -((( 5925 -**POST /api/v3/groups/find** 5926 -))) 5927 - 5928 -Пример запроса: 5929 - 5930 -((( 5931 -{ 5932 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 5933 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 5934 -} 5935 -))) 5936 - 5937 -((( 5938 - 5939 -))) 5940 - 5941 -((( 5942 -Пример ответа: 5943 -))) 5944 - 5945 -((( 5946 -((( 5947 -{ 5948 - "groups": [ ~/~/ Системные роли пользователя 5949 - { 5950 - "code": "string", ~/~/ Код роли. 5951 - "name": "string", ~/~/ Имя 5952 - "shortName": "string" ~/~/ Короткое имя 5953 - } 5954 - ], 5955 - "customGroups": [ ~/~/ Системные роли пользователя 5956 - { 5957 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 5958 - "name": "string", ~/~/ Наименование 5959 - "shortName": "string", ~/~/ Короткое наименование 5960 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 5961 - } 5962 - ] 5963 -} 5964 -))) 5965 -))) 5966 - 5967 -((( 5968 - 5969 -))) 5970 - 5971 -((( 5972 - 5973 -))) 5974 - 5975 5975 = **Раздел: Локатор ** = 5976 5976 5977 5977 ... ... @@ -5979,7 +5979,7 @@ 5979 5979 5980 5980 (% class="box infomessage" %) 5981 5981 ((( 5982 -**GET /api/v3/locators 5823 +**GET /api/v3/locators** 5983 5983 ))) 5984 5984 5985 5985 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5988,83 +5988,33 @@ 5988 5988 Пример ответа: 5989 5989 5990 5990 ((( 5991 -((( 5992 -{ 5993 - "vehiclesIds": [ ~/~/ Объекты 5994 - 0 5995 - ], 5996 - "geoIds": [ ~/~/ Геозоны 5997 - 0 5998 - ], 5999 - "fieldsIds": [ ~/~/ Поля 6000 - 0 6001 - ], 6002 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6003 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6004 - "agentName": "string", ~/~/ Наименование агента. 6005 - "isEnabled": true, ~/~/ Активность 6006 - "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6007 - "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6008 - "name": "string", ~/~/ Наименование. 6009 - "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6010 - "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6011 - "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6012 - "validity": 0, ~/~/ Значение срока действия 6013 - "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6014 - "autoProlongation": true, ~/~/ Автопродление срока действия. 6015 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6016 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6017 - "url": "string", ~/~/ Ссылка 6018 - "language": 0, ~/~/ Язык 6019 - "showVehicleName": true, ~/~/ Наименование объекта 6020 - "showVehicleDirection": true, ~/~/ Направление движения на треке 6021 - "allowTrackReport": true, ~/~/ Трек 6022 - "showTrackTracing": true, ~/~/ Трассировка трека 6023 - "showSensors": true, ~/~/ Датчик 6024 - "availableMapLayers": [ ~/~/ Слои на карте 6025 - 0 6026 - ] 6027 -} 6028 -))) 6029 -))) 6030 - 6031 - 6032 -== **Получение перечня моделей ** == 6033 - 6034 -(% class="box successmessage" %) 6035 -((( 6036 -**POST /api/v3/models/find** 6037 -))) 6038 - 6039 -Пример запроса: 6040 - 6041 -((( 6042 -((( 6043 -{ 6044 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6045 - "name": "string", ~/~/ Наименование локатора 6046 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6047 -))) 6048 - 6049 - 6050 - 6051 - Пример ответа: 6052 - 6053 - 6054 -((( 6055 6055 [ 6056 6056 { 6057 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6058 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6059 - "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6060 - "name": "string", ~/~/ Наименование локатора 6061 - "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 5834 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5835 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5836 + "agentName": "string", ~/~/ Наименование агента. 5837 + "isEnabled": true, ~/~/ Активен 5838 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5839 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5840 + "name": "string", ~/~/ Наименование 5841 + "status": 0, ~/~/ 5842 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5843 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5844 + "validity": 0, ~/~/ Срок действия в днях (1-90). 5845 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5846 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5847 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5848 + "url": "string", ~/~/ Ссылка 5849 + "language": 0, ~/~/ Язык. 5850 + "vehiclesCount": 0, ~/~/ Количество объектов. 5851 + "geozonesCount": 0, ~/~/ Количество геозон. 5852 + "fieldsCount": 0 ~/~/ Количество полей. 6062 6062 } 6063 6063 ] 6064 6064 ))) 6065 -))) 6066 6066 6067 6067 5858 + 6068 6068 == **Создание локатора** == 6069 6069 6070 6070 (% class="box successmessage" %) ... ... @@ -6085,24 +6085,6 @@ 6085 6085 "autoProlongation": true, ~/~/ Автопродление срока действия. 6086 6086 "url": "string", ~/~/ Ссылка 6087 6087 "language": 0 ~/~/ Язык 6088 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6089 - "vehiclesIds": [ ~/~/ Oбъекты 6090 - 0 6091 - ], 6092 - "geoIds": [ ~/~/ Геозоны 6093 - 0 6094 - ], 6095 - "fieldsIds": [ ~/~/ Поля 6096 - 0 6097 - ], 6098 - "showVehicleName": true, ~/~/ Наименование объекта 6099 - "showVehicleDirection": true, ~/~/ Направление движения на треке 6100 - "allowTrackReport": true, ~/~/ Трек 6101 - "showTrackTracing": true, ~/~/ Трассировка трека 6102 - "showSensors": true, ~/~/ Датчик 6103 - "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6104 - 0 6105 - ] 6106 6106 } 6107 6107 ))) 6108 6108 ... ... @@ -6135,29 +6135,10 @@ 6135 6135 "autoProlongation": true, ~/~/ Автопродление срока действия 6136 6136 "url": "string", ~/~/ Ссылка 6137 6137 "language": 0 ~/~/ Язык 6138 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6139 - "vehiclesIds": [ ~/~/ Oбъекты 6140 - 0 6141 - ], 6142 - "geoIds": [ ~/~/ Геозоны 6143 - 0 6144 - ], 6145 - "fieldsIds": [ ~/~/ Поля 6146 - 0 6147 - ], 6148 - "showVehicleName": true, ~/~/ Наименование объекта 6149 - "showVehicleDirection": true, ~/~/ Направление движения на треке 6150 - "allowTrackReport": true, ~/~/ Трек 6151 - "showTrackTracing": true, ~/~/ Трассировка трека 6152 - "showSensors": true, ~/~/ Датчик 6153 - "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6154 - 0 6155 - ] 6156 6156 } 6157 - 6158 - 6159 6159 ))) 6160 6160 5914 + 6161 6161 Пример ответа: 6162 6162 6163 6163 200 ~/~/ Success ... ... @@ -6180,215 +6180,7 @@ 6180 6180 6181 6181 6182 6182 6183 -= **Раздел: Яндекс Маршруты** = 6184 6184 6185 - 6186 -== **Возвращение списка маршрутов** == 6187 - 6188 -(% class="box infomessage" %) 6189 -((( 6190 -**GET /api/v3/TransportRoutes** 6191 -))) 6192 - 6193 -Пример запроса: 6194 -Id ~/~/ Идентификатор поля 6195 - 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 -(% class="box infomessage" %) 6218 -((( 6219 -**POST /api/v3/TransportRoutes** 6220 -))) 6221 - 6222 -Пример запроса: 6223 -{ 6224 - "name": "string", ~/~/ Опредлеляет наименование маршрута. 6225 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6226 - "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6227 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6228 - 0 6229 - ] 6230 -} 6231 - 6232 - 6233 -Пример ответа: 6234 - 6235 -((( 6236 -{ 6237 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6238 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6239 - "name": "string", ~/~/ Определяет наименование маршрута 6240 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6241 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6242 - 0 6243 - ] 6244 -} 6245 -))) 6246 - 6247 - 6248 -== **Обновление маршрута** == 6249 - 6250 -(% class="box successmessage" %) 6251 -((( 6252 -**PUT /api/v3/TransportRoutes** 6253 -))) 6254 - 6255 -Пример запроса: 6256 - 6257 -((( 6258 -{ 6259 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6260 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6261 - "name": "string", ~/~/ Опредлеляет наименование маршрута. 6262 - "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6263 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6264 - 0 6265 - ] 6266 -} 6267 -))) 6268 - 6269 - 6270 -Пример ответа: 6271 - 6272 -((( 6273 -{ 6274 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6275 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6276 - "name": "string", ~/~/ Определяет наименование маршрута 6277 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6278 - "vehicles": [ ~/~/ Определяет список ТС для маршрута 6279 - 0 6280 - ] 6281 -} 6282 -))) 6283 - 6284 - 6285 -== **Получить связки маршрутов ТС** == 6286 - 6287 -(% class="box infomessage" %) 6288 -((( 6289 -**POST /api/v3/TransportRoutes/getroutesvehicles** 6290 -))) 6291 - 6292 -Пример запроса: 6293 - 6294 -((( 6295 -[ 6296 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6297 -] 6298 -))) 6299 - 6300 - 6301 -Пример ответа: 6302 - 6303 -((( 6304 -[ 6305 - { 6306 - "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6307 - "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6308 - } 6309 -] 6310 -))) 6311 - 6312 - 6313 -== **Удалить маршрут** == 6314 - 6315 -(% class="box warningmessage" %) 6316 -((( 6317 -**DELETE /api/v3/TransportRoutes/{id}** 6318 -))) 6319 - 6320 -Пример запроса: 6321 -Id ~/~/ Идентификатор поля 6322 - 6323 - 6324 - 6325 -= **Раздел: Управление доступа к машинам** = 6326 - 6327 - 6328 -== Получение списка транспортных средств видимых пользователю == 6329 - 6330 -(% class="box infomessage" %) 6331 -((( 6332 -**GET /api/v3/UserVisibleVehicles/{userId}** 6333 -))) 6334 - 6335 -Пример ответа: 6336 - 6337 -((( 6338 -{ 6339 - "vehicleIds": [ ~/~/ Идентификаторы ТС 6340 - 0 6341 - ] 6342 -} 6343 -))) 6344 - 6345 - 6346 - 6347 -== Задает видимость транспортных средств пользователю == 6348 - 6349 -(% class="box infomessage" %) 6350 -((( 6351 -**POST /api/v3/UserVisibleVehicles** 6352 -))) 6353 - 6354 -Пример запроса: 6355 - 6356 -((( 6357 -((( 6358 -{ 6359 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6360 - "vehicleIds": [ ~/~/ Идентификаторы ТС 6361 - 0 6362 - ] 6363 -} 6364 -))) 6365 - 6366 -((( 6367 - 6368 -))) 6369 - 6370 -((( 6371 - 6372 -))) 6373 - 6374 -((( 6375 -Пример ответа : 6376 -))) 6377 - 6378 -((( 6379 - 6380 -))) 6381 - 6382 -((( 6383 -200 ~/~/ Success 6384 -))) 6385 -))) 6386 - 6387 - 6388 - 6389 - 6390 - 6391 - 6392 6392 (% class="box" lang="en-US" style="text-align: center;" %) 6393 6393 ((( 6394 6394 (% 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]] **