Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/27 16:12
<
>
edited by Андрей Калиновский
on 2025/03/19 13:51
on 2025/03/19 13:51
edited by Андрей Калиновский
on 2025/05/26 15:47
on 2025/05/26 15:47
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -13,12 +13,10 @@ 13 13 14 14 (% class="box infomessage" %) 15 15 ((( 16 -**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в пользовательских настройках. 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 17 17 ))) 18 18 19 -При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 20 - 21 - 22 22 **Содержание страницы:** 23 23 ))) 24 24 ... ... @@ -125,29 +125,41 @@ 125 125 Запрос должен содержать данные параметра "**agentId**" 126 126 127 127 (% style="color:#000000" %)Ответ: 126 + 127 +((( 128 128 { 129 - "agentId": "", (%%) 130 - "parentId": "", 131 - "parentName": "string", 132 - "name": "string", 133 - "fullName": "string", 134 - "agentInfoType": 0, 135 - "isForeign": true/false, 136 - "district": "string", 137 - "region": "string", 138 - "city": "string", 139 - "inn": "string", 140 - "kpp": "string", 141 - "address": "string", 142 - "addressFact": "string", 143 - "email": "string", 144 - "director": "string", 145 - "bankName": "string", 146 - "bankBIK": "string", 147 - "bankRS": "string", 148 - "bankKS": "string" 149 - } 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 +))) 150 150 160 + 151 151 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 152 152 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 153 153 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -867,7 +867,7 @@ 867 867 { 868 868 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 869 869 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 870 - "deleted": true,880 + "deleted": false, 871 871 "extId": "string", 872 872 "name": "string", 873 873 "picture": "string", ... ... @@ -886,7 +886,7 @@ 886 886 { 887 887 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 888 888 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 889 - "deleted": true,899 + "deleted": false, 890 890 "extId": "string", 891 891 "name": "string", 892 892 "picture": "string", ... ... @@ -920,7 +920,7 @@ 920 920 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 921 921 ))) 922 922 923 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.933 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 924 924 925 925 (% style="color:#000000" %)Метод запроса: **PUT** 926 926 ... ... @@ -987,7 +987,7 @@ 987 987 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 988 988 ))) 989 989 990 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1000 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 991 991 992 992 (% style="color:#000000" %)Метод запроса: **DELETE** 993 993 ... ... @@ -1618,77 +1618,6 @@ 1618 1618 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1619 1619 1620 1620 1621 -== **Импортировать историю ТС (Асинхронный запрос)** == 1622 - 1623 -(% class="box successmessage" %) 1624 -((( 1625 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1626 -))) 1627 - 1628 -Метод запроса: **POST** 1629 - 1630 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1631 - 1632 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1633 - 1634 - 1635 -Ответ: 1636 - 1637 -{ 1638 - 1639 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1640 - 1641 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1642 - 1643 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1644 - 1645 - "Message": "string", ~/~/ Информация о выполнении запроса 1646 - 1647 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1648 - 1649 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1650 - 1651 - "Data": "string" ~/~/ Данные 1652 - 1653 -} 1654 - 1655 - 1656 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1657 - 1658 -(% class="box infomessage" %) 1659 -((( 1660 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1661 -))) 1662 - 1663 -Метод запроса: **GET** 1664 - 1665 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1666 - 1667 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1668 - 1669 - 1670 -Ответ: 1671 - 1672 -{ 1673 - 1674 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1675 - 1676 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1677 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1678 - 1679 - "Message": "string", ~/~/ Информация о выполнении запроса 1680 - 1681 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1682 - 1683 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1684 - 1685 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1686 - 1687 - "Data": "string" ~/~/ Данные 1688 - 1689 -} 1690 - 1691 - 1692 1692 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1693 1693 1694 1694 (% class="box infomessage" %) ... ... @@ -1834,7 +1834,6 @@ 1834 1834 "stage": "", ~/~/ Состояние 1835 1835 (% style="color:#000000" %) } 1836 1836 1837 -== == 1838 1838 1839 1839 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1840 1840 ... ... @@ -2517,8 +2517,12 @@ 2517 2517 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2518 2518 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2519 2519 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2458 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2459 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2520 2520 "fuelConsumption": 0, ~/~/ Расход топлива 2521 2521 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2462 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2463 + 2522 2522 } 2523 2523 ] 2524 2524 } ... ... @@ -2564,7 +2564,8 @@ 2564 2564 "model": "string", ~/~/ Модель объекта 2565 2565 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2566 2566 { 2567 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 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 + 2568 2568 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2569 2569 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2570 2570 "valueFuel": 0, ~/~/ Количество ... ... @@ -2793,6 +2793,35 @@ 2793 2793 } 2794 2794 ] 2795 2795 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 + 2796 2796 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2797 2797 2798 2798 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -4277,6 +4277,43 @@ 4277 4277 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4278 4278 |msgCount|Кол-во обработанных сообщений всего 4279 4279 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 + 4280 4280 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4281 4281 4282 4282 (% class="box infomessage" %) ... ... @@ -4294,10 +4294,59 @@ 4294 4294 "message": "string" 4295 4295 } 4296 4296 4297 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4298 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4299 -|progress|Guid ТС 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 +))) 4300 4300 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 + 4301 4301 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4302 4302 4303 4303 (% class="box infomessage" %) ... ... @@ -4809,8 +4809,51 @@ 4809 4809 } 4810 4810 ] 4811 4811 } 4870 + 4871 + 4872 +== **Превышение скорости** == 4873 + 4874 +(% class="box infomessage" %) 4875 +((( 4876 +**POST /api/v3/Reports/overSpeedDuration** 4812 4812 ))) 4813 4813 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 + 4814 4814 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4815 4815 4816 4816 ... ... @@ -5815,6 +5815,62 @@ 5815 5815 ))) 5816 5816 5817 5817 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 + 5818 5818 = **Раздел: Локатор ** = 5819 5819 5820 5820 ... ... @@ -5822,7 +5822,7 @@ 5822 5822 5823 5823 (% class="box infomessage" %) 5824 5824 ((( 5825 -**GET /api/v3/locators** 5982 +**GET /api/v3/locators ** 5826 5826 ))) 5827 5827 5828 5828 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5831,33 +5831,83 @@ 5831 5831 Пример ответа: 5832 5832 5833 5833 ((( 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 +((( 5834 5834 [ 5835 5835 { 5836 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5837 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5838 - "agentName": "string", ~/~/ Наименование агента. 5839 - "isEnabled": true, ~/~/ Активен 5840 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5841 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5842 - "name": "string", ~/~/ Наименование 5843 - "status": 0, ~/~/ 5844 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5845 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5846 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5847 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5848 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5849 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5850 - "url": "string", ~/~/ Ссылка 5851 - "language": 0, ~/~/ Язык. 5852 - "vehiclesCount": 0, ~/~/ Количество объектов. 5853 - "geozonesCount": 0, ~/~/ Количество геозон. 5854 - "fieldsCount": 0 ~/~/ Количество полей. 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 - Машины) 5855 5855 } 5856 5856 ] 5857 5857 ))) 6065 +))) 5858 5858 5859 5859 5860 - 5861 5861 == **Создание локатора** == 5862 5862 5863 5863 (% class="box successmessage" %) ... ... @@ -5878,6 +5878,24 @@ 5878 5878 "autoProlongation": true, ~/~/ Автопродление срока действия. 5879 5879 "url": "string", ~/~/ Ссылка 5880 5880 "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 + ] 5881 5881 } 5882 5882 ))) 5883 5883 ... ... @@ -5910,10 +5910,29 @@ 5910 5910 "autoProlongation": true, ~/~/ Автопродление срока действия 5911 5911 "url": "string", ~/~/ Ссылка 5912 5912 "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 + ] 5913 5913 } 6157 + 6158 + 5914 5914 ))) 5915 5915 5916 - 5917 5917 Пример ответа: 5918 5918 5919 5919 200 ~/~/ Success ... ... @@ -5936,7 +5936,215 @@ 5936 5936 5937 5937 5938 5938 6183 += **Раздел: Яндекс Маршруты** = 5939 5939 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 + 5940 5940 (% class="box" lang="en-US" style="text-align: center;" %) 5941 5941 ((( 5942 5942 (% 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]] **