Last modified by Андрей Калиновский on 2025/01/14 11:58
<
From version < 180.1 >
edited by Андрей Калиновский
on 2024/11/14 16:13
To version < 184.1 >
edited by Андрей Калиновский
on 2024/11/22 13:26
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1,11 +1,9 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  (((
3 -**Содержание страницы:**
3 +**Содержание страницы:**\
4 4  )))
5 5  
6 -{{toc/}}
7 7  
8 -
9 9  = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
10 10  
11 11  (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
... ... @@ -1172,6 +1172,77 @@
1172 1172  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1173 1173  
1174 1174  
1173 +== **Импортировать историю ТС (Асинхронный запрос)** ==
1174 +
1175 +(% class="box successmessage" %)
1176 +(((
1177 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1178 +)))
1179 +
1180 +(% style="color:#000000" %)Метод запроса: **POST**
1181 +
1182 +(% style="color:#000000" %)URL запроса: (%%)**https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1183 +
1184 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор транспортного средства
1185 +
1186 +
1187 +Ответ:
1188 +
1189 +{
1190 +
1191 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1192 +
1193 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1194 +
1195 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1196 +
1197 + "Message": "string", ~/~/ Информация о выполнении запроса
1198 +
1199 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1200 +
1201 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1202 +
1203 + "Data": "string" ~/~/ Данные
1204 +
1205 +}
1206 +
1207 +
1208 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1209 +
1210 +(% class="box infomessage" %)
1211 +(((
1212 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1213 +)))
1214 +
1215 +(% style="color:#000000" %)Метод запроса: **GET**
1216 +
1217 +(% style="color:#000000" %)URL запроса: (%%)https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1218 +
1219 +(% style="color:#000000" %)Параметр запроса: {(%%)**requestId(% style="color:#000000" %)__}__(%%)**(% style="color:#000000" %) - (%%)Уникальный идентификатор запроса
1220 +
1221 +
1222 +Ответ:
1223 +
1224 +{
1225 +
1226 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1227 +
1228 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
1229 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1230 +
1231 + "Message": "string", ~/~/ Информация о выполнении запроса
1232 +
1233 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1234 +
1235 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1236 +
1237 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1238 +
1239 + "Data": "string" ~/~/ Данные
1240 +
1241 +}
1242 +
1243 +
1175 1175  == **Отправить команду на терминал** ==
1176 1176  
1177 1177  (% class="box successmessage" %)
... ... @@ -1598,9 +1598,12 @@
1598 1598   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1599 1599   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1600 1600   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1601 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1602 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1603 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1670 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1671 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1672 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1673 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1674 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1675 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1604 1604  }
1605 1605  
1606 1606  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1607,8 +1607,15 @@
1607 1607  
1608 1608  (% style="color:#000000" %)Ответ:
1609 1609  
1610 -(% style="color:#000000" %){
1611 - "vehicleId": "" ~/~/ идентификатор объекта
1682 +(% style="color:#000000" %)[
1683 +{
1684 +
1685 +(((
1686 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1687 +)))
1688 +
1689 +(((
1690 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1612 1612   "name": "" ~/~/ наименование объекта
1613 1613   "imei": "" ~/~/ IMEI объекта
1614 1614   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1633,9 +1633,21 @@
1633 1633   "forClient": true, ~/~/ право на отображение у клиента
1634 1634   "forTooltip": false, ~/~/ право на отображение в подсказке
1635 1635   "forReport": false ~/~/ право на отображение в отчетах
1636 - }(%%)
1637 -(% style="color:#000000" %)}
1715 +)))
1638 1638  
1717 +(((
1718 + }
1719 + ],
1720 + "vehicleGroups": [  ~/~/ Группы ТС
1721 + {
1722 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1723 + "name": "string" ~/~/ Наименование группы ТС
1724 + }
1725 + ]
1726 + }
1727 +]
1728 +)))
1729 +
1639 1639  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1640 1640  
1641 1641  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -4198,64 +4198,67 @@
4198 4198  Тело запроса:
4199 4199  
4200 4200  {
4201 - "vehicleIds": [vehicleId],
4202 - "from": "2023-11-22T09:29:48.051Z",
4203 - "to": "2023-11-22T09:29:48.051Z"
4292 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4293 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4294 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4204 4204  }
4205 4205  
4206 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4207 -|vehicleIds|Массив ID объектов
4208 -|from|Дата начала запроса
4209 -|to|Дата окончания запроса
4210 -
4211 4211  Ответ:
4212 4212  
4213 4213  {
4214 - "items": [
4300 + "items": [  ~/~/ Список в разрезе ТС
4215 4215   {
4216 - "from": "2023-11-22T09:29:48.052Z",
4217 - "to": "2023-11-22T09:29:48.052Z",
4218 - "vehicleId": 0,
4219 - "vehicleName": "string",
4220 - "vehicleModel": "string",
4221 - "penalty": 0,
4222 - "score": 0,
4223 - "totalViolations": 0,
4224 - "violationsByType": {
4225 - "overspeedingViolations": 0,
4226 - "accelerationViolations": 0,
4227 - "brakingViolations": 0,
4228 - "turningViolations": 0,
4229 - "dangerousDrivingViolations": 0,
4230 - "sensorViolations": 0
4302 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4303 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4304 + "vehicleId": 0, ~/~/ ID ТС
4305 + "vehicleName": "string", ~/~/ Название ТС
4306 + "vehicleModel": "string", ~/~/ Модель ТС
4307 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4308 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4309 + "totalViolations": 0, ~/~/ Нарушений всего
4310 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4311 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4312 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4313 + "brakingViolations": 0, ~/~/ Нарушений торможения
4314 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4315 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4316 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4231 4231   },
4232 - "moveTime": 0,
4233 - "mileage": 0,
4234 - "tripsCount": 0,
4235 - "trips": [
4318 +
4319 +(((
4320 +
4321 +)))
4322 +
4323 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4324 + "mileage": 0, ~/~/ Пробег, м
4325 + "tripsCount": 0, ~/~/ Кол-во рейсов
4326 + "trips": [  ~/~/ Информация по рейсу
4236 4236   {
4237 - "penalty": 0,
4238 - "score": 0,
4239 - "violationsCount": 0,
4240 - "violationsByType": {
4241 - "overspeedingViolations": 0,
4242 - "accelerationViolations": 0,
4243 - "brakingViolations": 0,
4244 - "turningViolations": 0,
4245 - "dangerousDrivingViolations": 0,
4246 - "sensorViolations": 0
4328 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4329 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4330 + "violationsCount": 0, ~/~/ Всего нарушений
4331 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4332 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4333 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4334 + "brakingViolations": 0, ~/~/ Нарушений торможения
4335 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4336 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4337 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4247 4247   },
4248 - "moveTime": 0,
4249 - "mileage": 0,
4250 - "motohours": 0,
4251 - "maxSpeed": 0,
4252 - "startAddress": "string",
4253 - "endAddress": "string",
4254 - "drivers": [
4339 +
4340 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4341 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4342 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4343 + "mileage": 0, ~/~/ Пробег, м
4344 + "motohours": 0, ~/~/ Моточасы, секунды
4345 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4346 + "startAddress": "string", ~/~/ Адрес начала рейса
4347 + "endAddress": "string", ~/~/ Адрес конца рейса
4348 + "drivers": [  ~/~/ Список водителей
4255 4255   {
4256 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4257 - "driverName": "string",
4258 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4350 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4351 + "driverName": "string", ~/~/ФИО водителя
4352 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4259 4259   }
4260 4260   ]
4261 4261   }
... ... @@ -4264,34 +4264,6 @@
4264 4264   ]
4265 4265  }
4266 4266  
4267 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4268 -|from|Дата начала запроса
4269 -|to|Дата  окончания
4270 -|vehicleId|ID объекта
4271 -|vehicleName|Имя объекта
4272 -|vehicleModel|Модель объекта
4273 -|penalty|Сумма штрафных баллов
4274 -|score|Оценка
4275 -|totalViolations|Суммарное количество нарушений
4276 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4277 -|overspeedingViolations|Превышение скорости
4278 -|accelerationViolations|Ускорение
4279 -|brakingViolations|Торможение
4280 -|turningViolations|Резкий поворот
4281 -|dangerousDrivingViolations|Резкое вождение
4282 -|sensorViolations|Нарушение по датчику
4283 -|moveTime|Время в движении
4284 -|mileage|Пробег (км)
4285 -|tripsCount|Количество рейсов
4286 -|motohours|Моточасы
4287 -|maxSpeed|Максимальная скорость
4288 -|startAddress|Адрес начала рейса
4289 -|endAddress|Адрес окончания рейса
4290 -|drivers|Список водителей, которые были на объекте в течениии рейса
4291 -|driverGuid|Guid водителя
4292 -|driverName|Имя водителя
4293 -|driverRfid|Номер Карты-метки
4294 -
4295 4295  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4296 4296  
4297 4297  == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==

Меню

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