Методы API для работы с ГЛОНАССSoft - Дополнительные API запросы 

Page / - Изменено Андрей Калиновский в 2025/08/25 09:39 

Дополнительные API запросы 
Изменено Андрей Калиновский
в 2025/08/25 09:39

Оглавление
Управление подразделениями
Поиск подразделения
Добавление подразделения
Редактирование подразделения
Удаление подразделения
Управление группами
Получить информацию группы по идентификатору группы
Удалить группу
Получить информацию группы по идентификатору клиента
Создать группу
Изменить группу
Раздел: Яндекс Маршруты
Возвращение списка маршрутов
Добавить маршрут
Обновление маршрута
Получить связки маршрутов ТС
Удалить маршрут
Раздел: Управление доступа к машинам
Получение списка транспортных средств видимых пользователю
Задает видимость транспортных средств пользователю
Фотомониторинг
Получение списка фотографий

< Основная страница с API запросами 
•	Управление подразделениями
•	Поиск подразделения
•	Добавление подразделения
•	Редактирование подразделения
•	Удаление подразделения
•	Управление группами
•	Получить информацию группы по идентификатору группы
•	Удалить группу
•	Получить информацию группы по идентификатору клиента
•	Создать группу
•	Изменить группу
•	Раздел: Яндекс Маршруты
•	Возвращение списка маршрутов
•	Добавить маршрут
•	Обновление маршрута
•	Получить связки маршрутов ТС
•	Удалить маршрут
•	Раздел: Управление доступа к машинам
•	Получение списка транспортных средств видимых пользователю
•	Задает видимость транспортных средств пользователю
•	Фотомониторинг
•	Получение списка фотографий
Управление подразделениями
Поиск подразделения
POST /api/v3/Units/find 
Пример запроса: 
 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID подразделения 
  "name": "string", // Наименование подразделения 
  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификатор клиента-родителя
}
Пример ответа:
[
  {
    "name": "string", // Наименование подразделения 
    "description": "string", // Дополнительное описание
    "color": "string", // Цвет 
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID подразделения 
    "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор клиента-родителя
    "deleted": true // Признак удаления 
  }
Добавление подразделения
POST /api/v3/Units
Пример запроса:
 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID
  "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid владельца
  "name": "string", // Наименование
  "description": "string", // Дополнительное описание
  "color": "string", // Цвет
  "extId": "string" // extId
}
Пример ответа: 
{
  "name": "string", // Наименование
  "description": "string", // Дополнительное описание
  "color": "string", // Цвет
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID подразделения 
  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
  "deleted": true // Признак удаления 
}
Редактирование подразделения
PUT /api/v3/Units
Пример запроса: 
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID подразделения 
  "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid владельца
  "name": "string", // Наименование
  "description": "string", // Дополнительное описание
  "color": "string", // Цвет
  "extId": "string" // extId
}
Пример ответа: 
{
  "name": "string", // Наименование
  "description": "string", // Дополнительное описание
  "color": "string", // Цвет
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID
  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
  "deleted": true // Признак удаления
}
Удаление подразделения
DELETE /api/v3/Units/{unitId}
unitId - Guid подразделения 
Пример ответа: 
200 // Success
Управление группами
Получить информацию группы по идентификатору группы
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 - по моделям объектов
}
Удалить группу
DELETE /api/v3/VehiclesGroups/{groupId}
groupId - Идентификатор группы
Пример ответа: 
200 // Success
Получить информацию группы по идентификатору клиента
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 - по моделям объектов
  }
]
Создать группу
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 - по моделям объектов
}
Изменить группу
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 - по моделям объектов
}
Раздел: Яндекс Маршруты
Возвращение списка маршрутов
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
    ]
  }
]
Добавить маршрут
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
  ]
}
Обновление маршрута
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
  ]
}
Получить связки маршрутов ТС
POST /api/v3/TransportRoutes/getroutesvehicles
Пример запроса:
[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"  // идентификатор маршрута
]
Пример ответа: 
[
  {
    "vehicleId": 0, // Опредлеляет идентификатор ТС
    "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Определяет идентификатор маршрута
  }
]
Удалить маршрут
DELETE /api/v3/TransportRoutes/{id}
Пример запроса:
Id  // Идентификатор поля
Раздел: Управление доступа к машинам
Получение списка транспортных средств видимых пользователю
GET /api/v3/UserVisibleVehicles/{userId}
Пример ответа: 
{
  "vehicleIds": [  // Идентификаторы ТС
    0
  ]
}
Задает видимость транспортных средств пользователю
POST /api/v3/UserVisibleVehicles
Пример запроса: 
{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  // Идентификатор пользователя
  "vehicleIds": [ // Идентификаторы ТС
    0
  ]
}
Пример ответа :
200 // Success
Фотомониторинг
Получение списка фотографий
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 // Долгота
  }
]