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

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

Дополнительные API методы

Изменено Андрей Калиновский

в 2025/08/25 16:03

Оглавление

Управление подразделениями

Поиск подразделения

Добавление подразделения

Редактирование подразделения

Удаление подразделения

Управление группами

Получить информацию группы по идентификатору группы

Удалить группу

Получить информацию группы по идентификатору клиента

Создать группу

Изменить группу

Раздел: Запрос посещений геообъектов

Получение списка всех геообъектов

Запрос пересечений по объектам

Запрос пересечений по геообъектам

Обновить информацию по геозоне

Получение информации о геозоне по ID геозоны

Создание геообъекта

Удаление геообъекта

Раздел: Команды для работы со справочником культуры

Получение списка справочника культур по клиенту

Удалить запись из справочника культур по клиенту

Добавить запись в справочник культур по клиенту

Редактировать запись из списка справочника культур по клиенту

< Основная страница с API запросами

Управление подразделениями

Поиск подразделения

Добавление подразделения

Редактирование подразделения

Удаление подразделения

Управление группами

Получить информацию группы по идентификатору группы

Удалить группу

Получить информацию группы по идентификатору клиента

Создать группу

Изменить группу

Раздел: Запрос посещений геообъектов

Получение списка всех геообъектов

Запрос пересечений по объектам

Запрос пересечений по геообъектам

Обновить информацию по геозоне

Получение информации о геозоне по ID геозоны

Создание геообъекта

Удаление геообъекта

Раздел: Команды для работы со справочником культуры

Получение списка справочника культур по клиенту

Удалить запись из справочника культур по клиенту

Добавить запись в справочник культур по клиенту

Редактировать запись из списка справочника культур по клиенту

Управление подразделениями

Поиск подразделения

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 - по моделям объектов
}

Раздел: Запрос посещений геообъектов

Получение списка всех геообъектов

POST /api/v3/gis/find

Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.

Метод запроса: POST

URL запроса: https://hosting.glonasssoft.ru/api/v3/gis/find

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{
"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификатор клиента, для которого надо получить данные
}

Ответ:

[
{
"id": 0, // Идентификатор объекта геозоны
"name": "string", // Название объекта геозоны
"type": 0, // Тип объекта геозоны
"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Подразделение
"fname": "string", // Имя файла
"parentId": "string", // Идентификатор клиента
"beginCalc": "2023-08-01T07:54:54.893Z", // Дата начала расчета
"endCalc": "2023-08-01T07:54:54.893Z", // Дата окончания расчета
"description": "string", // Описание
"area": 0, // Площадь, м2
"perimetr": 0, // Периметр, м
"createDate": "2023-08-01T07:54:54.893Z", // Дата создания
}
]

Запрос пересечений по объектам

POST /api/v3/gis/intersections/vehicles

Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.

Метод запроса: POST

URL запроса: https://hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{
"startDate": "2023-08-02T06:13:18.551Z", // Дата начала запроса
"endDate": "2023-08-02T06:13:18.551Z", // Дата окончания
"ids": [ ], // Массив id объектов
"byTime": 0, // Объединение событий по времени
"byDist": 0, // Объединение событий по расстоянию
"filterByTime": 0, // Фильтрация событий по времени нахождения
"filterByHalfPerimeter": true // Фильтрация событий по пробегу половины периметра
}

Ответ:
[
{
"geozoneId": 0, // ID геообъекта
"geozoneName": "string", // Название геообъекта
"startDate": "2023-08-02T06:13:18.554Z", // Дата въезда
"endDate": "2023-08-02T06:13:18.554Z", // Дата выезда
"duration": 0, // Продолжительность нахождения в геообъекте
"vehicleId": 0, // ID объекта
"vehicleName": "string" // Имя объекта
}
]

Запрос пересечений по геообъектам

POST /api/v3/gis/intersections/geozones

Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.

Метод запроса: POST

URL запроса: https://hosting.glonasssoft.ru/api/v3/gis/intersections/geozones

В заголовках запроса: X-Auth: Токен авторизации

Тело запроса:

{
"startDate": "2023-08-02T06:13:18.551Z", // Дата начала запроса
"endDate": "2023-08-02T06:13:18.551Z", // Дата окончания
"ids": [ ], // Массив id геообъектов
"byTime": 0, // Объединение событий по времени
"byDist": 0, // Объединение событий по расстоянию
"filterByTime": 0, // Фильтрация событий по времени нахождения
"filterByHalfPerimeter": true // Фильтрация событий по пробегу половины периметра
}

