Изменения документа Дополнительные API методы

Редактировал(а) Павел Субботин 2025/12/09 14:16

От версии < 7.1 >

отредактировано Павел Субботин
на 2025/12/09 14:16

К версии < 4.1 >

отредактировано Андрей Калиновский
на 2025/08/25 16:28

Изменить комментарий: К данной версии нет комментариев

Необработанный
Обработанный

Комментарий

Свойства страницы (2 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Автор документа

@@ -1,1 +1,1 @@
--XWiki.subbotinpa
++XWiki.Gadmin

Содержимое

@@ -6,7 +6,7 @@
  == Управление подразделениями ==
--=== Поиск подразделения ===
++=== Поиск подразделения  ===
  (% class="box infomessage" %)
  (((
@@ -36,7 +36,7 @@
    }
--=== Добавление подразделения ===
++=== Добавление подразделения  ===
  (% class="box successmessage" %)
  (((
@@ -69,7 +69,7 @@
  }
--=== Редактирование подразделения ===
++=== Редактирование подразделения  ===
  (% class="box errormessage" %)
  (((
@@ -101,7 +101,7 @@
--=== Удаление подразделения ===
++=== Удаление подразделения  ===
  (% class="box errormessage" %)
  (((
@@ -118,374 +118,3 @@
  == Управление группами ==
--
--
--=== Получить информацию группы по идентификатору группы ===
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/VehiclesGroups/{groupId}**
--)))
--
--groupId - Идентификатор группы
--
--
--Пример ответа:
--
--{
--  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
--  "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
--  "Name": "string", ~/~/ Наименование группы
--  "VehiclesIds": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
--  ],
--  "ModelsIds": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
--  ],
--  "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
--}
--
--
--=== Удалить группу ===
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/VehiclesGroups/{groupId}**
--)))
--
--groupId - Идентификатор группы
--
--
--Пример ответа:
--
--200 ~/~/ Success
--
--
--
--=== Получить информацию группы по идентификатору клиента ===
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/VehiclesGroups/list/{agentId}**
--)))
--
--agentId - Идентификатор клиента
--
--
--Пример ответа:
--
--[
--  {
--    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
--    "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
--    "Name": "string", ~/~/ Наименование группы.
--    "VehiclesIds": [
--      "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
--    ],
--    "ModelsIds": [
--      "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
--    ],
--    "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
--  }
--]
--
--
--=== Создать группу ===
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/VehiclesGroups**
--)))
--
--Пример запроса:
--{
--  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
--  "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
--  "Name": "string", ~/~/ Наименование группы.
--  "VehiclesIds": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
--  ],
--  "ModelsIds": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
--  ],
--  "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
--}
--
--
--Пример ответа:
--
--{
--  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
--  "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
--  "Name": "string", ~/~/ Наименование группы.
--  "VehiclesIds": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
--  ],
--  "ModelsIds": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
--  ],
--  "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
--}
--
--
--=== Изменить группу ===
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/VehiclesGroups**
--)))
--
--Пример запроса:
--
--{
--  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
--  "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
--  "Name": "string", ~/~/ Наименование группы.
--  "VehiclesIds": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
--  ],
--  "ModelsIds": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
--  ],
--  "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
--}
--
--
--Пример ответа:
--
--{
--  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
--  "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
--  "Name": "string", ~/~/ Наименование группы.
--  "VehiclesIds": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
--  ],
--  "ModelsIds": [
--    "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
--  ],
--  "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
--}
--
--
--= **Раздел: Яндекс Маршруты** =
--
--
--== **Возвращение списка маршрутов** ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/TransportRoutes**
--)))
--
--Пример запроса:
--Id  ~/~/ Идентификатор поля
--
--Пример ответа:
--
--[
--  {
--    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id
--    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
--    "name": "string", ~/~/ Наименование маршрута.
--    "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
--    "vehicles": [  ~/~/ Определяет список ТС для маршрута
--      0
--    ]
--  }
--]
--
--
--== **Добавить маршрут** ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/TransportRoutes**
--)))
--
--Пример запроса:
--{
--  "name": "string",  ~/~/  Опредлеляет наименование маршрута.
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
--  "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
--  "vehicles": [  ~/~/ Определяет список ТС для маршрута
--    0
--  ]
--}
--
--
--Пример ответа:
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
--  "name": "string", ~/~/ Определяет наименование маршрута
--  "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
--  "vehicles": [ ~/~/ Определяет список ТС для маршрута
--    0
--  ]
--}
--
--
--== **Обновление маршрута** ==
--
--(% class="box warningmessage" %)
--(((
--**PUT /api/v3/TransportRoutes**
--)))
--
--Пример запроса:
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
--  "name": "string", ~/~/ Опредлеляет наименование маршрута.
--  "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
--  "vehicles": [ ~/~/ Определяет список ТС для маршрута
--    0
--  ]
--}
--
--Пример ответа:
--
--{
--  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
--  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
--  "name": "string", ~/~/ Определяет наименование маршрута
--  "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
--  "vehicles": [ ~/~/ Определяет список ТС для маршрута
--    0
--  ]
--}
--
--
--== **Получить связки маршрутов ТС** ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/TransportRoutes/getroutesvehicles**
--)))
--
--Пример запроса:
--
--[
--  "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
--]
--
--Пример ответа:
--
--[
--  {
--    "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
--    "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
--  }
--]
--
--
--== **Удалить маршрут** ==
--
--(% class="box errormessage" %)
--(((
--**DELETE /api/v3/TransportRoutes/{id}**
--)))
--
--Пример запроса:
--Id  ~/~/ Идентификатор поля
--
--
--= **Раздел: Управление доступа к машинам** =
--
--
--== Получение списка транспортных средств видимых пользователю ==
--
--(% class="box infomessage" %)
--(((
--**GET /api/v3/UserVisibleVehicles/{userId}**
--)))
--
--Пример ответа:
--
--{
--  "vehicleIds": [  ~/~/ Идентификаторы ТС
--    0
--  ]
--}
--
--
--== Задает видимость транспортных средств пользователю ==
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/UserVisibleVehicles**
--)))
--
--Пример запроса:
--
--{
--  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
--  "vehicleIds": [ ~/~/ Идентификаторы ТС
--    0
--  ]
--}
--
--
--Пример ответа :
--
--
--200 ~/~/ Success
--
--
--
--== Фотомониторинг  ==
--
--
--=== Получение списка фотографий  ===
--
--(% class="box successmessage" %)
--(((
--**POST /api/v3/DevicePhoto/getByPeriod**
--)))
--
--Пример запроса:
--
--(((
--{
--  "vehicleId": 0, ~/~/ ID ТС, для которого запрашиваются данные
--  "from": "2025-12-09T11:01:12.441Z", ~/~/ Дата и время начала периода
--  "to": "2025-12-09T11:01:12.441Z" ~/~/ Дата и время окончания периода
--}
--)))
--
--
--Пример ответа:
--
--(((
--[
--  {
--    "vehicleId": 0, ~/~/ ID ТС
--    "creationTime": "2025-12-09T11:01:12.472Z", ~/~/ Дата и время создания файла.
--    "name": "string", ~/~/ Наименование файла
--    "fileUrl": "string", ~/~/ URL адреса файла изображения.
--    "latitude": 0, ~/~/ Широта
--    "longitude": 0 ~/~/ Долгота
--  }
--]
--)))
--
--
--
--
--
--
--
--
--
--
--
--
--
--
--
--
--
--
--

Изменения документа Дополнительные API методы

Комментарий

Подробности

Меню