API docs by Redocly

LogExpert API v2 (v2)

Download OpenAPI specification:

LogExpert

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

Account

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

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

Authorizations:
Apikey

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

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

Geocoding

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

SharedObjectsGroups

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

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

Authorizations:
Apikey

Responses

Response samples

Content type
{
  • "value": [
    ]
}

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

Authorizations:
Apikey
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>

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

Responses

Response samples

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

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

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

Responses

Response samples

Content type
0
0

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

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

Responses

Response samples

Content type
0
0

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

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

objectId
required
integer <int32>

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

Responses

Response samples

Content type
0
0

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

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

objectId
required
integer <int32>

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

Responses

Response samples

Content type
0
0

SharedGeofencesGroups

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

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

Authorizations:
Apikey

Responses

Response samples

Content type
{
  • "value": [
    ]
}

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

Authorizations:
Apikey
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>

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

Responses

Response samples

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

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

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

Responses

Response samples

Content type
0
0

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

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

Responses

Response samples

Content type
0
0

PrivateObjectsGroups

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

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

Authorizations:
Apikey

Responses

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

Authorizations:
Apikey
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>

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

Responses

Response samples

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

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

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

Responses

Response samples

Content type
0
0

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

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

Responses

Response samples

Content type
0
0

PrivateGeofencesGroups

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

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

Authorizations:
Apikey

Responses

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

Authorizations:
Apikey
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>

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

Responses

Response samples

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

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

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

Responses

Response samples

Content type
0
0

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

Authorizations:
Apikey
path Parameters
id
required
integer <int32>

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

Responses

Response samples

Content type
0
0

Tracks

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

Units

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

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

Authorizations:
Apikey

Responses

Response samples

Content type
{
  • "value": [
    ]
}

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

Authorizations:
Apikey
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>

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

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",
  • "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",
  • "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>

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

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",
  • "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
}

ApiKeys

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

Authorizations:
Apikey

Responses

Response samples

Content type
[
  • {
    }
]

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

Authorizations:
Apikey
Request Body schema:

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

id
integer <int32>

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

key_value
required
string

Значение ключа

create_date
string <date-time>

Дата создания ключа

expire_date
string <date-time>

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

notes
string or null

Описание

Responses

Request samples

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

Response samples

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

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

Authorizations:
Apikey
query Parameters
key
integer <int32>

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

Responses

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

Authorizations:
Apikey
path Parameters
id
required
string
query Parameters
key
integer <int32>

Responses

Maps

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

Authorizations:
Apikey
query Parameters
accountingUnitId
integer <int32>

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

Responses

Response samples

Content type
[
  • {
    }
]