Last modified by Андрей Калиновский on 2025/01/14 11:58
<
From version < 192.2 >
edited by Михаил Жучков
on 2024/12/17 09:18
To version < 187.1 >
edited by Андрей Калиновский
on 2024/11/22 14:32
>
Change comment: Откат к версии 182.1

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.SupportZhuchkov
1 +XWiki.Gadmin
Content
... ... @@ -1,17 +1,5 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  (((
3 -(% class="box warningmessage" %)
4 -(((
5 -(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 -просим вас соблюдать несколько простых правил при использовании API-команд:##
7 -)))
8 -
9 -* Формировать не более 3 отчётов одновременно.
10 -* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
11 -
12 -В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13 -
14 -
15 15  **Содержание страницы:**
16 16  )))
17 17  
... ... @@ -1194,15 +1194,13 @@
1194 1194  Команда для отправки на тс.
1195 1195  
1196 1196  {  
1197 -"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1198 -"command": "", ~/~/ Текст отправляемой команды
1199 -"retries": "", ~/~/ Количество попыток отправки на терминал
1200 -"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1185 +"id": "", ~/~/идентификатор произвольного поля
1186 +"command": "", ~/~/ Текст команды
1187 +"retries": "", ~/~/ Количество попыток
1188 +"idTemplate": "" ~/~/ ID шаблона команды
1201 1201  }
1202 1202  
1203 -В ответ получаем cmdid
1204 1204  
1205 -
1206 1206  == **Получить ответ на отправленную на ТС команду** ==
1207 1207  
1208 1208  (% class="box infomessage" %)
... ... @@ -1210,13 +1210,13 @@
1210 1210  (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1211 1211  )))
1212 1212  
1213 -Идентификатор команды: cmdId
1199 +Идентификатор команды: cmdid
1214 1214  
1215 1215  Запрос от терминала на ответ команды
1216 1216  
1217 1217  Пример ответ от терминала:
1218 1218  
1219 -ID= "" ~/~/ идентификатор объекта
1205 +ID= "" ~/~/ идентификатор произвольного поля
1220 1220  Soft="" ~/~/ версия софта
1221 1221  GPS=4 ~/~/ тип трекера
1222 1222  Time=11:05:43 28.06.24 ~/~/ время запроса
... ... @@ -1571,78 +1571,6 @@
1571 1571  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1572 1572  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1573 1573  
1574 -
1575 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1576 -
1577 -(% class="box successmessage" %)
1578 -(((
1579 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1580 -)))
1581 -
1582 -Метод запроса: **POST**
1583 -
1584 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1585 -
1586 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1587 -
1588 -
1589 -Ответ:
1590 -
1591 -{
1592 -
1593 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1594 -
1595 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1596 -
1597 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1598 -
1599 - "Message": "string", ~/~/ Информация о выполнении запроса
1600 -
1601 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1602 -
1603 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1604 -
1605 - "Data": "string" ~/~/ Данные
1606 -
1607 -}
1608 -
1609 -
1610 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1611 -
1612 -(% class="box infomessage" %)
1613 -(((
1614 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1615 -)))
1616 -
1617 -Метод запроса: **GET**
1618 -
1619 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1620 -
1621 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1622 -
1623 -
1624 -Ответ:
1625 -
1626 -{
1627 -
1628 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1629 -
1630 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1631 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1632 -
1633 - "Message": "string", ~/~/ Информация о выполнении запроса
1634 -
1635 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1636 -
1637 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1638 -
1639 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1640 -
1641 - "Data": "string" ~/~/ Данные
1642 -
1643 -}
1644 -
1645 -
1646 1646  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1647 1647  
1648 1648  (% class="box infomessage" %)
... ... @@ -4394,31 +4394,31 @@
4394 4394  Параметры в теле запроса (JSON):
4395 4395  
4396 4396  {
4397 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4398 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4311 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4312 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4399 4399   "ids": [ 
4400 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4314 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4401 4401   ],
4402 - "timezone": 0 ~/~/ Часовой пояс
4316 + "timezone": 0 ~/~/Таймзона
4403 4403  }
4404 4404  
4405 4405  
4406 4406  Ответ:
4407 4407   {
4408 - "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4409 - "driver": "string", ~/~/ Водители, привязанные к ТК
4410 - "object": "string", ~/~/ Наименование ТС
4411 - "amount": 0, ~/~/ Количество топлива
4412 - "amountDut": 0, ~/~/ Количество по ДУТ
4413 - "amountDiff": 0, ~/~/ Разница, л
4414 - "amountDiffPerc": 0, ~/~/ Разница, %
4415 - "summa": 0, ~/~/ Стоимость, руб
4416 - "serviceName": "string", ~/~/ Тип топлива
4417 - "price": 0, ~/~/ Цена за литр, руб
4418 - "cardName": "string", ~/~/ Наименование ТК
4419 - "cardNum": "string", ~/~/ Номер ТК
4420 - "operator": "string", ~/~/ Оператор ТК
4421 - "address": "string" ~/~/ Адрес АЗС
4322 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4323 + "driver": "string", ~/~/Водители, привязанные к ТК
4324 + "object": "string", ~/~/Наименование ТС
4325 + "amount": 0, ~/~/Количество топлива
4326 + "amountDut": 0, ~/~/Количество по ДУТ
4327 + "amountDiff": 0, ~/~/Разница, л
4328 + "amountDiffPerc": 0, ~/~/Разница, %
4329 + "summa": 0, ~/~/Стоимость, руб
4330 + "serviceName": "string", ~/~/Тип топлива
4331 + "price": 0, ~/~/Цена за литр, руб
4332 + "cardName": "string", ~/~/Наименование ТК
4333 + "cardNum": "string", ~/~/Номер ТК
4334 + "operator": "string", ~/~/Оператор ТК
4335 + "address": "string" ~/~/Адрес АЗС
4422 4422   }
4423 4423  
4424 4424  
... ... @@ -4432,28 +4432,28 @@
4432 4432  **GET ** **/api/v3/retranslations/{id}**
4433 4433  )))
4434 4434  
4435 -id - Идентификатор ретранслятора
4349 +Идентификатор запроса: ID
4436 4436  
4437 4437  
4438 4438  Пример ответа:
4439 4439  
4440 4440  {  
4441 -"description": "", ~/~/ Поле описания ретранслятора
4442 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4443 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4444 -"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4445 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4446 -"objects": [ ~/~/ Объекты для ретрансляции
4355 +"description": "", ~/~/ Определяет описание
4356 +"subscriberId": "", ~/~/ Подписчик
4357 +"protocolType": 0, ~/~/ Тип протокола
4358 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4359 +"address": "string", ~/~/ Адрес события
4360 +"objects": [ ~/~/Объекты для ретрансляции
4447 4447  {      
4448 4448  "id": "",  ~/~/ Идентификатор объекта ретрансляции
4449 4449  "name": "", ~/~/ Наименование объекта ретрансляции
4450 -"imei": "", ~/~/ IMEI объекта  ретрансляции
4451 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4364 +"imei": "", ~/~/ IMEI объекта  
4365 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4452 4452  }
4453 4453   ],  
4454 -"id": "", ~/~/ Идентификатор ретранслятора 
4455 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4456 -"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4368 +"id": "", ~/~/ идентификатор пользователя   
4369 +"parentId": "", ~/~/Guid родителя
4370 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4457 4457  }
4458 4458  
4459 4459  
... ... @@ -4464,7 +4464,7 @@
4464 4464  **DELETE** **/api/v3/retranslations/{id}**
4465 4465  )))
4466 4466  
4467 -id - Идентификатор ретранслятора
4381 +Параметр запроса: ID
4468 4468  
4469 4469  
4470 4470  == **Создание ретранслятора** ==
... ... @@ -4477,16 +4477,16 @@
4477 4477  Запрос:
4478 4478  
4479 4479  {  
4480 -"description": "", ~/~/ Поле описания ретранслятора
4481 -"subscriberId": "", ~/~/ Идентификатор подписчика
4482 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4483 -"address": "", ~/~/ Адрес и порт принимающего сервера
4484 -"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4394 +"description": "", ~/~/ Описание
4395 +"subscriberId": "", ~/~/ Подписчик
4396 +"protocolType": 0, ~/~/ Тип протокола
4397 +"address": "", ~/~/ Адрес ретрансляции
4398 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4485 4485  "objects": [ ~/~/Объекты для ретрансляции
4486 4486  {      
4487 -"id": "", ~/~/ Идентификатор ретранслятора 
4488 -"imei": "", ~/~/ IMEI объекта ретрансляции
4489 -"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4401 +"id": "", ~/~/ идентификатор пользователя     
4402 +"imei": "", ~/~/IMEI объекта
4403 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4490 4490  }
4491 4491   ]
4492 4492  }
... ... @@ -4495,22 +4495,22 @@
4495 4495  Ответ:
4496 4496  
4497 4497  {  
4498 -"description": "", ~/~/ Поле описания ретранслятора
4499 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4500 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4501 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4502 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4503 -"objects": [ ~/~/ Объекты для ретрансляции
4412 +"description": "string", ~/~/ Определяет описание
4413 +"subscriberId": "", ~/~/ идентификатор запроса
4414 +"protocolType": 0, ~/~/ Тип протокола
4415 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4416 +"address": "", ~/~/ Адрес события
4417 +"objects": [ ~/~/Объекты для ретрансляции
4504 4504  {      
4505 -"id": "", ~/~/ Идентификатор объекта ретрансляции     
4506 -"name": "string", ~/~/ Наименование объекта ретрансляции    
4507 -"imei": "", ~/~/ IMEI объекта ретрансляции
4508 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4419 +"id": "", ~/~/ идентификатор пользователя    
4420 +"name": "string", ~/~/ Название уведомления
4421 +"imei": "string", ~/~/IMEI объекта  
4422 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4509 4509  }
4510 - ],
4511 -"id": "", ~/~/ Идентификатор ретранслятора   
4512 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4513 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4424 + ],  
4425 +"id": "", ~/~/ идентификатор пользователя  
4426 +"parentId": "", ~/~/ Guid идентификатор родителя
4427 +"deleted": true ~/~/ Признак удаления
4514 4514  }
4515 4515  
4516 4516  
... ... @@ -4524,18 +4524,18 @@
4524 4524  Пример запроса:
4525 4525  
4526 4526  {  
4527 -"id": "", ~/~/ Идентификатор ретранслятора   
4528 -"description": "string", ~/~/ Поле описания ретранслятора
4529 -"subscriberId": "", ~/~/ Идентификатор подписчика
4530 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4531 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4532 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4533 -"objects": ~/~/ Объекты для ретрансляции
4441 +"id": "", ~/~/ идентификатор пользователя   
4442 +"description": "string", ~/~/ Определяет описание
4443 +"subscriberId": "", ~/~/ идентификатор запроса
4444 +"protocolType": 0, ~/~/ Тип протокола
4445 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4446 +"address": "string", ~/~/ Адрес события
4447 +"objects": ~/~/Объекты для ретрансляции
4534 4534  [    
4535 4535  {      
4536 -"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4537 -"imei": "", ~/~/ IMEI объекта ретрансляции
4538 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4450 +"id": "",  ~/~/ идентификатор пользователя         
4451 +"imei": "", ~/~/IMEI объекта
4452 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4539 4539  }
4540 4540   ]
4541 4541  }
... ... @@ -4544,22 +4544,22 @@
4544 4544  Пример ответа:
4545 4545  
4546 4546  {  
4547 -"description": "", ~/~/ Поле описания ретранслятора
4548 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4549 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4550 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4551 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4552 -"objects": [ ~/~/ Объекты для ретрансляции
4461 +"description": "", ~/~/ Определяет описание
4462 +"subscriberId": "", ~/~/ идентификатор запроса
4463 +"protocolType": 0, ~/~/ Тип протокола
4464 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4465 +"address": "string", ~/~/ Адрес события
4466 +"objects": [ ~/~/Объекты для ретрансляции
4553 4553  {      
4554 -"id": "", ~/~/ Идентификатор объекта ретрансляции     
4555 -"name": "string", ~/~/ Наименование объекта ретрансляции    
4556 -"imei": "", ~/~/ IMEI объекта ретрансляции
4557 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4468 +"id": "", ~/~/ идентификатор пользователя     
4469 +"name": "string", ~/~/ Название уведомления    
4470 +"imei": "", ~/~/IMEI объекта
4471 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4558 4558  }
4559 4559   ],
4560 -"id": "", ~/~/ Идентификатор ретранслятора   
4561 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4562 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4474 +"id": "", ~/~/ идентификатор пользователя   
4475 +"parentId": "", ~/~/ Guid идентификатор родителя
4476 +"deleted": true ~/~/ Признак удаления
4563 4563  }
4564 4564  
4565 4565  
... ... @@ -4573,9 +4573,9 @@
4573 4573  Пример запроса:
4574 4574  
4575 4575  {  
4576 -"id": "", ~/~/ Идентификатор ретранслятора   
4577 -"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4578 -"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (вышестоящего клиента).
4490 +"id": "", ~/~/ идентификатор пользователя   
4491 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4492 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4579 4579  }
4580 4580  
4581 4581  Ответ:
... ... @@ -4582,14 +4582,14 @@
4582 4582  
4583 4583  [ 
4584 4584  {    
4585 -"description": "", ~/~/ Поле описания ретранслятора
4586 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4587 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4588 -"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4589 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4590 -"id": "", ~/~/ Идентификатор ретранслятора   
4591 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4592 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4499 +"description": "", ~/~/ Определяет описание
4500 +"subscriberId": "", ~/~/ идентификатор запроса
4501 +"protocolType": 0, ~/~/ Тип протокола
4502 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4503 +"address": "string", ~/~/ Адрес события
4504 +"id": "", ~/~/ идентификатор пользователя   
4505 +"parentId": "", ~/~/ Guid идентификатор родителя
4506 +"deleted": true ~/~/ Признак удаления
4593 4593  }
4594 4594  ]
4595 4595  

Меню

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