Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/05/06 12:41
<
>
edited by Андрей Калиновский
on 2025/04/21 13:43
on 2025/04/21 13:43
edited by Андрей Калиновский
on 2025/05/06 12:38
on 2025/05/06 12:38
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -1628,81 +1628,10 @@ 1628 1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1629 1629 1630 1630 1631 -= =**ИмпортироватьисториюТС(Асинхронныйзапрос)**==1631 +(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами** 1632 1632 1633 -(% class="box successmessage" %) 1634 -((( 1635 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1636 -))) 1637 - 1638 -Метод запроса: **POST** 1639 - 1640 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1641 - 1642 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1643 - 1644 - 1645 -Ответ: 1646 - 1647 -{ 1648 - 1649 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1650 - 1651 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1652 - 1653 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1654 - 1655 - "Message": "string", ~/~/ Информация о выполнении запроса 1656 - 1657 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1658 - 1659 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1660 - 1661 - "Data": "string" ~/~/ Данные 1662 - 1663 -} 1664 - 1665 - 1666 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1667 - 1668 1668 (% class="box infomessage" %) 1669 1669 ((( 1670 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1671 -))) 1672 - 1673 -Метод запроса: **GET** 1674 - 1675 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1676 - 1677 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1678 - 1679 - 1680 -Ответ: 1681 - 1682 -{ 1683 - 1684 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1685 - 1686 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1687 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1688 - 1689 - "Message": "string", ~/~/ Информация о выполнении запроса 1690 - 1691 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1692 - 1693 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1694 - 1695 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1696 - 1697 - "Data": "string" ~/~/ Данные 1698 - 1699 -} 1700 - 1701 - 1702 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1703 - 1704 -(% class="box infomessage" %) 1705 -((( 1706 1706 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1707 1707 ))) 1708 1708 ... ... @@ -1844,7 +1844,6 @@ 1844 1844 "stage": "", ~/~/ Состояние 1845 1845 (% style="color:#000000" %) } 1846 1846 1847 -== == 1848 1848 1849 1849 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1850 1850 ... ... @@ -2806,6 +2806,35 @@ 2806 2806 } 2807 2807 ] 2808 2808 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 + 2809 2809 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2810 2810 2811 2811 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -4290,6 +4290,45 @@ 4290 4290 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4291 4291 |msgCount|Кол-во обработанных сообщений всего 4292 4292 4250 +== == 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 + 4293 4293 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4294 4294 4295 4295 (% class="box infomessage" %) ... ... @@ -4307,10 +4307,59 @@ 4307 4307 "message": "string" 4308 4308 } 4309 4309 4310 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4311 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4312 -|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 +))) 4313 4313 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 + 4314 4314 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4315 4315 4316 4316 (% class="box infomessage" %) ... ... @@ -4822,8 +4822,51 @@ 4822 4822 } 4823 4823 ] 4824 4824 } 4870 + 4871 + 4872 +== **Превышение скорости** == 4873 + 4874 +(% class="box infomessage" %) 4875 +((( 4876 +**POST /api/v3/Reports/overSpeedDuration** 4825 4825 ))) 4826 4826 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 + 4827 4827 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4828 4828 4829 4829 ... ... @@ -6092,10 +6092,10 @@ 6092 6092 6093 6093 ==== ==== 6094 6094 6095 -= ===**Раздел: Управление доступа к машинам** ====6183 += **Раздел: Управление доступа к машинам** = 6096 6096 6097 6097 6098 -== Получение списка ID==6186 +== Получение списка транспортных средств видимых пользователю == 6099 6099 6100 6100 (% class="box infomessage" %) 6101 6101 ((( ... ... @@ -6102,15 +6102,63 @@ 6102 6102 **GET /api/v3/UserVisibleVehicles/{userId}** 6103 6103 ))) 6104 6104 6193 +Пример ответа: 6105 6105 6195 +((( 6196 +{ 6197 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6198 + 0 6199 + ] 6200 +} 6201 +))) 6106 6106 6107 6107 6108 6108 6205 +== Задает видимость транспортных средств пользователю == 6109 6109 6207 +(% class="box infomessage" %) 6208 +((( 6209 +**POST /api/v3/UserVisibleVehicles** 6210 +))) 6110 6110 6212 +Пример запроса: 6111 6111 6214 +((( 6215 +((( 6216 +{ 6217 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6218 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6219 + 0 6220 + ] 6221 +} 6222 +))) 6112 6112 6224 +((( 6225 + 6226 +))) 6113 6113 6228 +((( 6229 + 6230 +))) 6231 + 6232 +((( 6233 +Пример ответа : 6234 +))) 6235 + 6236 +((( 6237 + 6238 +))) 6239 + 6240 +((( 6241 +200 ~/~/ Success 6242 +))) 6243 +))) 6244 + 6245 + 6246 + 6247 + 6248 + 6249 + 6114 6114 (% class="box" lang="en-US" style="text-align: center;" %) 6115 6115 ((( 6116 6116 (% 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]] **