API docs by Redocly

LogExpert API v2 (v2)

Download OpenAPI specification:

LogExpert

📋 API ГИС-системы LogExpert

Account

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

Получить учётную запись текущего пользователя

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "id": 0,
  • "user_name": "string",
  • "secret": "string",
  • "accounting_unit_id": 0,
  • "expire_date": "2019-08-24T14:15:22Z",
  • "roles": [
    ],
  • "session_id": "string"
}

AccountingUnits

Управление учетными единицами

Alerts

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

Events

Операции с событиями

Получение событий детектора поездок

Authorizations:
Apikey
path Parameters
unit_id
required
integer <int32>

Идентификатор объекта

query Parameters
begin
string <date-time>

Начало периода

end
string <date-time>

Окончание периода

geocode_address
boolean

Геокодировать адрес

include_points
boolean

Включить точки событий

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": [
    ],
  • "ride_detector_settings": {
    }
}

Geocoding

Геокодинг - перевод адресов в координаты и обратно

Получить снимок текущей статистики для Memory Cache

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "current_entry_count": 0,
  • "current_estimated_size": 0,
  • "total_misses": 0,
  • "total_hits": 0
}

Обратный геокодинг - получить ближайший адрес по координатам

Authorizations:
Apikey
query Parameters
lat
number <double>

Широта

lon
number <double>

Долгота

address_flags
string

Строка из цифр, определяющих порядок компонентов адреса в результирующей адресной строке. Необязательный, значение по умолчанию: 56432

address_details
integer <int32>

Если значение равно 1, включать в ответ все компоненты, возвращаемые в свойстве address. Необязательный, значение по умолчанию: 0

short_types
integer <int32>

Управляет сокращением/удалением имён типов компонентов адреса. 1 - сокращать (улица -> ул. и т.п.) 0 - не сокращать. Необязательный, значение по умолчанию: 0

debug
integer <int32>

Возвращать дополнительно все данные, которые вернул Nominatim

debug_nominatim
integer <int32>

Возвращать дополнительно все данные, которые вернул Nominatim с ключем Debug

header Parameters
SessionId
any

Responses

Обратный геокодинг - получить ближайшие адреса для нескольких точек по координатам

Authorizations:
Apikey
query Parameters
address_flags
string

Строка из цифр, определяющих порядок компонентов адреса в результирующей адресной строке. Необязательный, значение по умолчанию: 56432

address_details
integer <int32>

Если значение равно 1, включать в ответ все компоненты, возвращаемые в свойстве address. Необязательный, значение по умолчанию: 0

short_types
integer <int32>

Управляет сокращением/удалением имён типов компонентов адреса. 1 - сокращать (улица -> ул. и т.п.) 0 - не сокращать. Необязательный, значение по умолчанию: 0

debug
integer <int32>

Возвращать дополнительно все данные, которые вернул Nominatim

header Parameters
SessionId
any
Request Body schema:

Координаты точек

Array
Array
number <double>

Responses

Request samples

Content type
[
  • [
    ]
]

Найти объект по адресу

Authorizations:
Apikey
query Parameters
q
string

Адрес

address_details
integer <int32>

Включать детализацию адреса

header Parameters
SessionId
any

Responses

SharedObjectsGroups

Общие группы объектов

Получить список общих групп объектов

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": [
    ]
}

Создание общей группы объектов

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Общая группа объектов

id
integer <int32>

Идентификатор

accounting_unit_id
integer <int32>

Идентификатор учётной единицы

name
required
string non-empty

Название

Responses

Request samples

Content type
{
  • "id": 0,
  • "accounting_unit_id": 0,
  • "name": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "accounting_unit_id": 0,
  • "name": "string"
}

Получить информацию об общей группе объектов

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "id": 0,
  • "accounting_unit_id": 0,
  • "name": "string"
}

Изменение общей группы объектов

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any
Request Body schema:

Общая группа объектов

