Automap — rest — layers
Слои
Базовые слои
GET /layers/base
Структура запроса:
GET /layers/base?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
schemas: [
{
name: "Карта России",
className: "className",
order: 0
}
],
spaces: [
{
name: "Космоснимки Роскосмос",
className: "className",
order: 0
}
]
}
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — GeoportalFunctional
Функционал геопортала
Обращение к функционалу геопортала (см. документацию по REST API Геопортала )
GET /geoportal/*path
Структура запроса:
GET /geoportal/*path?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Доступно только для пользователей с правами администратора
POST /geoportal/*path
Структура запроса:
POST /geoportal/*path?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — docUser
Документация пользователя
Документация пользователя
GET /docs/user
Структура запроса:
GET /docs/user?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 200 — успешное выполнение
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — reports
Отчеты
Графический отчет за выбранный промежуток времени
GET /reports/graphical/{glonassId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/graphical/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{glonassId}: id ГЛОНАСС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
extent: [49.0916, 55.7301, 49.2581, 55.8429]
speedTracks: [
{
dateFrom:1381361961000,
dateTill:1381362010000,
length:221,
line:{
type:"LineString",
coordinates:[[49.1697,55.7559]]
},
avgSpeed:13,
type:1
}
]
}
// координаты левой нижней и правой верхней точек графика
// массив треков скорости
// начало промежутка времени
// конец промежутка времени
// расстояние
// тип линии
// массив координат
// средняя скорость
// тип
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Потери сигнала за промежуток времени
GET /reports/nosignal/{glonassId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/nosignal/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{glonassId}: id ГЛОНАСС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
date: 1381484138000,
direction: 6373,
duration: 1073000,
info: "info (00:17:53)",
line:{
type:"LineString",
coordinates:[[49.1697,55.7559],...]
},
}
]
// массив потери сигнала
// время
// угол, под которым вошло ТС
// продолжительность
// информация
// тип линии
// координаты
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Статистика ТС за выбранный промежуток времени
GET /reports/short/{glonassId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/short/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{glonassId}: id ГЛОНАСС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
fuel: 0
glonassAvg: 0
gpsAvg: 8.74
length: 489.532
motorHours: null
}
// топливо
// среднее количество ГЛОНАСС спутников за период времени
// среднее количество GPS спутников за период времени
// расстояние
// коэффициенты моточасов
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Повороты
GET /reports/turns/{glonassId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/turns/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{glonassId}: id ГЛОНАСС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
date:1381321524000,
address:"-",
info:"Поворот с восток на северозапад",
point:
{
type:"Point",
coordinates:[49.1696,55.7559]
},
direction:295
}
]
// массив данных о поворотах
// время
// адрес
// информация
// тип
// координаты
// угол, под которым вошло ТС
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Остановки
GET /reports/parkings/{glonassId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/parkings/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{glonassId}: id ГЛОНАСС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
address: "-",
date: 1381316004000,
info: "Остановка (12:46:08)",
point:
{
type:"Point",
coordinates:[49.1697,55.7559]
}
}
]
// массив данных об остановках
// адрес
// время
// информация
// тип
// координаты
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
События, генерируемые датчиками
GET /reports/gaugeevents/{glonassId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/gaugeevents/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{glonassId}: id ГЛОНАСС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
date:null,
address:"-",
info:"Датчик Зажигание: Вкл.",
point:null
}
]
// массив событий
// время
// адрес
// информация
// информация о точке
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Скорость
GET /reports/speedhistory/{glonassId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/speedhistory/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{glonassId}: id ГЛОНАСС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
date: 1382090876000,
value: 16
}
]
// массив скоростей
// время
// скорость
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список событий от датчиков данного ТС в заданный промежуток времени
GET /reports/gaugehistory/$carId<[0-9]+>/$port<[0-9]+>/$typeId<[0-9]+>/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/gaugehistory/$carId<[0-9]+>/$port<[0-9]+>/$typeId<[0-9]+>/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
$carId<[0-9]+>:id ТС
$port<[0-9]+>:Порт
$typeId<[0-9]+>:id датчика
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
date: 1384840112000,
value: 0
}
]
// массив событий
// время
// значение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
История
GET /reports/history/{glonassId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/history/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{glonassId}: id ГЛОНАСС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
data: 1381316004000,
speed: 0,
direction: 45,
odometr: 0,
lat: 55.7559,
lng: 49.1559
}
]
// массив данных
// время
// скорость
// угол, под которым вошло ТС
// показатели одометра
// широта
// долгота
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Графический отчет, события входа и выхода из контрольной зоны
GET /reports/zones/{glonassId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/zones/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{glonassId}: id ГЛОНАСС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
address: "-",
date: 1381837158000,
direction: 308,
info: "Вход в зону (3123123234)",
point:
{
type:"Point",
coordinates:[49.1737,55.7354]
}
}
]
// массив событий
// адрес
// время
// угол, под которым вошло ТС
// информация
// тип
// координаты
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Комбоотчет по группе
GET /reports/runs/group/{groupId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/runs/group/{groupId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{groupId}: id группы
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
billrun: 0
carId: 4937
sysrun: 0
}
]
// массив данных
// пройдено по путевым листам
// id ТС
// пройдено по системе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Комбоотчет по списку ТС
GET /reports/runs/cars/{carId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/runs/cars/{carId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{carId}: id ТС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
billrun: 0
carId: 3923
sysrun: 0
}
]
// массив данных
// пройдено по путевым листам
// id ТС
// пройдено по системе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Отчет по пробегу по системе и по путевым листам
GET /reports/runs/daily/{carId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/runs/daily/{carId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{carId}: id ТС
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
date: "21.11.13",
sysrun: 0,
billrun: 0
},
]
// массив данных
// дата
// пройдено по путевым листам
// пройдено по системе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Отчет по плохим ТС
GET /reports/badcars/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/badcars/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
billrun: 0
carId: 3913
count: 4
distance: 126.07
duration: 86000
glonassId: 393
sysrun: 52.86
}
]
// массив данных
// пройдено по путевым листам
// id ТС
// количество
// расстояние
// продолжительность
// ГЛОНАСС id
// пройдено по системе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Отчеты по геозоне
GET /reports/zone/{zoneId}/{tsFrom}/{tsTo}
Структура запроса:
GET /reports/zone/{zoneId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth
token: ключ доступа
{zoneId}: id геозоны
{tsFrom}: начало промежутка времени
{tsTo}: конец промежутка времени
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
carId: 3973,
date: 1382703138000,
goIn: true
}
]
// массив данных
// id ТС
// дата
// вход в зону
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Отчет для печати подробнее о JasperReports
GET /jreports/file/$name<[0-9]+\.[a-z]{2,4}>
Структура запроса:
GET /jreports/file/{name}?token=bw3ty3h46yth
token: ключ доступа
{name}: имя файла доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Параметры для построения отчетов подробнее о JasperReports
GET /jreports/{id}/parameters
Структура запроса:
GET /jreports/{id}/parameters?token=bw3ty3h46yth
token: ключ доступа
{id}: id отчета
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 1,
description: "groups ids",
type: "text",
name: "in_groups_ids",
prompt: false,
lib: false,
order: 1
}
]
// массив данных
// id
// описание
// тип
// название
// доступность поля для заполнения
// списковый параметр, который требует предзагрузки
// списка значений доступных для выбора
// порядок
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Значения параметра для построения отчетов подробнее о JasperReports
GET /jreports/{id}/parameters/{parameterId}/values
Структура запроса:
GET /jreports/{id}/parameters/{parameterId}/values?token=bw3ty3h46yth
token: ключ доступа
{id}: id отчета
{parameterId}: id параметра
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 9,
name: "Педаль сцепления"
}
]
// массив данных
// id
// название
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список расширенных отчетов подробнее о JasperReports
GET /jreports
Структура запроса:
GET /jreports?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 38
name: "123123"
type: 2
}
]
// массив данных
// id
// название
// тип
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Построение расширенного отчета (JasperReports)
Для получения расширенного отчета по ТС или по группе необходимо отправить WebSocket-сообщение «GET_REPORT»,содержащее объект:
{
extern: false,
fileType: "pdf",
params: [
{
name: "in_gauge_id",
type: "int",
value: 0
}
],
reportId: "198"
}
// использует ли отчет стороннюю базу данных
// формат файла(pdf,doc,rtf,xls) ,
// параметры отчета
// тип отчета
Ответ:
Формат: json
{
alias: "Странный отчет (PDF)",
expire: 1389709624027,
name: "1389623224026.pdf",
status: 1
}
// название типа отчета
// в указанный момент времени отчет затрется
// название файла отчета
// статус выполнения запроса
Параметры для построения дополнительных расширенных отчетов подробнее о JasperReports
GET /jreports/extern/{id}/parameters
Структура запроса:
GET /jreports/extern/{id}/parameters?token=bw3ty3h46yth
token: ключ доступа
{id}: id отчета
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 1,
description: "groups ids",
type: "text",
name: "in_groups_ids",
prompt: false,
lib: false,
order: 1
}
]
// массив данных
// id
// описание
// тип
// название
// доступность поля для заполнения
// списковый параметр, который требует предзагрузки
// списка значений доступных для выбора
// порядок
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Дополнительные расширенные отчеты подробнее о JasperReports
GET /jreports/extern
Структура запроса:
GET /jreports/extern?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 38
name: "123123"
type: 2
}
]
// массив данных
// id
// название
// тип
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — serviceReason
Причины ТО
Список причин постановки ТС на ТО
GET /cars/service/reason
Структура запроса:
GET /cars/service/reason?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 1,
"name": "Трекер: зависание"
},...]
// id причины, целое число
// название причины, строка
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Информация о причине постановке по ID
GET /cars/service/reason/{id}
Структура запроса:
GET /cars/service/reason/2?token=bw3ty3h46yth
id: id причины
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 2,
"name": "Трекер: выход из строя"
}
// id причины, целое число
// название причины, строка
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление причины постановки ТС на ТО
Доступно только для пользователей с правами администратора
POST /cars/service/reason
Структура запроса:
POST /cars/service/reason?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"name": "Трекер: зависание"
}
// название причины, строка
Ответ:
Статус: 200 — успешное выполнение
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование причины постановки ТС на ТО
Доступно только для пользователей с правами администратора
PUT /cars/service/reason/{id}
Структура запроса:
PUT /cars/service/reason/4?token=bw3ty3h46yth
id: id причины
token: ключ доступа
Формат: json
{
"id": 4,
"name": "Измененная причины"
}
// id причины, целое число
// название причины, строка
Ответ:
Статус: 200 — успешное выполнение
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление причины постановки ТС на ТО
Доступно только для пользователей с правами администратора
DELETE /cars/service/reason/{id}
Структура запроса:
DELETE /cars/service/reason/6?token=bw3ty3h46yth
id: id причины
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — files
Файлы
Получение файла
GET /files/$uuid<[0-9a-z]+\.[a-z]{2,4}>
Структура запроса:
GET /files/$uuid<[0-9a-z]+\.[a-z]{2,4}>?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление картинки
Доступно только для пользователей с правами администратора
POST /files/upload
Структура запроса:
POST /files/upload?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
name: "p189tc0i1f1pjb17j91kphlia1qsc7.gif",
status: "ok",
uploaded: true
}
// название файла
// статус
// загружено
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки