Last modified by Андрей Калиновский on 2025/06/10 15:42
<
From version < 228.1 >
edited by Андрей Калиновский
on 2025/05/06 12:37
To version < 216.1 >
edited by Андрей Калиновский
on 2025/03/25 14:48
>
Change comment: There is no comment for this version

Summary

Details

Icon 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" %)Идентификатор клиента-родителя
... ... @@ -1628,10 +1628,81 @@
1628 1628  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1629 1629  
1630 1630  
1631 -(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**
1619 +== **Импортировать историю ТС (Асинхронный запрос)** ==
1632 1632  
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 +
1633 1633  (% class="box infomessage" %)
1634 1634  (((
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 +(((
1635 1635  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1636 1636  )))
1637 1637  
... ... @@ -2735,35 +2735,6 @@
2735 2735   }
2736 2736  ]
2737 2737  
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 -
2767 2767  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2768 2768  
2769 2769  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -4248,45 +4248,6 @@
4248 4248  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4249 4249  |msgCount|Кол-во обработанных сообщений всего
4250 4250  
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 -
4290 4290  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4291 4291  
4292 4292  (% class="box infomessage" %)
... ... @@ -4304,60 +4304,10 @@
4304 4304   "message": "string"
4305 4305  }
4306 4306  
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 -)))
4298 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4299 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4300 +|progress|Guid ТС
4322 4322  
4323 -
4324 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4325 -
4326 -(% class="box infomessage" %)
4327 -(((
4328 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4329 -)))
4330 -
4331 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4332 -
4333 -Метод запроса: **GET**
4334 -
4335 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4336 -
4337 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4338 -
4339 -
4340 -Ответ:
4341 -
4342 -{
4343 -
4344 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4345 -
4346 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
4347 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4348 -
4349 - "Message": "string", ~/~/ Информация о выполнении запроса
4350 -
4351 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4352 -
4353 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4354 -
4355 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4356 -
4357 - "Data": "string" ~/~/ Данные
4358 -
4359 -}
4360 -
4361 4361  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4362 4362  
4363 4363  (% class="box infomessage" %)
... ... @@ -4869,51 +4869,8 @@
4869 4869   }
4870 4870   ]
4871 4871  }
4872 -
4873 -
4874 -== **Превышение скорости** ==
4875 -
4876 -(% class="box infomessage" %)
4877 -(((
4878 -**POST /api/v3/Reports/overSpeedDuration**
4879 4879  )))
4880 4880  
4881 - Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4882 -
4883 -Пример запроса:
4884 -
4885 -(((
4886 -{
4887 - "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4888 - "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4889 - "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4890 - "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4891 - "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4892 -}
4893 -)))
4894 -
4895 -(((
4896 -
4897 -)))
4898 -
4899 -(((
4900 -Пример ответа:
4901 -)))
4902 -
4903 -(((
4904 -(((
4905 -[
4906 - {
4907 - "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4908 - "duration": 0, ~/~/ Продолжительность события в секундах 
4909 - "maxSpeed": 0, ~/~/ Максимальная скорость 
4910 - "speedLimit": 0 ~/~/ Ограничение скорости 
4911 - }
4912 -]
4913 -)))
4914 -)))
4915 -)))
4916 -
4917 4917  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4918 4918  
4919 4919  
... ... @@ -6180,75 +6180,7 @@
6180 6180  Id  ~/~/ Идентификатор поля
6181 6181  
6182 6182  
6183 -==== ====
6184 6184  
6185 -= **Раздел: Управление доступа к машинам** =
6186 -
6187 -
6188 -== Получение списка транспортных средств видимых пользователю ==
6189 -
6190 -(% class="box infomessage" %)
6191 -(((
6192 -**GET /api/v3/UserVisibleVehicles/{userId}**
6193 -)))
6194 -
6195 -Пример ответа:
6196 -
6197 -(((
6198 -{
6199 - "vehicleIds": [  ~/~/ Идентификаторы ТС
6200 - 0
6201 - ]
6202 -}
6203 -)))
6204 -
6205 -
6206 -
6207 -== Задает видимость транспортных средств пользователю ==
6208 -
6209 -(% class="box infomessage" %)
6210 -(((
6211 -**POST /api/v3/UserVisibleVehicles**
6212 -)))
6213 -
6214 -Пример запроса:
6215 -
6216 -(((
6217 -(((
6218 -{
6219 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6220 - "vehicleIds": [ ~/~/ Идентификаторы ТС
6221 - 0
6222 - ]
6223 -}
6224 -)))
6225 -
6226 -(((
6227 -
6228 -)))
6229 -
6230 -(((
6231 -
6232 -)))
6233 -
6234 -(((
6235 -Пример ответа :
6236 -)))
6237 -
6238 -(((
6239 -
6240 -)))
6241 -
6242 -(((
6243 -200 ~/~/ Success
6244 -)))
6245 -)))
6246 -
6247 -
6248 -
6249 -
6250 -
6251 -
6252 6252  (% class="box" lang="en-US" style="text-align: center;" %)
6253 6253  (((
6254 6254  (% 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]] **

Меню

ГЛОНАССSoft wiki - 2024 г.