kind
integer <int32> (Microsoft.AspNetCore.OData.Deltas.DeltaItemKind)
Enum: 0 1 2 3 4
object (System.Type)
object (System.Type)

Responses

Request samples

Content type
{
  • "kind": 0,
  • "structured_type": {
    },
  • "expected_clr_type": {
    }
}

Response samples

Content type
0
0

Удаление общей группы объектов

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

Добавление объекта в общую группу

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор группы

objectId
required
integer <int32>

Идентификатор объекта

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

Удаление объекта из общей группы

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор группы

objectId
required
integer <int32>

Идентификатор объекта

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

SharedGeofencesGroups

Общие группы геозон

Получить список общих групп геозон

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": [
    ]
}

Создание общей группы геозон

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Общая группа геозон

id
integer <int32>

Идентификатор

accounting_unit_id
integer <int32>

Идентификатор учётной единицы

name
required
string non-empty

Название

Array of objects or null (LogExpert.Data.Geofence)

Геозоны

Responses

Request samples

Content type
{
  • "id": 0,
  • "accounting_unit_id": 0,
  • "name": "string",
  • "geofences": [
    ]
}

Response samples

Content type
{
  • "id": 0,
  • "accounting_unit_id": 0,
  • "name": "string",
  • "geofences": [
    ]
}

Получить информацию об общей группе геозон

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "id": 0,
  • "accounting_unit_id": 0,
  • "name": "string",
  • "geofences": [
    ]
}

Изменение общей группы геозон

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any
Request Body schema:

Общая группа геозон

kind
integer <int32> (Microsoft.AspNetCore.OData.Deltas.DeltaItemKind)
Enum: 0 1 2 3 4
object (System.Type)
object (System.Type)

Responses

Request samples

Content type
{
  • "kind": 0,
  • "structured_type": {
    },
  • "expected_clr_type": {
    }
}

Response samples

Content type
0
0

Удаление общей группы геозон

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

Добавление геозоны в общую группу

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор группы

geofenceId
required
integer <int32>

Идентификатор геозоны

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

Удаление геозоны из общей группы

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор группы

geofenceId
required
integer <int32>

Идентификатор геозоны

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

PrivateObjectsGroups

Приватные группы объектов

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

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": [
    ]
}

Создание приватной группы объектов

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Приватная группа объектов

id
integer <int32>

Идентификатор

name
required
string non-empty

Название

Array of objects or null (LogExpert.Data.Unit)

Объекты

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "objects": [
    ]
}

Response samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "objects": [
    ]
}

Получить информацию об приватной группе объектов

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "objects": [
    ]
}

Изменение приватной группы объектов

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any
Request Body schema:

Приватная группа объектов

kind
integer <int32> (Microsoft.AspNetCore.OData.Deltas.DeltaItemKind)
Enum: 0 1 2 3 4
object (System.Type)
object (System.Type)

Responses

Request samples

Content type
{
  • "kind": 0,
  • "structured_type": {
    },
  • "expected_clr_type": {
    }
}

Response samples

Content type
0
0

Удаление приватной группы объектов

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

Добавление объекта в приватную группу

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор группы

objectId
required
integer <int32>

Идентификатор объекта

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

Удаление объекта из приватной группы

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор группы

objectId
required
integer <int32>

Идентификатор объекта

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

PrivateGeofencesGroups

Приватные группы геозон

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

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": [
    ]
}

Создание приватной группы геозон

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Приватная группа геозон

id
integer <int32>

Идентификатор

name
required
string non-empty

Название

Array of objects or null (LogExpert.Data.Geofence)

Геозоны

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "geofences": [
    ]
}

Response samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "geofences": [
    ]
}

Получить информацию об приватной группе геозон

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "geofences": [
    ]
}

Изменение приватной группы геозон

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any
Request Body schema:

Приватная группа геозон

kind
integer <int32> (Microsoft.AspNetCore.OData.Deltas.DeltaItemKind)
Enum: 0 1 2 3 4
object (System.Type)
object (System.Type)

