Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/05/06 12:41
<
>
edited by Андрей Калиновский
on 2025/03/25 14:48
on 2025/03/25 14:48
edited by Андрей Калиновский
on 2025/05/06 11:45
on 2025/05/06 11:45
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -123,29 +123,41 @@ 123 123 Запрос должен содержать данные параметра "**agentId**" 124 124 125 125 (% style="color:#000000" %)Ответ: 126 + 127 +((( 126 126 { 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 - } 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 +))) 148 148 160 + 149 149 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 150 150 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 151 151 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя ... ... @@ -1616,81 +1616,10 @@ 1616 1616 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1617 1617 1618 1618 1619 -= =**ИмпортироватьисториюТС(Асинхронныйзапрос)**==1631 +(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами** 1620 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 1656 (% class="box infomessage" %) 1657 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 - 1690 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1691 - 1692 -(% class="box infomessage" %) 1693 -((( 1694 1694 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1695 1695 ))) 1696 1696 ... ... @@ -2794,6 +2794,35 @@ 2794 2794 } 2795 2795 ] 2796 2796 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 + 2797 2797 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2798 2798 2799 2799 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -4278,6 +4278,51 @@ 4278 4278 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4279 4279 |msgCount|Кол-во обработанных сообщений всего 4280 4280 4251 +(% class="wikigeneratedid" %) 4252 +== == 4253 + 4254 +== **Импортировать историю ТС (Асинхронный запрос)** == 4255 + 4256 +(% class="box successmessage" %) 4257 +((( 4258 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4259 +))) 4260 + 4261 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4262 + 4263 +Метод запроса: **POST** 4264 + 4265 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4266 + 4267 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4268 + 4269 + 4270 +Ответ: 4271 + 4272 +{ 4273 + 4274 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4275 + 4276 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4277 + 4278 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4279 + 4280 + "Message": "string", ~/~/ Информация о выполнении запроса 4281 + 4282 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4283 + 4284 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4285 + 4286 + "Data": "string" ~/~/ Данные 4287 + 4288 +} 4289 + 4290 + 4291 +== == 4292 + 4293 +(% class="wikigeneratedid" %) 4294 +== == 4295 + 4281 4281 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4282 4282 4283 4283 (% class="box infomessage" %) ... ... @@ -4299,6 +4299,46 @@ 4299 4299 |activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4300 4300 |progress|Guid ТС 4301 4301 4317 +(% class="wikigeneratedid" %) 4318 +== == 4319 + 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 + 4302 4302 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4303 4303 4304 4304 (% class="box infomessage" %) ... ... @@ -4810,8 +4810,51 @@ 4810 4810 } 4811 4811 ] 4812 4812 } 4868 + 4869 + 4870 +== **Превышение скорости** == 4871 + 4872 +(% class="box infomessage" %) 4873 +((( 4874 +**POST /api/v3/Reports/overSpeedDuration** 4813 4813 ))) 4814 4814 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 + 4815 4815 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4816 4816 4817 4817 ... ... @@ -6078,7 +6078,75 @@ 6078 6078 Id ~/~/ Идентификатор поля 6079 6079 6080 6080 6179 +==== ==== 6081 6081 6181 += **Раздел: Управление доступа к машинам** = 6182 + 6183 + 6184 +== Получение списка транспортных средств видимых пользователю == 6185 + 6186 +(% class="box infomessage" %) 6187 +((( 6188 +**GET /api/v3/UserVisibleVehicles/{userId}** 6189 +))) 6190 + 6191 +Пример ответа: 6192 + 6193 +((( 6194 +{ 6195 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6196 + 0 6197 + ] 6198 +} 6199 +))) 6200 + 6201 + 6202 + 6203 +== Задает видимость транспортных средств пользователю == 6204 + 6205 +(% class="box infomessage" %) 6206 +((( 6207 +**POST /api/v3/UserVisibleVehicles** 6208 +))) 6209 + 6210 +Пример запроса: 6211 + 6212 +((( 6213 +((( 6214 +{ 6215 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6216 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6217 + 0 6218 + ] 6219 +} 6220 +))) 6221 + 6222 +((( 6223 + 6224 +))) 6225 + 6226 +((( 6227 + 6228 +))) 6229 + 6230 +((( 6231 +Пример ответа : 6232 +))) 6233 + 6234 +((( 6235 + 6236 +))) 6237 + 6238 +((( 6239 +200 ~/~/ Success 6240 +))) 6241 +))) 6242 + 6243 + 6244 + 6245 + 6246 + 6247 + 6082 6082 (% class="box" lang="en-US" style="text-align: center;" %) 6083 6083 ((( 6084 6084 (% 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]] **