Ответ:

[
{
"geozoneId": 0, // ID геообъекта
"geozoneName": "string", // Название геообъекта
"startDate": "2023-08-02T06:13:18.554Z", // Дата въезда
"endDate": "2023-08-02T06:13:18.554Z", // Дата выезда
"duration": 0, // Продолжительность нахождения в геообъекте
"vehicleId": 0, // ID объекта
"vehicleName": "string" // Имя объекта
}
]

Обновить информацию по геозоне

PUT /api/v3/gis

Метод запроса: PUT

Пример запроса:

{
"id": 0, // Идентификатор объекта геозоны
"name": "string", // Наименование объекта геозоны
"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Подразделение
"description": "string", // Описание объекта геозоны
"beginCalc": "2025-04-24T12:10:28.751Z", // Дата начала расчетов для геозоны
"endCalc": "2025-04-24T12:10:28.751Z", // Дата окончания расчетов для геозоны
"settingsData": "string" // Параметры отображения в формате XML.
"type": 0, // Тип геозоны - линия,полигон
"radius": 0, // Радиус геозоны
"shape": "string", // Координаты геозоны
"shape_format": "string" // Формат xml,json

}

Пример ответа:

200 // Success

Получение информации о геозоне по ID геозоны

GET /api/v3/gis/{geozoneId}

geozoneId // id геозоны

Пример ответа:

{
"id": 0, // Идентификатор объекта геозоны
"name": "string", // Наименование объекта геозоны
"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Подразделение
"description": "string", // Описание объекта геозоны
"beginCalc": "2025-09-03T06:08:58.533Z", // Дата начала расчетов для геозоны
"endCalc": "2025-09-03T06:08:58.533Z", // Дата окончания расчетов для геозоны
"settingsData": "string", // Параметры отображения в формате XML.
"type": 0, // Тип геозоны - линия,полигон
"radius": 0, // Радиус геозоны
"shape": "string", // Координаты геозоны
"shape_format": "string" // Формат xml,json
}

Создание геообъекта

POST /api/v3/gis

Пример запроса:

{
"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Наименование объекта геозоны
"name": "string", // Подразделение
"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Описание объекта геозоны
"description": "string", // Дата начала расчетов для геозоны
"beginCalc": "2025-09-03T06:13:08.168Z", // Дата начала расчетов для геозоны
"endCalc": "2025-09-03T06:13:08.168Z", // Дата окончания расчетов для геозоны
"settingsData": "string", // Параметры отображения в формате XML
"type": 0, // Тип геозоны - линия,полигон
"radius": 0, // Радиус геозоны
"shape": "string", // Координаты геозоны
"shape_format": "string" // Формат xml,json
}

Пример ответа:

200 // Success

Удаление геообъекта

DELETE /api/v3/gis/{geozoneId}

geozoneId // Id геообъекта

Пример ответа:

200 // Success

Раздел: Команды для работы со справочником культуры

Получение списка справочника культур по клиенту

GET /api/v3/cultures/{id}

id // id пользователя, для которого запрашивается информация

Пример ответа:

[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID модели
"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
"name": "string", // Наименование
"productivity": 0, // Урожайность Ц/Га
"color": "c633d6", // Цвет
"picture": "Culture18" // ссылка на изображение
}
]

Удалить запись из справочника культур по клиенту

DELETE /api/v3/cultures/{id}

id // id культуры

Пример ответа:

200 // Success

Добавить запись в справочник культур по клиенту

POST /api/v3/cultures

Пример запроса:

{
"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
"name": "string", // Наименование
"productivity": 0, // Урожайность Ц/Га
"color": "c633d6", // Цвет
"picture": "Culture18" // Ссылка на изображение
}

Пример ответа:

200 // Success

Редактировать запись из списка справочника культур по клиенту

PUT /api/v3/cultures

Пример запроса:

{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID модели
"parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя
"name": "string", // Наименование
"productivity": 0, // Урожайность Ц/Га
"color": "c633d6", // Цвет
"picture": "Culture18" // ссылка на изображение
}

Пример ответа:

200 // Success