Responses

Request samples

Content type
{
  • "kind": 0,
  • "structured_type": {
    },
  • "expected_clr_type": {
    }
}

Response samples

Content type
0
0

Удаление приватной группы геозон

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

Добавление геозоны в приватную группу

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор группы

geofenceId
required
integer <int32>

Идентификатор геозоны

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

Удаление геозоны из приватной группы

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор группы

geofenceId
required
integer <int32>

Идентификатор геозоны

header Parameters
SessionId
any

Responses

Response samples

Content type
0
0

Tracks

Операции с треками

Создание трека

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Параметры для создания трека

id
string or null <uuid>

Идентификатор трека

unit_id
integer <int32>

Идентификатор объекта

begin
string <date-time>

Начало периода

end
string <date-time>

Конец периода

use_ride_detector
boolean

Использовать детектор поездок

fill_gaps
boolean

Достраивать трек при разрывах

color
string or null

Основной цвет трека

show_stops_in_tracks
boolean or null

Отображать значки остановок

show_parkings_in_tracks
boolean or null

Отображать значки стоянок

stroke_width
integer or null <int32>

Толщина линии

draw_arrows
boolean or null

Отрисовывать стрелки

periods
Array of strings or null[ items <date-time >[ items <date-time > ] ]

Периоды, которые нужно окрашивать другим цветом (AlternateColor)

alternate_color
string or null

Альтернативный цвет для окрашивания частей трека, задаваемых в Periods

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "unit_id": 0,
  • "begin": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "use_ride_detector": true,
  • "fill_gaps": true,
  • "color": "string",
  • "show_stops_in_tracks": true,
  • "show_parkings_in_tracks": true,
  • "stroke_width": 0,
  • "draw_arrows": true,
  • "periods": [
    ],
  • "alternate_color": "string"
}

Response samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "bounds": [
    ],
  • "stops": [
    ],
  • "parkings": [
    ],
  • "rides": [
    ],
  • "points_count": 0,
  • "mileage": 0.1,
  • "chart_items": [
    ],
  • "anomalies": [
    ],
  • "sensors_with_errors": [
    ]
}

Удаление трека

Authorizations:
Apikey
query Parameters
id
string <uuid>

Идентификатор трека

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "code": "string",
  • "text": "string"
}

Получение точек трека

Authorizations:
Apikey
query Parameters
id
string <uuid>

Идентификатор трека

page
integer <int32>

Номер страницы

size
integer <int32>

Размер страницы

header Parameters
SessionId
any

Responses

Response samples

Content type
[
  • {
    }
]

Получение точек трека для графика

Authorizations:
Apikey
query Parameters
id
string <uuid>

Идентификатор трека

width
integer <int32>

Ширина области графика. Если 0 - возвращаются все точки

sensors
Array of strings

Названия графиков, информацию о которых нужно вернуть

from
number <double>

Начальная точка графика

to
number <double>

Конечная точка графика

header Parameters
SessionId
any

Responses

Response samples

Content type
[
  • [
    ]
]

Получение информации о точке с указанной датой и временем

Authorizations:
Apikey
query Parameters
id
string <uuid>

Идентификатор трека

timestamp
string <date-time>
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "index": 0,
  • "lat": 0.1,
  • "lon": 0.1
}

Получение кластеризованных точек

Authorizations:
Apikey
query Parameters
id
string <uuid>

Идентификатор трека

width
integer <int32>

Ширина окна

height
integer <int32>

Высота окна

bbox
Array of numbers <double> [ items <double > ]

Ограничивающая рамка (BBOX)

header Parameters
SessionId
any

Responses

Response samples

Content type
[
  • [
    ]
]

Обновление существующего трека

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Параметры для обновления трека

id
string <uuid>

Идентификатор трека

visible
boolean or null

Является ли трек видимым

color
string or null

Основной цвет трека

periods
Array of strings or null[ items <date-time >[ items <date-time > ] ]

Периоды, которые нужно окрашивать другим цветом (AlternateColor)

second_color
string or null

Дополнительный цвет трека

alternate_color
string or null

Альтернативный цвет для окрашивания частей трека, задаваемых в Periods

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "visible": true,
  • "color": "string",
  • "periods": [
    ],
  • "second_color": "string",
  • "alternate_color": "string"
}

Response samples

Content type
[
  • 0.1
]

Обновление частей существующего трека

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Параметры для обновления частей трека

id
string <uuid>

Идентификатор трека

visible
boolean or null

Является ли трек видимым

color
string or null

Основной цвет трека

Array of objects (LogExpert.Data.UpdateTrackPartsPeriod)

Периоды, которые должны быть выделены другим цветом

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "visible": true,
  • "color": "string",
  • "periods": [
    ]
}

Response samples

Content type
[
  • 0.1
]

Устанавливает видимость для всех треков в сессии

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Видимость трека

boolean

Responses

Request samples

Content type
true

Response samples

Content type
{
  • "code": "string",
  • "text": "string"
}

Удаление всех треков в сессии

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "code": "string",
  • "text": "string"
}

Удаление точек трека

Authorizations:
Apikey
path Parameters
id
required
string <uuid>

Идентификатор трека

header Parameters
SessionId
any
Request Body schema:

Индексы удаляемых точек

Array
integer <int32>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
{
  • "success": true,
  • "rebuild": true
}

Получение информации о точке с заданными координатами

Authorizations:
Apikey
query Parameters
point
Array of numbers <double> [ items <double > ]

Координаты точки

bounds
Array of numbers <double> [ items <double > ]

Границы области

width
number <double>

Ширина области

height
number <double>

Высота области

accountingUnitId
integer <int32>

Учётная единица

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "tracks": [
    ],
  • "stops": [
    ],
  • "parkings": [
    ],
  • "geofences": [
    ]
}

Получение информации о стоянке по заданным координатам

Authorizations:
Apikey
query Parameters
point
Array of numbers <double> [ items <double > ]
bounds
Array of numbers <double> [ items <double > ]
width
number <double>
height
number <double>
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "index": 0,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "lat": 0.1,
  • "lon": 0.1,
  • "duration": "00:00:00",
  • "type": "string"
}

Импорт сообщений объекта в формате Wialon

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Параметры

unit_id
integer <int32>

Идентификатор объекта

data
string

Данные в формате Wialon

Responses

Request samples

Content type
{
  • "unit_id": 0,
  • "data": "string"
}

Response samples

Content type
0
0

Получение статуса импорта сообщений

Authorizations:
Apikey
path Parameters
taskId
required
string

Идентификатор задания

header Parameters
SessionId
any

Responses

Экспорт сообщений объекта из трека в формат Wialon

Authorizations:
Apikey
path Parameters
id
required
string <uuid>

Идентификатор трека

header Parameters
SessionId
any
Request Body schema:

Индексы точек трека

Array
integer <int32>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
{
  • "success": true,
  • "rebuild": true,
  • "data": "string"
}

Экспорт сообщений объекта в формат GPX

Authorizations:
Apikey
query Parameters
objectId
integer <int32>

Идентификатор объекта

begin
string <date-time>

Начало периода

end
string <date-time>

Окончание периода

useRideDetector
boolean

Использовать детектор поездок

trackId
string <uuid>

Идентификатор трека

header Parameters
SessionId
any

Responses

Response samples

Content type
"string"

Units

Объекты мониторинга

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

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": [
    ]
}

Создать транспортное средство

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Транспортное средство

id
integer <int32>

Идентификатор

name
required
string non-empty

Название

unique_id
required
string non-empty

Идентификатор IMEI

phone_number
string or null

Номер телефона

accounting_unit_id
integer <int32>

Идентификатор учётной единицы

created_at
string <date-time>

Дата и время создания

updated_at
string <date-time>

Дата и время последнего обновления

deleted_at
string or null <date-time>

Дата и время удаления

battery_sensor
required
string non-empty

Имя датчика заряда аккумулятора

gsm_signal_sensor
required
string non-empty

Имя датчика уровня сигнала GSM

current_protocol
string or null

Имя протокола

unit_type
string or null

Тип объекта

icon_id
integer <int32>

Идентификатор значка

is_active
boolean

Является ли объект активным

object (LogExpert.Data.RideDetectorSettings)

Настройки детектора поездок

object (LogExpert.Data.DrainDetectorSettings)

Настройки детектора сливов и заправок топлива

object (LogExpert.Data.AccountingUnit)

Учётная единица

object (LogExpert.Data.ObjectIcon)

Значок объекта

Array of objects or null (LogExpert.Data.CustomField)

Дополнительные поля

Array of objects or null (LogExpert.Data.Sensor)

Датчики

Array of objects or null (LogExpert.Data.SharedObjectsGroup)

Общие группы

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "unique_id": "string",
  • "phone_number": "string",
  • "accounting_unit_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "battery_sensor": "string",
  • "gsm_signal_sensor": "string",
  • "current_protocol": "string",
  • "unit_type": "string",
  • "icon_id": 0,
  • "is_active": true,
  • "ride_detector_settings": {
    },
  • "drain_detector_settings": {
    },
  • "accounting_unit": {
    },
  • "icon": {
    },
  • "custom_fields": [
    ],
  • "sensors": [
    ],
  • "shared_groups": [
    ]
}

Response samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "unique_id": "string",
  • "phone_number": "string",
  • "accounting_unit_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "battery_sensor": "string",
  • "gsm_signal_sensor": "string",
  • "current_protocol": "string",
  • "unit_type": "string",
  • "icon_id": 0,
  • "is_active": true,
  • "ride_detector_settings": {
    },
  • "drain_detector_settings": {
    },
  • "accounting_unit": {
    },
  • "icon": {
    },
  • "custom_fields": [
    ],
  • "sensors": [
    ],
  • "shared_groups": [
    ],
  • "check_valid_field": true
}

Получить информацию о транспортном средстве

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "unique_id": "string",
  • "phone_number": "string",
  • "accounting_unit_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "battery_sensor": "string",
  • "gsm_signal_sensor": "string",
  • "current_protocol": "string",
  • "unit_type": "string",
  • "icon_id": 0,
  • "is_active": true,
  • "ride_detector_settings": {
    },
  • "drain_detector_settings": {
    },
  • "accounting_unit": {
    },
  • "icon": {
    },
  • "custom_fields": [
    ],
  • "sensors": [
    ],
  • "shared_groups": [
    ],
  • "check_valid_field": true
}

Измененить транспортное средство

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any
Request Body schema:

Транспортное средство

kind
integer <int32> (Microsoft.AspNetCore.OData.Deltas.DeltaItemKind)
Enum: 0 1 2 3 4
object (System.Type)
object (System.Type)

Responses

Request samples

Content type
{
  • "kind": 0,
  • "structured_type": {
    },
  • "expected_clr_type": {
    }
}

Response samples

Content type
{
  • "value": 0
}

Удалить транспортное средство

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": 0
}

Восстановить транспортное средство

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": 0
}

Получить дополнительные поля транспортного средства

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор транспортного средства

header Parameters
SessionId
any

Responses

Response samples

Content type
[
  • {
    }
]

Установить дополнительное поле транспортного средства

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор транспортного средства

header Parameters
SessionId
any
Request Body schema:

дополнительное поле

object_id
integer <int32>

Идентификатор объекта

name
required
string non-empty

Имя

value
required
string

Значение

Responses

Request samples

Content type
{
  • "object_id": 0,
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
{
  • "value": 0
}

Удалить дополнительное поле транспортного средства

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор транспортного средства

query Parameters
name
string

Наименование транспортного средства

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": 0
}

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор транспортного средства

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": {
    }
}

Создать датчик транспортного средства

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор транспортного средства

header Parameters
SessionId
any
Request Body schema:

Датчик транспортного средства

id
integer <int32>

Идентификатор

name
required
string non-empty

Название

expression
required
string non-empty

Формула

min
number or null <double>

Минимальное значение

max
number or null <double>

Максимальное значение

default_visible
boolean

Показывать в окне статистики

sensor_type
required
string non-empty

Тип

measurement_unit
string or null

Единица измерения

display_expression
string or null

Формула выводимого значения

format
string or null

Строка форматирования результата

color
string or null

Цвет на графике в треках

show_in_chart
boolean

Отображать по умолчанию при построении графика в треках

save_last_valid_value
boolean

Запоминать последнее правильное значение

created_at
string <date-time>

Дата и время создания

deleted_at
string or null <date-time>

Дата и время удаления

Array of objects or null (LogExpert.Data.SensorsFunctionItem)

Тарировка

Responses

Request samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "expression": "string",
  • "min": 0.1,
  • "max": 0.1,
  • "default_visible": true,
  • "sensor_type": "string",
  • "measurement_unit": "string",
  • "display_expression": "string",
  • "format": "string",
  • "color": "string",
  • "show_in_chart": true,
  • "save_last_valid_value": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "function": [
    ]
}

Response samples

Content type
{
  • "id": 0,
  • "name": "string",
  • "expression": "string",
  • "min": 0.1,
  • "max": 0.1,
  • "default_visible": true,
  • "sensor_type": "string",
  • "measurement_unit": "string",
  • "display_expression": "string",
  • "format": "string",
  • "color": "string",
  • "show_in_chart": true,
  • "save_last_valid_value": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "function": [
    ]
}

Изменить датчик транспортного средства

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор транспортного средства

sensorId
required
integer <int32>

Идентификатор датчика транспортного средства

header Parameters
SessionId
any
Request Body schema:

Датчик транспортного средства

kind
integer <int32> (Microsoft.AspNetCore.OData.Deltas.DeltaItemKind)
Enum: 0 1 2 3 4
object (System.Type)
object (System.Type)

Responses

Request samples

Content type
{
  • "kind": 0,
  • "structured_type": {
    },
  • "expected_clr_type": {
    }
}

Response samples

Content type
{
  • "value": 0
}

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор транспортного средства

sensorId
required
integer <int32>

Идентификатор датчика транспортного средства

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": 0
}

Загрузить датчики из данных в формате WLP

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор транспортного средства

header Parameters
SessionId
any
Request Body schema:

Данные датчиков в формате WLP

string

Responses

Request samples

Content type
"string"

Response samples

Content type
{
  • "value": 0
}

Копировать датчик объекта во все объекты указанной группы

Authorizations:
Apikey
query Parameters
sensorId
integer <int32>

Идентификатор датчика объекта

groupId
integer <int32>

Идентификатор общей группы объектов

overwriteSensors
boolean

Перезаписать существующие датчики

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": "string"
}

ApiKeys

Получить ключи доступа текущего пользователя

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
[
  • {
    }
]

Создать новый ключ

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Параметры ключа

expired_at
string or null <date-time>

Дата и время окончания действия ключа

notes
string or null

Текстовое описание ключа

Responses

Request samples

Content type
{
  • "expired_at": "2019-08-24T14:15:22Z",
  • "notes": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "key_value": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "expired_at": "2019-08-24T14:15:22Z",
  • "notes": "string"
}

Удалить ключ по идентификатору

Authorizations:
Apikey
query Parameters
id
integer <int32>

Идентификатор ключа

header Parameters
SessionId
any

Responses

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

Идентификатор ключа

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "id": 0,
  • "key_value": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "expired_at": "2019-08-24T14:15:22Z",
  • "notes": "string"
}

Auth

/v2/auth/token

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

/v2/auth/change_password

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:
old_password
string
new_password
string

Responses

Request samples

Content type
{
  • "old_password": "string",
  • "new_password": "string"
}

Geo

Получить адреса для несколькоих точек прдставленных массивом координат

Authorizations:
Apikey
query Parameters
points
Array of numbers[ items <double >[ items <double > ] ]

массив координат lon,lat

header Parameters
SessionId
any

Responses

Вычисление разности между геометриями

Производится пересечение между геометриями из множества А со всеми геометриями из множества B. Если геомтрии пересекаются вычисляются разницы A-B B-A и пересечение.

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Данные и параметры

object (LogExpert.WebApi.LogExpertModels.SpatialDifferenceRequestData)

Множества геометрий A и B

object (LogExpert.WebApi.LogExpertModels.SpatialDifferenceRequestParams)

Параметры выполнения пространственной разницы

Responses

Request samples

Content type
{
  • "data": {
    },
  • "params": {
    }
}

Response samples

Content type
[
  • {
    }
]

Объединение географических геометрий

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Json объект {"data" : [ "wkb в base64"] }

data
Array of strings

Геозоны в формате wkb в base64 строках

Responses

Request samples

Content type
{
  • "data": [
    ]
}

Response samples

Content type
{
  • "result": "string"
}

Получение географической информации о геометрии

Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Список геозон wkb в base64

data
Array of strings

Геозоны в формате wkb в base64 строках

Responses

Request samples

Content type
{
  • "data": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Maps

Получить список доступных ключей к АПИ карт

Authorizations:
Apikey
query Parameters
accountingUnitId
integer <int32>

Идентификатор учётной единицы

header Parameters
SessionId
any

Responses

Response samples

Content type
[
  • {
    }
]

Reporting

Возвращает набор типов отчётов, которые можно построить в системе

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
[
  • {
    }
]

Возвращает перечень созданных ранее отчётов, хранимых в системе

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
[
  • {
    }
]

Возвращает коллекцию идентификаторов отчётов, которые были запущены после указанной метки времени (timestamp) и успешно завершили своё выполнение. Отчёт считается завершённым, если у него заполнено поле Дата завершения

Authorizations:
Apikey
query Parameters
timestamp
string <date-time>

Опорная дата и время. Метод вернёт отчёты, запущенные после этого значения.

header Parameters
SessionId
any

Responses

Response samples

Content type
[
  • 0
]

Возвращает информацию по заданию на создание отчёта

Authorizations:
Apikey
path Parameters
id
required
string <uuid>

Идентификатор задания на выполнение отчёта. Guid

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "create_date": "2019-08-24T14:15:22Z",
  • "period": {
    },
  • "done": true,
  • "details": [
    ]
}

Создает задачу для генерации отчета с указанными параметрами

Метод создает асинхронную задачу для формирования отчета. Для успешного выполнения необходимо указать в теле запроса следующий параметр:

  1. Указать хотя бы один объект в массиве ObjectIds

  2. Указать существующий тип отчета

  3. Предоставить параметры с обязательным полем "Period"

  4. Указать корректный временной период (начало раньше окончания)

  5. Указать валидный часовой пояс в параметрах

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

{
    "report_type": 3,
    "unit_ids": [4, 8, 15, 16, 23, 42, 122006],
    "parameters": {
        "build_track": false,
        "location_type": "Address",
        "period": {
            "begin": "2024-01-01T00:00:00",
            "end": "2024-01-31T23:59:59"
        },
        "time_zone": "03:00:00"
    }
}
Authorizations:
Apikey
header Parameters
SessionId
any
Request Body schema:

Параметры для создания задачи отчета

report_type
integer <int32>

Идентификатор типа отчёта

unit_ids
Array of integers <int32> [ items <int32 > ]

Идентификаторы объектов

object

Параметры отчёта

Responses

Request samples

Content type
{
  • "report_type": 0,
  • "unit_ids": [
    ],
  • "parameters": {
    }
}

Response samples

Content type
{
  • "success": true,
  • "task_id": "string",
  • "detail_ids": [
    ],
  • "error": "string",
  • "create_date_time": "2019-08-24T14:15:22Z"
}

Перестраивает сводный отчет по указанному идентификатору задания

Этот метод позволяет инициировать процесс пересоздания сводного отчета. Операция выполняется асинхронно и может быть отменена через cancellation token.

Пример запроса: PUT /api/reports/summary/3fa85f64-5717-4562-b3fc-2c963f66afa6

Authorizations:
Apikey
path Parameters
id
required
string <uuid>

Идентификатор отчета (GUID), который необходимо перестроить

header Parameters
SessionId
any

Responses

Возвращает сводный отчет по идентификатору.

Authorizations:
Apikey
path Parameters
id
required
string <uuid>

Идентификатор задачи.

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "state": "string",
  • "report_type": 0,
  • "is_summary": true,
  • "data": null,
  • "duration": "00:00:00",
  • "post_processing_time": "00:00:00",
  • "build_track": true,
  • "location_type": "string",
  • "time_zone": "00:00:00",
  • "errors": null
}

Удаляет сводный отчет по указанному идентификатору.

Authorizations:
Apikey
path Parameters
id
required
string <uuid>

Идентификатор сводного отчета.

header Parameters
SessionId
any

Responses

Перестраивает детальный отчет для указанного идентификатора

Этот метод позволяет инициировать процесс пересоздания детального отчета. Операция выполняется асинхронно и может быть отменена через cancellation token. Возвращает объект с результатом операции и идентификатором задачи.

Пример запроса: PUT /api/reports/Detail/3fa85f64-5717-4562-b3fc-2c963f66afa6

Пример успешного ответа: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Authorizations:
Apikey
path Parameters
id
required
string <uuid>

Идентификатор детального отчета (GUID), который необходимо перестроить

header Parameters
SessionId
any

Responses

Возвращает детальный отчет по задаче.

Authorizations:
Apikey
path Parameters
id
required
string <uuid>

Идентификатор задачи.

header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "state": "string",
  • "report_type": 0,
  • "is_summary": true,
  • "data": null,
  • "duration": "00:00:00",
  • "post_processing_time": "00:00:00",
  • "build_track": true,
  • "location_type": "string",
  • "time_zone": "00:00:00",
  • "object_id": 0
}

Удаляет детальный отчет по указанному идентификатору.

Authorizations:
Apikey
path Parameters
id
required
string <uuid>

Идентификатор детального отчета.

header Parameters
SessionId
any

Responses

Удаляет все отчеты текущего пользователя

Этот метод выполняет полную очистку всех отчетов, принадлежащих текущему аутентифицированному пользователю. Операция необратима - все данные отчетов будут безвозвратно удалены из системы.

Пример запроса: DELETE /v2/reports/All

Требуется аутентификация пользователя.

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Session

Узнать, существует ли сессия у пользователя

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
true

Удалить сессию пользователя

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

UnitState

Получение информации о состоянии объектов

Authorizations:
Apikey
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "value": [
    ]
}

Получение информации о состоянии объекта

Authorizations:
Apikey
path Parameters
id
required
integer <int32>
header Parameters
SessionId
any

Responses

Response samples

Content type
{
  • "id": 0,
  • "lat": 0.1,
  • "lon": 0.1,
  • "state": "LostConnection",
  • "state_begin_time": "2019-08-24T14:15:22Z",
  • "color": "Red",
  • "battery": 0.1,
  • "gsm_signal": 0.1,
  • "sensors": {
    },
  • "last_connection_time": "2019-08-24T14:15:22Z",
  • "object_time": "2019-08-24T14:15:22Z",
  • "last_valid_time": "2019-08-24T14:15:22Z",
  • "last_point_time": "2019-08-24T14:15:22Z",
  • "speed": 0.1,
  • "alt": 0.1,
  • "heading": 0.1,
  • "sats": 0,
  • "last_points": [
    ],
  • "raw_sensors": {
    }
}