Automap — rest — log — daemon
Журнал демона
Логи демона
GET /log/daemon
Структура запроса:
GET /log/daemon?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации
GET /log/daemon?level=3
level: получение списка логов по id уровня ошибки
objectType: поиск логов по типу источника данных
protocolName: поиск логов по названию протокола
protocolId: поиск логов по ID протокола
glonassId: поиск логов по glonass ID
message: поиск логов по сообщению
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: "5282255f5cc7d2819e1b9706",
time: 1384260959484,
level: "ERROR",
objectId: 0,
objectType: "pgdatabase",
protocolId: 0,
glonassId: 0,
message: " db: database connection error"
}
]
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество логов демона
GET /log/daemon/count
Структура запроса:
GET /log/daemon/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
144
// Количество логов демона
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список уровней ошибок
GET /log/daemon/levels
Структура запроса:
GET /log/daemon/levels?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 1,
type: "EMERGENCY"
}
]
// Список уровней ошибок
// id уровня
// тип уровня
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — icons(before delete /all)
Иконки
Список иконок
GET /cars/icons
Структура запроса:
GET /cars/icons?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации:
GET /cars/icons?name=iconName&rotate=true
name: получение списка иконок по названию
rotate: получение списка иконок, у которых состояние поворота соответствует заданному булевому значению
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
id: 1,
name: "Автобус 3D",
width: 384,
height: 48,
initialRotation: 0,
rotate: true,
type: 1,
src0: "/cars/icons/222/0",
src1: "/cars/icons/222/1",
src2: "/cars/icons/222/2"
},...]
// id иконки, целое число
// название иконки, строка
// ширина, целое число
// высота, целое число
// первоначальный поворот, целое число
// вращается, булевое поле
// тип иконки, целое число
// иконка неактивного ТС, строка
// иконка активного ТС, строка
// иконка выделенного ТС, строка
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список иконок (с ускоренной загрузкой за счет отсутствия фильтрации)
GET /cars/icons/all
Структура запроса:
GET /cars/icons/all?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
id: 222,
name: "Автобус 3D",
width: 384,
height: 48,
initialRotation: 0,
rotate: true,
type: 1,
src0: "/cars/icons/222/0",
src1: "/cars/icons/222/1",
src2: "/cars/icons/222/2"
},...]
// id иконки, целое число
// название иконки, строка
// ширина, целое число
// высота, целое число
// первоначальный поворот, целое число
// вращается, булевое поле
// тип иконки, целое число
// иконка неактивного ТС, строка
// иконка активного ТС, строка
// иконка выделенного ТС, строка
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Получение иконки
GET /cars/icons/{id}/{type}
Структура запроса:
GET /cars/icons/24/1?token=bw3ty3h46yth
id: id иконки
type: тип иконки
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление иконки ТС
Доступно только для пользователей с правами администратора
POST /cars/icons
Структура запроса:
POST /cars/icons?token=bw3ty3h46yth
Пример запроса:
{
"initialRotation": 25,
"name": "Новая иконка",
"rotate": true,
"type": 0,
"src0": "p19qst4j73p1a187q18np13tkqksn.jpg",
"src1": "p19qst4lmt1iau1g0212lf1r3icchp.jpg",
"src2": "p19qst4np91s0hcg71aoeoe7174gr.jpg"
}
// угол поворота, целое число
// название иконки, строка
// вращается, булевое поле
// тип, целое число
// иконка в неактивном состоянии, строка
// иконка в активном состоянии, строка
// иконка в выделенном состоянии, строка
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 185,
"name": "Новая иконка",
"width": 30,
"height": 22,
"initialRotation": 25,
"rotate": true,
"type": 0,
"src0": "/cars/icons/185/0",
"src1": "/cars/icons/185/1",
"src2": "/cars/icons/185/2"
}
// id иконки, целое число
// название иконки, строка
// ширина, целое число
// высота, целое число
// угол поворота, целое число
// вращается, булевое поле
// тип иконки, целое число
// иконка в неактивном состоянии, строка
// иконка в активном состоянии, строка
// иконка в выделенном состоянии, строка
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Изменение иконки ТС
Доступно только для пользователей с правами администратора
PUT /cars/icons/{id}
Структура запроса:
PUT /cars/icons/185?token=bw3ty3h46yth
id: id иконки
token: ключ доступа
Формат: json
{
"id": 185,
"height": 22,
"initialRotation": 15,
"name": "Новое название",
"rotate": false,
"src0": null,
"src1": null,
"src2": null,
"type": 0,
"width": 30
}
// id иконки, целое число
// высота, целое число
// угол поворота, целое число
// название иконки, строка
// вращается, булевое поле
// иконка в неактивном состоянии, строка
// иконка в активном состоянии, строка
// иконка в выделенном состоянии, строка
// тип иконки, целое число
// ширина иконки, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 185,
"name": "Новое название",
"width": 30,
"height": 22,
"initialRotation": 15,
"rotate": false,
"type": 0,
"src0": "/cars/icons/185/0",
"src1": "/cars/icons/185/1",
"src2": "/cars/icons/185/2"
}
// id иконки, целое число
// название иконки, строка
// ширина, целое число
// высота, целое число
// угол поворота, целое число
// вращается, булевое поле
// тип, целое число
// src иконки в неактивном состоянии, строка
// src иконки в активном состоянии, строка
// src иконки в выделенном состоянии, строка
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление иконки
Доступно только для пользователей с правами администратора
DELETE /cars/icons/{id}
Структура запроса:
DELETE /cars/icons/24?token=bw3ty3h46yth
id: id иконки
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество иконок
GET /cars/icons/count
Структура запроса:
GET /cars/icons/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: text
24
// Количество иконок
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Предпоказ иконки
GET /cars/icons/{id}/{status}/preview/
Структура запроса:
GET /cars/icons/31/0/preview?token=bw3ty3h46yth
id: id иконки
status: 0 — неактивное ТС; 1 — активное ТС; 2 — выделенное ТС
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: image/png
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Предпоказ только что загруженной иконки
GET /cars/icons/{src}/{type}/preview
Структура запроса:
GET /cars/icons/p19qst4j73p1a187q18np13tkqksn.jpg/0/preview?token=bw3ty3h46yth
src: src загруженной иконки
type: 0 — сжатая иконка; 1 — первая из восьми частей, в несжатом виде
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: image/png
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — users( before delete /all)
Пользователи
Список пользователей
Доступно только для пользователей с правами администратора
GET /users
Структура запроса:
GET /users?token=mbs90lon2a8
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 1,
"login": "user_login",
"fio": "ФИО пользователя",
"email": "user@user.com",
"phone": "5699654",
"monitor": false,
"visible": false,
"enabled": true,
"groupId": 4,
"organizationId": 10
},...]
// id пользователя, целое число
// логин пользователя, строка
// имя пользователя, строка
// электронная почта, строка
// телефон, строка
// видим на старте, булевое поле
// id группы, целое число
// id организации, целое число
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление пользователя
Доступно только для пользователей с правами администратора
POST /users
Структура запроса:
POST /users?token=mbs90lon2a8
token: ключ доступа
Пример запроса:
Формат: json
{
"email": "user@user.com",
"fio": "ФИО пользователя",
"groupId": "103",
"login": "newuser",
"organizationId": "122",
"password": "newuser",
"phone": "+79655141423",
"visible": true
}
// электронная почта, строка
// имя пользователя, строка
// id группы, целое число
// логин, строка
// id организации, целое число
// пароль, строка
// телефон, строка
// видим на старте, булевое поле
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 264,
"login": "newuser",
"fio": "ФИО пользователя",
"email": "user@user.com",
"phone": "+79655141423",
"monitor": false,
"visible": true,
"enabled": true,
"groupId": 103,
"organizationId": 122
}
// id пользователя, целое число
// логин, строка
// имя пользователя, строка
// электронная почта, строка
// телефон, строка
// видим на старте, булевое поле
// id группы, целое число
// id организации, целое число
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование пользователя
Доступно только для пользователей с правами администратора
PUT /users/{id}
Структура запроса:
PUT /users/24?token=mbs90lon2a8
id: id пользователя
token: ключ доступа
Пример запроса:
Формат: json
{
"email": "user@user.com",
"enabled": true,
"fio": "ФИО пользователя",
"groupId": "133",
"id": 24,
"login": "newuser",
"monitor": false,
"organizationId": "37",
"password": "newuser",
"phone": "+79655141423",
"visible": true
}
// электронная почта, строка
// видим на старте, булевое поле
// имя пользователя, строка
// id группы, целое число
// id пользователя, целое число
// логин, строка
// id организации, целое число
// пароль, строка
// телефон, строка
// видим на старте, булевое поле
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 24,
"login": "newuser",
"fio": "ФИО пользователя",
"email": "user@user.com",
"phone": "+79655141423",
"monitor": false,
"visible": true,
"enabled": true,
"groupId": 1383,
"organizationId": 3791
}
// id пользователя, целое число
// логин, строка
// имя пользователя, строка
// электронная почта, строка
// телефон, строка
// видим на старте, булевое поле
// id группы, целое число
// id организации, целое число
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление пользователя
Доступно только для пользователей с правами администратора
DELETE /users/{id}
Структура запроса:
DELETE /users/24?token=mbs90lon2a8
id: id пользователя
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"delete": true
}
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Экспорт пользователей
Доступно только для пользователей с правами администратора
GET /users.xlsx
Структура запроса:
GET /users.xlsx?token=mbs90lon2a8
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
Возвращает бинарный файл
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Текущий пользователь
Доступно только для пользователей с правами администратора
GET /users/current
Структура запроса:
GET /users/current?token=mbs90lon2a8
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 1,
"login": "admin",
"fio": "admin",
"email": null,
"organization": {
"id": 1,
"name": "ГрадоСервис ООО",
"mapExtent": "57.008, 56.638, 49.262, 48.578",
"mapRoadProvider": "MAPKZN",
"mapAerialProvider": "MICROSOFT_AERIAL",
"toDelete": false,
"info": {
"orgId": 1,
"address": "казань",
"phone": "",
"inn": "",
"kpp": "",
"email": "",
"homepage": ""
}
},
"right": {
"id": 1,
"name": "Градосервис",
"wheel": true,
"admin": true,
"organization": {
"id": 1,
"name": "ГрадоСервис ООО",
"mapExtent": "57.008, 56.638, 49.262, 48.578",
"mapRoadProvider": "MAPKZN",
"mapAerialProvider": "MICROSOFT_AERIAL",
"toDelete": false,
"info": {
"orgId": 1,
"address": "казань",
"phone": "",
"inn": "",
"kpp": "",
"email": "",
"homepage": ""
}
},
"usersCount": 5
},
"phone": "",
"monitor": false,
"visible": false,
"enabled": true,
"groupId": 1,
"organizationId": 1,
"currentOrgId": 0
}
// id пользователя, целое число
// логин пользователя, строка
// имя пользователя, строка
// электронная почта, строка
// информация об организации
// id организации, целое число
// название организации, строка
// положение на карте, строка
// провайдер, строка
// провайдер, строка
// информация о пользователе
// id организации, целое число
// адрес организации, строка
// телефон, строка
// ИНН, целое число
// КПП, целое число
// электронный адрес, строка
// веб-страница, строка
// права пользователя
// id права, целое число
// название права, строка
// всевидящий пользователь, булевое поле
// администратор, булевое поле
// информация об организации
// id организации, целое число
// название, строка
// положение на карте, строка
// провайдер, строка
// провайдер, строка
// удаление, булевое поле
// дополнительная информация
// id организации, целое число
// адрес, строка
// телефон, строка
// ИНН, целое число
// КПП, целое число
// электронная почта, строка
// веб-страница, строка
// число пользователей, целое число
// телефон пользователя, строка
// видим на старте, булевое поле
// id группы, целое число
// id организации, целое число
// id текущей организации, целое число
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество пользователей
Доступно только для пользователей с правами администратора
GET /users/count
Структура запроса:
GET /users/count?token=mbs90lon2a8
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
233
// количество пользователей, целое число
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — drivers (before delete /all)
Водители
Список водителей ТС
GET /drivers
Структура запроса:
GET /drivers?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
"id": 982,
"fio": "+",
"phone": "",
"notes": "",
"hasPhoto": false,
"orgId": 1162
}
]
// массив объектов водителей
// id водителя
// фио
// телефон
// примечание
// у водителя имеется фото
// id организации
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список водителей ТС (с более быстрой загрузкой, без фильтрации)
GET /drivers/all
Структура запроса:
GET /drivers/all?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
"id": 982,
"fio": "+",
"phone": "",
"notes": "",
"hasPhoto": false,
"orgId": 1162
}
]
// массив объектов водителей
// id водителя
// фио
// телефон
// примечание
// у водителя имеется фото
// id организации
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Поиск водителя по id
GET /drivers/{id}
Структура запроса:
GET /drivers/982?token=bw3ty3h46yth
id: id водителя
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 982,
"fio": "+",
"phone": "",
"notes": "",
"wire": null,
"extId": null,
"hasPhoto": false,
"orgId": 1162
}
// id водителя
// фио
// телефон
// примечание
// идентификатор ключа
// у водителя имеется фото
// id организации
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Изменение водителя ТС
Доступно только для пользователей с правами администратора
PUT /drivers/{id}
Структура запроса:
PUT /drivers/123?token=bw3ty3h46yth
id: id водителя ТС
token: ключ доступа
Формат: json
{
"fio": "ФИО",
"notes": "Опытный водитель ",
"orgId": 1,
"phone": "12345678"
}
// фио
// примечание
// id организации
// телефон
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"fio": "ФИО",
"hasPhoto": false,
"id": 123,
"notes": "Опытный водитель ",
"orgId": 1,
"phone": "12345678"
}
// фио
// наличие фото
// id водителя
// примечание
// id организации
// телефон
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Создание водителя ТС
Доступно только для пользователей с правами администратора
POST /drivers
Структура запроса:
POST /drivers?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"fio": "ФИО",
"notes": "Отличный водитель",
"orgId": 1,
"phone": "12345678"
}
// фио
// примечание
// id организации
// телефон
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"fio": "ФИО",
"hasPhoto": false,
"id": 1101,
"notes": "Отличный водитель",
"orgId": 1,
"phone": "12345678"
}
// фио
// наличие фото
// id водителя
// примечание
// id организации
// телефон
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление водителя ТС
Доступно только для пользователей с правами администратора
DELETE /drivers/{id}
Структура запроса:
DELETE /drivers/1125?token=bw3ty3h46yth
id: id водителя ТС
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список водителей в xlsx файле
GET /drivers.xlsx
Структура запроса:
GET /drivers.xlsx?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: application/vnd.ms-excel
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Фотография водителя
GET /drivers/{id}/photo
Структура запроса:
GET /drivers/1123/photo?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: image/png
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — usersGroups (before delete /all)
Группы пользователей
Список групп пользователей
Доступно только для всевидящих администраторов
GET /users/groups
Структура запроса:
GET /users/groups?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 2,
"name": "adminGS",
"wheel": true,
"admin": true,
"usersCount": 15,
"organizationId": 2
},...]
// id группы, целое число
// название группы, строка
// всевидящие, булевое поле
// администраторы, булевое поле
// число пользователей в группе, целое число
// id организации, целое число
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список групп пользователей (с ускоренной загрузкой за счет отсутствия фильтрации)
Доступно только для всевидящих администраторов
GET /users/groups/all
Структура запроса:
GET /users/groups/all?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 2,
"name": "adminGS",
"wheel": true,
"admin": true,
"usersCount": 24,
"organizationId": 2
},...]
// id группы, целое число
// название группы, строка
// всевидящие, булевое поле
// администраторы, булевое поле
// число пользователей в группе, целое число
// id организации, целое число
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество групп пользователей
Доступно только для всевидящих администраторов
GET /users/groups/count
Структура запроса:
GET /users/groups/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: text
23
// Количество групп пользователей
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Информация о группе пользователей по id
Доступно только для всевидящих администраторов
GET /users/groups/{id}
Структура запроса:
GET /users/groups/35?token=bw3ty3h46yth
id: id группы пользователей
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"name": "groupName",
"wheel": true,
"admin": true,
"organizationId": 1,
"carGroups": [1,2,3],
"geoportalLogin": "login",
"geoportalPassword": "12345"
}
// название группы пользователей, строка
// всевидящие, булевое поле
// администрирование, булевое поле
// id организации, целое число
// id групп ТС, целое число
// логин на GeoPortal, строка
// пароль на GeoPortal, строка
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Группы ТС определенной группы пользователей
Доступно только для всевидящих администраторов
GET /users/groups/{id}/cars/groups
Структура запроса:
GET /users/groups/27/cars/groups?token=bw3ty3h46yth
id: id группы пользователей
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 27,
"name": "Группа 1",
"notes": "-",
"organizationId": 1
},...]
// id группы ТС, целое число
// название группы ТС, строка
// примечания, строка
// id организации, целое число
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление группы пользователей
Доступно только для всевидящих администраторов
POST /users/groups
Структура запроса:
POST /users/groups?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"admin": false,
"carGroups": [49, 51, 47, 81, 82, 24],
"geoportalLogin": "geologin",
"geoportalPassword": "geopass",
"name": "Название",
"organizationId": "162",
"usersCount": 0,
"wheel": true
}
// администрирование, булевое поле
// id групп ТС, целое число
// логин на GeoPortal, строка
// пароль на GeoPortal, строка
// название группы пользователей, строка
// id организации, целое число
// количество пользователей, целое число
// всевидящие, булевое поле
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"admin": false,
"id": 22,
"name": "Название",
"organizationId": 162,
"usersCount": 0,
"wheel": false
}
// администрирование, булевое поле
// id группы пользователей, целое число
// название группы пользователей, строка
// id организации, целое число
// количество пользователей, целое число
// всевидящие, булевое поле
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование группы пользователей
Доступно только для всевидящих администраторов
PUT /users/groups/{id}
Структура запроса:
PUT /users/groups/23?token=bw3ty3h46yth
id: id группы пользователей
token: ключ доступа
Формат: json
{
"admin": false,
"carGroups": [61],
"geoportalLogin": "login",
"geoportalPassword": "password",
"id": 23,
"name": "Имя",
"organizationId": "17",
"usersCount": 0,
"wheel": false
}
// администрирование, булевое поле
// id групп ТС, массив
// логин на GeoPortal, строка
// пароль на GeoPortal, строка
// id группы пользователей, целое число
// название группы пользователей, строка
// id организации, целое число
// количество пользователей, целое число
// всевидящие, булевое поле
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"admin": false,
"id": 23,
"name": "Имя",
"organizationId": 17,
"usersCount": 0,
"wheel": false
}
// администрирование, булевое поле
// id группы пользователей, целое число
// название группы пользователей, строка
// id организации, целое число
// количество пользователей, целое число
// всевидящие, булевое поле
Статус: 400 — ошибка в запросе
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление группы пользователей
Доступно только для всевидящих администраторов
DELETE /users/groups/{id}
Структура запроса:
DELETE /users/groups/16?token=bw3ty3h46yth
id: id группы пользователей
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Экспорт групп пользователей
Доступно только для всевидящих администраторов
GET /users/groups.xlsx
Структура запроса:
GET /users/groups.xlsx?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — carGroups (before delete /wheel)
Группы ТС
Список групп ТС
GET /cars/groups
Структура запроса:
GET /cars/groups?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
"id": 703,
"name": "003",
"notes": null,
"organizationId": 1
}
]
// массив объектов с информацией по группе
// id группы, целое число
// название группы, строка
// описание группы, строка
// id организации, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список групп ТС (без фильтрации)
Доступно только для всевидящих пользователей
GET /cars/groups/wheel
Структура запроса:
GET /cars/groups/wheel?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
"id": 703,
"name": "003",
"notes": null,
"organizationId": 1
}
]
// массив объектов с информацией по группе
// id группы, целое число
// название группы, строка
// описание группы, строка
// id организации, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование группы
Доступно только для пользователей с правами администратора
PUT /cars/groups/{id}
Структура запроса:
PUT /cars/groups/4901?token=bw3ty3h46yth
id: id группы
token: ключ доступа
Формат: json
{
"id": 4901,
"name": "name",
"notes": "",
"organizationId": "1143"
}
// id группы, целое число
// название группы, строка
// описание группы, строка
// id организации, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 5000,
"name": "name",
"notes": "",
"organizationId": "1143"
}
// id группы, целое число
// название группы, строка
// описание группы, строка
// id организации, целое число
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление группы
Доступно только для пользователей с правами администратора
POST /cars/groups
Структура запроса:
POST /cars/groups?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"name": "name",
"organizationId": "10"
}
// название группы, строка
// id организации, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 4901,
"name": "name",
"notes": "",
"organizationId": "1143"
}
// id группы, целое число
// название группы, строка
// описание группы, строка
// id организации, целое число
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление группы
Доступно только для пользователей с правами администратора
DELETE /cars/groups/{groupId}
Структура запроса:
DELETE /cars/groups/92?token=bw3ty3h46yth
groupId: id группы
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Экспорт групп ТС
Доступно только для пользователей с правами администратора
GET /cars/groups.xlsx
Структура запроса:
GET/ cars/groups.xlsx?token=gtr543lpas87
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
Успешное выполнение запроса
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список ТС группы
GET /cars/groups/{groupId}/cars
Структура запроса:
GET /cars/groups/702/cars?token=bw3ty3h46yth
groupId: id группы
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
"id": 4158,
"name": "testDrivers",
"glonassId": 354235,
"view": true,
"lastUpdate": null,
"onService": false,
"iconStandard": true,
"iconIndex": 223,
"toDelete": false,
"markId": 150,
"modelId": 1621,
"groupId": 702,
"speed": 0,
"direction": 0,
"lat": 0,
"lon": 0,
"carNo": "235235",
"isStopped": false,
"tagsIds": [ ],
"organizationId": 1
}
]
// массив ТС группы
// id ТС, целое число
// название, строка
// ГЛОНАСС id, целое число
// видима ли, булевое поле
// последнее обновление, timestamp
// если true - ТС на сервисном обслуживании, булевое поле
// стандартная иконка, булевое поле
// индекс иконки, целое число
// ТС в процессе удаления, булевое поле
// id марки, целое число
// id модели, целое число
// id группы, целое число
// текущая скорость, целое число
// угол, под которым вошло ТС, целое число
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
// номер ТС, строка
// остановлена, булевое поле
// id меток, массив
// id организации, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список групп машин ( с более быстрой загрузкой, т.к. без фильтрации)
GET /cars/groups/all
Структура запроса:
GET /cars/groups/all?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
"id": 703,
"name": "003",
"notes": null,
"organizationId": 1
}
]
// массив объектов с информацией по группе
// id группы, целое число
// название группы, строка
// описание группы, строка
// id организации, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество доступных групп
GET /cars/groups/count
Структура запроса:
GET /cars/groups/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат:text
{
10
}
// количество доступных групп
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Все существующие группы
Доступно только для главных (всевидящих) администраторов
GET /cars/groups/wheel
Структура запроса:
GET /cars/groups/wheel?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
"id": 703,
"name": "003",
"notes": null,
"organizationId": 1
}
]
// массив объектов с информацией по группе
// id группы, целое число
// название группы, строка
// описание группы, строка
// id организации, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — cars (before delete /wheel)
Транспортные средства
Список ТС
GET /cars
Структура запроса:
GET /cars?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 1,
"name": "Название ТС",
"glonassId": 1298,
"view": true,
"lastUpdate": 1400843454000,
"onService": false,
"iconStandard": true,
"iconIndex": 14,
"toDelete": false,
"markId": 37,
"modelId": 647,
"groupId": 62,
"speed": 0.0,
"direction": 0,
"lat": 0.0,
"lon": 0.0,
"carNo": "А343ВВ 116RUS",
"organizationId": 62,
"isStopped": false,
"tagsIds": [1,21]
},...]
// id ТС, целое число
// название, строка
// id ГЛОНАСС, целое число
// является ли видимой, булевое поле
// последнее обновление, timestamp
// ТС на сервисном обслуживании, булевое поле
// стандартная иконка, булевое поле
// индекс иконки, целое число
// ТС в процессе удаления, булевое поле
// id марки, целое число
// id модели, целое число
// id группы, целое число
// текущая скорость, число с плавающей точкой
// угол, под которым вошло ТС, целое число
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
// номер ТС, строка
// id организации, целое число
// остановлена, булевое поле
// id меток, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список ТС (без фильтрации)
Доступно только для всевидящих пользователей
GET /cars/wheel
Структура запроса:
GET /cars/wheel?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
"id": 3906,
"name": "autotracker",
"glonassId": 386,
"view": true,
"lastUpdate": null,
"projectPoints": false,
"onService": false,
"iconStandard": true,
"iconIndex": 1,
"toDelete": false,
"markId": 23,
"modelId": 42,
"groupId": 1,
"speed": 0,
"direction": 0,
"lat": 0,
"lon": 0,
"carNo": "3906",
"organizationId": 1,
"isStopped": false,
"tagsIds": [ ]
}
]
// массив объектов с ТС
// id ТС, целое число
// название, строка
// id ГЛОНАСС, целое число
// является ли видимой, булевое поле
// последнее обновление, timestamp
// ТС на сервисном обслуживании, булевое поле
// стандартная иконка, булевое поле
// индекс иконки, целое число
// машина в процессе удаления, булевое поле
// id марки, целое число
// id модели, целое число
// id группы, целое число
// текущая скорость, целое число
// угол, под которым вошло ТС, целое число
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
// номер ТС, строка
// id организации, целое число
// остановлена, булевое поле
// id меток, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество ТС
GET /cars/count
Структура запроса:
GET /cars/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: text
1103
// количество ТС
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Информация о ТС по id
GET /cars/{id}
Структура запроса:
GET /cars/3889?token=bw3ty3h46yth
id: id TC
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 3889,
"name": "autotracker",
"glonassId": 369,
"view": true,
"group": {
"id": 1,
"name": "Градосервис",
"notes": "",
"organizationId": 1
},
"lastUpdate": 1381200202000,
"onService": false,
"devphone": "+79131558214",
"devimei": null,
"iconStandard": true,
"iconIndex": 1,
"toDelete": false,
"info": {
"id": {
"carId": 369,
"data": 1381200202000
},
"speed": 0,
"direction": 0,
"height": 0,
"odometr": 0,
"gpsCount": 0,
"glonassCount": 0,
"sysData": 1381200245287,
"lat": 54.9106,
"lon": 85.642
},
"carInfo": {
"carId": 3889,
"mark": {
"id": 23,
"name": "ТестМарка"
},
"model": {
"id": 42,
"name": "ТестМодель",
"mark": {
"id": 23,
"name": "ТестМарка"
},
"expenseOn100km": 1100,
"maxTank": 999,
"motohoursStop": 1,
"motohoursMove": 1.13,
"markId": 23
},
"kmNextTo": 0,
"carNo": "3889",
"notes": "0",
"customFields": {
}
},
"stopped": {
"carId": 3889,
"stoped": true,
"stopedBegin": 1381137338000,
"stopEvent": 249950
},
"tags": [ ],
"motohours": {
"carId": 3889,
"stop": null,
"move": null
},
"markId": 23,
"modelId": 42,
"hasPic": false,
"driversIds": [
541,
441
],
"organizationId": 374,
"tagsIds": [ ]
}
// id ТС, целое число
// название, строка
// id ГЛОНАСС, целое число
// является ли видимой, булевое поле
// группа ТС, объект
// id группы, целое число
// название группы, строка
// описание группы, строка
// id организации, целое число
// последнее обновление, timestamp
// на сервисном обслуживании, булевое поле
// номер телефона блока навигации, строка
// imei блока навигации, строка
// стандартная иконка, булевое поле
// индекс иконки, целое число
// в процессе удаления, булевое поле
// дополнительная информация, объект
// информация об id, объект
// id ТС, целое число
// данные, целое число
// текущая скорость, целое число
// угол вхождения ТС, целое число
// высота точки, целое число
// показатели одометра, целое число
// количество GPS спутников, целое число
// количество ГЛОНАСС спутников, целое число
// время, в которое точка записывается в базу данных, timestamp
// ширина, число с плавающей точкой
// долгота, число с плавающей точкой
// информация о ТС, объект
// id ТС, целое число
// марка ТС, объект
// id марки, целое число
// название марки, строка
// модель ТС, объект
// id модели, целое число
// название модели, строка
// марка ТС, объект
// id марки, целое число
// название марки, строка
// расход на 100км, целое число
// объем бака (в литрах), целое число
// коэффициент моточасов на стоянке, число с плавающей точкой
// коэффициент моточасов при движении, число с плавающей точкой
// id марки, целое число
// км до ТО, целое число
// номер ТС, строка, строка
// описание, строка, строка
// дополнительные поля, объект
// информация об остановке, объект
// id ТС, целое число
// остановлена, булевое поле
// время остановки, timestamp
// id события, целое число
// метки, массив
// моточасы, объект
// id ТС, целое число
// коэффициент моточасов на стоянке, целое число
// коэффициент моточасов при движении, целое число
// id марки, целое число
// id модели, целое число
// наличие картинки, булевое поле
// id водителей, массив
// id организации, целое число
// id меток, массив
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Информация о нескольких ТС по ID
GET /cars/in/{id}
Структура запроса:
GET /cars/in/3889,5479,457?token=bw3ty3h46yth
id: id TC (через запятую)
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 3889,
"name": "Название ТС",
"glonassId": 51585,
"view": true,
"lastUpdate": null,
"onService": false,
"iconStandard": true,
"iconIndex": 45,
"toDelete": false,
"markId": 1,
"modelId": 1,
"groupId": 322,
"speed": 0.0,
"direction": 0,
"lat": 0.0,
"lon": 0.0,
"organizationId": 242,
"carNo": "К983ЕЕ",
"isStopped": false,
"tagsIds": []
},...]
// id ТС, целое число
// название ТС, строка
// ГЛОНАСС id, целое число
// является ли видимым, булевое поле
// дата последнего обновления, timestamp
// на сервисе, булевое поле
// стандартная иконка, булевое поле
// индекс иконки, целое число
// в процессе удаления, булевое поле
// id марки, целое число
// id модели, целое число
// id группы, целое число
// скорость, число с плавающей точкой
// направление, целое число
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
// id организации, целое число
// номер ТС, строка
// на остановке, булевое поле
// id меток, массив
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Информация о зоне, в которой находится выбранное ТС
GET /cars/{id}/zones/current
Структура запроса:
GET /cars/2167/zones/current?token=bw3ty3h46yth
id: id TC
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 2167,
"geom": {
"type": "Polygon",
"coordinates": [[58.27148438,60.06484046],
[41.74804688,59.08573857],
[42.62695313,50.34546041],
[58.09570313,50.56928287],
[58.27148438,60.06484046]]
},
"name": "BASENOT",
"color": "7aff33",
"active": true,
"isBase": false,
"organizationId": 102,
"coordinates": [[58.27148438,60.06484046],
[41.74804688,59.08573857],
[42.62695313,50.34546041],
[58.09570313,50.56928287],
[58.27148438,60.06484046]],
"carsIds": [121748,121714,121710,121716,121711,121715,
007,135293]
}]
// id ТС, целое число
// информация о геометрии, объект
// тип геометрии, строка
// координаты, массив
// название, строка
// цвет, строка
// является активным, булевое поле
// является базой, булевое поле
// id организации, целое число
// координаты, массив
// id ТС, массив
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование ТС
Доступно только для пользователей с правами администратора
PUT /cars/{id}
Структура запроса:
PUT /cars/4339?token=bw3ty3h46yth
id: id ТС
token: ключ доступа
Формат: json
{
"carNo": "В653АА 177rus",
"devphone": "5214578",
"driversIds": [],
"glonassId": 113112,
"groupId": 2682,
"kmNextTo": 1520,
"markId": 208,
"modelId": 1688,
"name": "Новое ТС организации",
"notes": "New description"
}
// номер ТС, строка
// телефон блока, строка
// id водителей, массив
// ГЛОНАСС id, целое число
// id группы, целое число
// км до следующего ТО, целое число
// id марки, целое число
// id модели, целое число
// название ТС, строка
// примечания, строка
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 136773,
"name": "Новое ТС организации",
"glonassId": 113112,
"view": true,
"group": {
"id": 2682,
"name": "Группа ТС",
"notes": "",
"organizationId": 137
},
"lastUpdate": 1436968856000,
"onService": false,
"devphone": "5214578",
"devimei": null,
"iconStandard": true,
"iconIndex": 1,
"toDelete": false,
"info": {
"id": {
"carId": 136773,
"data": 1436968856000
},
"speed": 31.0,
"direction": 277,
"height": 100,
"odometr": 31,
"gpsCount": 0,
"glonassCount": 0,
"sysData": 1436968854940,
"lat": 55.7269264101253,
"lon": 49.045337677002
},
"carInfo": {
"carId": 136773,
"mark": {
"id": 208,
"name": "Audi"
},
"model": {
"id": 1688,
"name": "model",
"mark": {
"id": 208,
"name": "TT"
},
"expenseOn100km": 100.0,
"maxTank": 200,
"motohoursStop": 3.0,
"motohoursMove": 2.0,
"markId": 208
},
"kmNextTo": 1520.0,
"carNo": "in car",
"notes": "New description",
"customFields": {
}
},
"stopped": {
"carId": 136773,
"stoped": false,
"stopedBegin": 1436958766000,
"stopEvent": null
},
"tags": [],
"motohours": {
"carId": 136773,
"stop": null,
"move": null
},
"markId": 208,
"modelId": 1688,
"hasPic": false,
"driversIds": [],
"organizationId": 137,
"tagsIds": []
}
// id ТС, целое число
// название ТС, строка
// ГЛОНАСС id, целое число
// является ли видимым, булевое поле
// информация о группе, объект
// id группы, целое число
// название группы, строка
// описание группы, строка
// id организации, целое число
// дата последнего обновления, timestamp
// находится на ТО, булевое поле
// номер телефона блока навигации, строка
// imei блока навигации, целое число
// стандартная иконка, булевое поле
// индекс иконки, целое число
// в процессе удаления, булевое поле
// дополнительная информация, объект
// информация об id, объект
// id ТС, целое число
// данные
// скорость, число с плавающей точкой
// направление, целое число
// высота точки, целое число
// показания одометра, целое число
// число gps, целое число
// число глонасс, целое число
// системное время, timestamp
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
// информация о ТС, объект
// id ТС, целое число
// информация о марке, объект
// id марки, целое число
// название марки, строка
// информация о модели, объект
// id модели, целое число
// название модели, строка
// информация о марке модели, объект
// id марки, целое число
// название марки, строка
// расход на 100 км, число с плавающей точкой
// максимальный объем бака, целое число
// коэффициент моточасов на остановке, число с плавающей точкой
// коэффициент моточасов в движении, число с плавающей точкой
// id марки, целое число
// км до следующего ТО, число с плавающей точкой
// номер ТС, строка
// примечания, строка
// дополнительные поля
// информация об остановках ТС, объект
// id ТС, целое число
// ТС остановилось, булевое поле
// время начала остановки, timestamp
// событие остановки
// метки, массив
// моточасы, объект
// id ТС, целое число
// коэффициент при остановке, число с плавающей точкой
// коэффициент при движении, число с плавающей точкой
// id марки, целое число
// id модели, целое число
// есть картинка, булевое поле
// id водителей, массив
// id организации, целое число
// id меток, массив
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление ТС
Доступно только для пользователей с правами администратора
POST /cars
Структура запроса:
POST /cars?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"carNo": "21321",
"devphone": "1425265",
"driversIds": [],
"glonassId": "25252321",
"groupId": "4901",
"iconIndex": 222,
"kmNextTo": "2342",
"markId": "150",
"modelId": "1621",
"name": "new name",
"notes": "",
"pic": null,
"tagsIds": [1942, 1501]
}
// номер ТС, строка
// номер телефона блока навигации, строка
// id водителей, массив
// ГЛОНАСС id, целое число
// id группы, целое число
// индекс иконки, целое число
// км до ТО, целое число
// id марки, целое число
// id модели, целое число
// название, строка
// описание, строка
// картинка, строка
// id меток, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"carInfo": {
"carId": 4339,
"carNo": "0000001",
"kmNextTo": 0,
"mark": {
"id": 410,
"name": "000 MArk from all org ",
},
"model": {
"expenseOn100km": 11,
"id": 1680,
"mark": {
"id": 410,
"name": "000 MArk from all org ",
},
"markId": 410,
"maxTank": 100,
"motohoursMove": 1,
"motohoursStop": 1,
"name": "11",
},
"notes": "",
},
"devimei": null,
"devphone": "",
"direction": 0,
"driversIds": [],
"glonassId": 100000,
"group": {
"extGroup": null,
"id": 701,
"name": "001",
"notes": null,
"organizationId": 1143,
"view": true,
},
"hasPic": false,
"iconIndex": 1,
"iconStandard": true,
"id": 4339,
"info": null,
"lastUpdate": null,
"markId": "410",
"modelId": "1680",
"motohours": {
"carId": 4339,
"move": null,
"stop": null,
},
"name": "00000005",
"onService": false,
"projectPoints": false,
"stopped": {
"carId": 4339,
},
"tags": [],
"tagsIds": null,
"toDelete": false,
"view": true
}
// информация о ТС
// id ТС, целое число
// номер ТС, строка
// км до ТО, целое число
// марка ТС, строка
// id марки, целое число
// название марки, строка
// модель ТС, строка
// расход на 100км, целое число
// id модели, целое число
// марка ТС, строка
// id марки, целое число
// название марки, строка
// id марки, целое число
// объем бака (в литрах), целое число
// коэффициент моточасов на стоянке, целое число
// коэффициент моточасов при движении, целое число
// название модели, строка
// описание, строка
// imei блока навигации, целое число
// номер телефона блока навигации, строка
// угол, под которым вошло ТС, целое число
// id водителей, массив
// ГЛОНАСС id, целое число
// объект группы
// id группы, целое число
// название группы, строка
// описание группы, строка
// id организации, целое число
// видима ли, булевое поле
// наличие картинки, булевое поле
// индекс иконки, целое число
// стандартная иконка, булевое поле
// id ТС, целое число
// информация, строка
// последнее обновление, timestamp
// id марки, целое число
// id модели, целое число
// объект моточасов
// id ТС, целое число
// коэффициент моточасов при движении, целое число
// коэффициент моточасов на стоянке, целое число
// название ТС, строка
// на сервисном обслуживании, булевое поле
// id ТС, целое число
// метки, массив
// id меток, массив
// в процессе удаления, булевое поле
// видима ли, булевое поле
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление ТС
Доступно только для пользователей с правами администратора
DELETE /cars/{id}
Структура запроса:
DELETE /cars/51?token=bw3ty3h46yth
id: id ТС
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Экспорт ТС
Доступно только для пользователей с правами администратора
GET /cars.xlsx
Структура запроса:
GET /cars.xlsx?token=gtr543lpas87
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
Успешное выполнение запроса
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Фотография ТС
GET /cars/{id}/pic
Структура запроса:
GET /cars/67/pic?token=bw3ty3h46yth
id: id ТС
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: image/png
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Уменьшенная фотография ТС
GET /cars/{id}/thumb
Структура запроса:
GET/cars/23/thumb?token=gtr543lpas87
id: id ТС
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: image/png
Успешное выполнение запроса
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — JasperReports
JasperReports
JasperReports — это Java-библиотека для создания отчётов. На основе XML-шаблонов отчётов генерируются готовые для печати документы, консолидирующие данные из различных источников, в том числе JDBC. Отчёты могут выводиться на экран, принтер, либо в форматы PDF, RTF, HTML, XLS, CSV и XML. Основной частью шаблона является SQL-запрос, который указывает какие данные необходимо выбрать из базы данных для генерации отчёта. В XML-шаблоне допустимо применение стилей и выражений (для проверки или вычисления результата). Также возможна группировка данных по требуемому полю.
По шаблонам отчетов JasperReports можно составлять отчеты для отдельного ТС, нескольких ТС, групп ТС, а также составлять дополнительные отчеты.
Automap — rest — error 400
Ошибка 400 Bad Request
В запросе обнаружена синтаксическая ошибка.
Формат: text/plain
Содержание ошибки:
{
"%field_name_1%": [
"%reason_1%"
],
"%field_name_2%": [
"%reason_2%"
]
}
// поле с ошибкой
// причина возникновения ошибки
Automap — rest — authorization-token
Авторизация с последующим использованием ключа доступа
Авторизация
POST /token/auth
Структура запроса:
Формат: json
{
"login": "login",
"password": "password"
}
// логин, строка
// пароль, строка
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"token": "ethryhetyjtyj",
"refreshToken": "ethryhetyjtyj",
"ttl": 3600
}
// ключ доступа, строка
// ключ для обновления ключа доступа, строка
// время жизни ключа доступа в секундах, целое число
Статус: 401 — логин или пароль переданы неверно
Формат: text/plain
Содержание ошибки: «Вы ввели неверное имя или пароль!»
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Обновление ключа доступа
GET /token/refresh
Структура запроса:
GET /token/refresh?refreshToken=bw3ty3h46yth
refreshToken:ключ для обновления ключа доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"token": "ethryhetyw4564",
"refreshToken": "yrjryukryukryu",
"ttl": 3600
}
// новый ключ доступа, строка
// новый ключ для обновления ключа доступа, строка
// время жизни ключа доступа в секундах, целое число
Статус: 400 — не передан параметр refreshToken
Формат: text/plain
Содержание ошибки: «Не найден параметр refreshToken»
Статус: 404 — параметр refreshToken не найден в системе
Формат: text/plain
Содержание ошибки: «Данный refreshToken не найден в системе»
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Выход из системы (с удалением ключа доступа)
GET /token/logout
Структура запроса:
GET /token/logout?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки