Last modified by Андрей Калиновский on 2025/01/14 11:58
<
From version < 192.1 >
edited by Михаил Жучков
on 2024/12/16 18:00
To version < 181.1 >
edited by Андрей Калиновский
on 2024/11/18 16:39
>
Change comment: There is no comment for this version

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" %)
... ... @@ -1684,12 +1684,9 @@
1684 1684   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1685 1685   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1686 1686   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1687 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1688 - "unitName": "string",  ~/~/ Название подразделения (опционально)
1689 - "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1690 - "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1691 - "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1692 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1601 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
1602 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1603 + "customFields": null ~/~/ значение любого из произвольных полей ТС
1693 1693  }
1694 1694  
1695 1695  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1696,15 +1696,8 @@
1696 1696  
1697 1697  (% style="color:#000000" %)Ответ:
1698 1698  
1699 -(% style="color:#000000" %)[
1700 -{
1701 -
1702 -(((
1703 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1704 -)))
1705 -
1706 -(((
1707 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1610 +(% style="color:#000000" %){
1611 + "vehicleId": "" ~/~/ идентификатор объекта
1708 1708   "name": "" ~/~/ наименование объекта
1709 1709   "imei": "" ~/~/ IMEI объекта
1710 1710   "deviceTypeId": "" ~/~/ идентификатор типа устройства
... ... @@ -1729,21 +1729,9 @@
1729 1729   "forClient": true, ~/~/ право на отображение у клиента
1730 1730   "forTooltip": false, ~/~/ право на отображение в подсказке
1731 1731   "forReport": false ~/~/ право на отображение в отчетах
1732 -)))
1636 + }(%%)
1637 +(% style="color:#000000" %)}
1733 1733  
1734 -(((
1735 - }
1736 - ],
1737 - "vehicleGroups": [  ~/~/ Группы ТС
1738 - {
1739 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1740 - "name": "string" ~/~/ Наименование группы ТС
1741 - }
1742 - ]
1743 - }
1744 -]
1745 -)))
1746 -
1747 1747  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1748 1748  
1749 1749  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -4438,22 +4438,22 @@
4438 4438  Пример ответа:
4439 4439  
4440 4440  {  
4441 -"description": "", ~/~/ Поле описания ретранслятора
4442 -"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4443 -"protocolType": 0, ~/~/ Тип протокола ретрансляции
4444 -"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4445 -"address": "string", ~/~/ Адрес и порт принимающего сервера
4446 -"objects": [ ~/~/ Объекты для ретрансляции
4333 +"description": "", ~/~/ Определяет описание
4334 +"subscriberId": "", ~/~/ Подписчик
4335 +"protocolType": 0, ~/~/ Тип протокола
4336 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4337 +"address": "string", ~/~/ Адрес события
4338 +"objects": [ ~/~/Объекты для ретрансляции
4447 4447  {      
4448 4448  "id": "",  ~/~/ Идентификатор объекта ретрансляции
4449 4449  "name": "", ~/~/ Наименование объекта ретрансляции
4450 -"imei": "", ~/~/ IMEI объекта  ретрансляции
4451 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4342 +"imei": "", ~/~/ IMEI объекта  
4343 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4452 4452  }
4453 4453   ],  
4454 -"id": "", ~/~/ Идентификатор ретранслятора 
4455 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4456 -"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4346 +"id": "", ~/~/ идентификатор пользователя   
4347 +"parentId": "", ~/~/Guid родителя
4348 +"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 - Идентификатор ретранслятора
4359 +Параметр запроса: 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 - отключен
4372 +"description": "", ~/~/ Описание
4373 +"subscriberId": "", ~/~/ Подписчик
4374 +"protocolType": 0, ~/~/ Тип протокола
4375 +"address": "", ~/~/ Адрес ретрансляции
4376 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4485 4485  "objects": [ ~/~/Объекты для ретрансляции
4486 4486  {      
4487 -"id": "", ~/~/ Идентификатор ретранслятора 
4488 -"imei": "", ~/~/ IMEI объекта ретрансляции
4489 -"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4379 +"id": "", ~/~/ идентификатор пользователя     
4380 +"imei": "", ~/~/IMEI объекта
4381 +"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": [ ~/~/ Объекты для ретрансляции
4390 +"description": "string", ~/~/ Определяет описание
4391 +"subscriberId": "", ~/~/ идентификатор запроса
4392 +"protocolType": 0, ~/~/ Тип протокола
4393 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4394 +"address": "", ~/~/ Адрес события
4395 +"objects": [ ~/~/Объекты для ретрансляции
4504 4504  {      
4505 -"id": "", ~/~/ Идентификатор объекта ретрансляции     
4506 -"name": "string", ~/~/ Наименование объекта ретрансляции    
4507 -"imei": "", ~/~/ IMEI объекта ретрансляции
4508 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4397 +"id": "", ~/~/ идентификатор пользователя    
4398 +"name": "string", ~/~/ Название уведомления
4399 +"imei": "string", ~/~/IMEI объекта  
4400 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4509 4509  }
4510 - ],
4511 -"id": "", ~/~/ Идентификатор ретранслятора   
4512 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4513 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4402 + ],  
4403 +"id": "", ~/~/ идентификатор пользователя  
4404 +"parentId": "", ~/~/ Guid идентификатор родителя
4405 +"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": ~/~/ Объекты для ретрансляции
4419 +"id": "", ~/~/ идентификатор пользователя   
4420 +"description": "string", ~/~/ Определяет описание
4421 +"subscriberId": "", ~/~/ идентификатор запроса
4422 +"protocolType": 0, ~/~/ Тип протокола
4423 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4424 +"address": "string", ~/~/ Адрес события
4425 +"objects": ~/~/Объекты для ретрансляции
4534 4534  [    
4535 4535  {      
4536 -"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4537 -"imei": "", ~/~/ IMEI объекта ретрансляции
4538 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4428 +"id": "",  ~/~/ идентификатор пользователя         
4429 +"imei": "", ~/~/IMEI объекта
4430 +"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": [ ~/~/ Объекты для ретрансляции
4439 +"description": "", ~/~/ Определяет описание
4440 +"subscriberId": "", ~/~/ идентификатор запроса
4441 +"protocolType": 0, ~/~/ Тип протокола
4442 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4443 +"address": "string", ~/~/ Адрес события
4444 +"objects": [ ~/~/Объекты для ретрансляции
4553 4553  {      
4554 -"id": "", ~/~/ Идентификатор объекта ретрансляции     
4555 -"name": "string", ~/~/ Наименование объекта ретрансляции    
4556 -"imei": "", ~/~/ IMEI объекта ретрансляции
4557 -"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4446 +"id": "", ~/~/ идентификатор пользователя     
4447 +"name": "string", ~/~/ Название уведомления    
4448 +"imei": "", ~/~/IMEI объекта
4449 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4558 4558  }
4559 4559   ],
4560 -"id": "", ~/~/ Идентификатор ретранслятора   
4561 -"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4562 -"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4452 +"id": "", ~/~/ идентификатор пользователя   
4453 +"parentId": "", ~/~/ Guid идентификатор родителя
4454 +"deleted": true ~/~/ Признак удаления
4563 4563  }
4564 4564  
4565 4565  
... ... @@ -4573,9 +4573,9 @@
4573 4573  Пример запроса:
4574 4574  
4575 4575  {  
4576 -"id": "", ~/~/ Идентификатор ретранслятора   
4468 +"id": "", ~/~/ идентификатор пользователя   
4577 4577  "search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4578 -"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (вышестоящего клиента).
4470 +"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 - не удален
4477 +"description": "", ~/~/ Определяет описание
4478 +"subscriberId": "", ~/~/ идентификатор запроса
4479 +"protocolType": 0, ~/~/ Тип протокола
4480 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4481 +"address": "string", ~/~/ Адрес события
4482 +"id": "", ~/~/ идентификатор пользователя   
4483 +"parentId": "", ~/~/ Guid идентификатор родителя
4484 +"deleted": true ~/~/ Признак удаления
4593 4593  }
4594 4594  ]
4595 4595  

Меню

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