Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/05/06 12:41
<
>
edited by Андрей Калиновский
on 2025/04/21 14:04
on 2025/04/21 14:04
edited by Андрей Калиновский
on 2025/05/06 12:37
on 2025/05/06 12:37
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -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 ... ... @@ -2806,6 +2806,35 @@ 2806 2806 } 2807 2807 ] 2808 2808 2738 + 2739 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2740 + 2741 +(% class="box successmessage" %) 2742 +((( 2743 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2744 +))) 2745 + 2746 +(% style="color:#000000" %)Метод запроса: **PUT** 2747 + 2748 +Пример запроса: 2749 + 2750 +((( 2751 +{ 2752 + "id": 0, ~/~/ Идентификатор объекта геозоны 2753 + "name": "string", ~/~/ Наименование объекта геозоны 2754 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2755 + "description": "string", ~/~/ Описание объекта геозоны 2756 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2757 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2758 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2759 +} 2760 +))) 2761 + 2762 + 2763 +Пример ответа: 2764 + 2765 +200 ~/~/ Success 2766 + 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 4251 +== == 4252 + 4253 +== **Импортировать историю ТС (Асинхронный запрос)** == 4254 + 4255 +(% class="box successmessage" %) 4256 +((( 4257 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4258 +))) 4259 + 4260 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4261 + 4262 +Метод запроса: **POST** 4263 + 4264 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4265 + 4266 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4267 + 4268 + 4269 +Ответ: 4270 + 4271 +{ 4272 + 4273 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4274 + 4275 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4276 + 4277 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4278 + 4279 + "Message": "string", ~/~/ Информация о выполнении запроса 4280 + 4281 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4282 + 4283 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4284 + 4285 + "Data": "string" ~/~/ Данные 4286 + 4287 +} 4288 + 4289 + 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 ТС 4307 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4308 +**Параметр** 4309 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4310 +**Описание** 4311 +))) 4312 +|((( 4313 +activity 4314 +)))|((( 4315 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4316 +))) 4317 +|((( 4318 +progress 4319 +)))|((( 4320 +Guid ТС 4321 +))) 4313 4313 4323 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4324 + 4325 +(% class="box infomessage" %) 4326 +((( 4327 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4328 +))) 4329 + 4330 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4331 + 4332 +Метод запроса: **GET** 4333 + 4334 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4335 + 4336 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4337 + 4338 + 4339 +Ответ: 4340 + 4341 +{ 4342 + 4343 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4344 + 4345 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4346 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4347 + 4348 + "Message": "string", ~/~/ Информация о выполнении запроса 4349 + 4350 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4351 + 4352 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4353 + 4354 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4355 + 4356 + "Data": "string" ~/~/ Данные 4357 + 4358 +} 4359 + 4314 4314 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4315 4315 4316 4316 (% class="box infomessage" %) ... ... @@ -4841,7 +4841,7 @@ 4841 4841 "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4842 4842 "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4843 4843 "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4844 - "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение ;2-фиксированный;)4890 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4845 4845 } 4846 4846 ))) 4847 4847 ... ... @@ -6135,10 +6135,10 @@ 6135 6135 6136 6136 ==== ==== 6137 6137 6138 -= ===**Раздел: Управление доступа к машинам** ====6184 += **Раздел: Управление доступа к машинам** = 6139 6139 6140 6140 6141 -== Получение списка ID==6187 +== Получение списка транспортных средств видимых пользователю == 6142 6142 6143 6143 (% class="box infomessage" %) 6144 6144 ((( ... ... @@ -6145,15 +6145,63 @@ 6145 6145 **GET /api/v3/UserVisibleVehicles/{userId}** 6146 6146 ))) 6147 6147 6194 +Пример ответа: 6148 6148 6196 +((( 6197 +{ 6198 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6199 + 0 6200 + ] 6201 +} 6202 +))) 6149 6149 6150 6150 6151 6151 6206 +== Задает видимость транспортных средств пользователю == 6152 6152 6208 +(% class="box infomessage" %) 6209 +((( 6210 +**POST /api/v3/UserVisibleVehicles** 6211 +))) 6153 6153 6213 +Пример запроса: 6154 6154 6215 +((( 6216 +((( 6217 +{ 6218 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6219 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6220 + 0 6221 + ] 6222 +} 6223 +))) 6155 6155 6225 +((( 6226 + 6227 +))) 6156 6156 6229 +((( 6230 + 6231 +))) 6232 + 6233 +((( 6234 +Пример ответа : 6235 +))) 6236 + 6237 +((( 6238 + 6239 +))) 6240 + 6241 +((( 6242 +200 ~/~/ Success 6243 +))) 6244 +))) 6245 + 6246 + 6247 + 6248 + 6249 + 6250 + 6157 6157 (% class="box" lang="en-US" style="text-align: center;" %) 6158 6158 ((( 6159 6159 (% 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]] **