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
},...]Статус: 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
Содержит описание ошибки
Automap — rest — authorization
Авторизация
Авторизация
POST /users/auth
Структура запроса:
Формат: json
{
"login": "login",
"pass": "pass"
}
// логин, строка
// пароль, строка
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"status": 1
}
Статус: 401 — логин или пароль переданы неверно
Формат: text/plain
Содержание ошибки: «Вы ввели неверное имя или пароль!»
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Выход из системы
GET /users/logout
Структура запроса:
GET /users/logout
Ответ:
Статус: 200 — успешное выполнение
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — daemon
Демон
Список доступных протоколов
GET /daemon/protocols
Структура запроса:
GET /daemon/protocols?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 1,
name: "protocol name",
title: "proto",
listener: true,
receiver: false,
writer: false,
stable: true
}
]
// id протокола
// название протокола
// заголовок
// получение данных
// сбор данных
// отправка данных
// стабильность
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Источники получения данных
GET /daemon/listeners
Структура запроса:
GET /daemon/listeners?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 401,
port: 123,
timezone: 4,
threads: 4,
odometr: true,
reconnectTime: 5,
useDinGauges: false,
useDinAdditionalGauges: true,
useAnalogGauges: false,
useSpeedGauge: false,
name: "Тест",
protocolId: 2
}
]
// массив источников получения данных
// id источника получения данных
// порт
// часовой пояс
// количество потоков
// одометр
// время переподключения
// использование цифровых датчиков
// использование дополнительных цифровых датчиков
// использование аналоговых датчиков
// использование скоростного датчика
// название
// id протокола
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Источник получения данных по id
GET /daemon/listeners/{id}
Структура запроса:
GET /daemon/listeners/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id источника получения данных
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
id: 401,
port: 123,
timezone: 4,
threads: 4,
odometr: true,
reconnectTime: 5,
useDinGauges: false,
useDinAdditionalGauges: true,
useAnalogGauges: false,
useSpeedGauge: false,
name: "Тест",
protocolId: 2
}
// id источника получения данных
// порт
// часовой пояс
// количество потоков
// одометр
// время переподключения
// использование цифровых датчиков
// использование дополнительных цифровых датчиков
// использование аналоговых датчиков
// использование скоростного датчика
// название
// id протокола
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Cоздание источника получения данных
Доступно только для пользователей с правами администратора
POST /daemon/listeners
Структура запроса:
POST /daemon/listeners?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
name: "234",
odometr: false,
port: "2345",
protocolId: "2",
timezone: "0",
useAnalogGauges: false,
useDinAdditionalGauges: false,
useDinGauges: false
}
// название
// одометр
// порт
// id протокола
// часовой пояс
// использование аналоговых датчиков
// использование дополнительных цифровых датчиков
// использование цифровых датчиков
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
id: 541
name: "Тест2"
odometr: false
port: 213
protocol{
id: 1
listener: true
name: "galileo"
receiver: false
stable: true
title: "Галилео"
writer: false
}
protocolId: 1
reconnectTime: 5
threads: 4
timezone: 0
useAnalogGauges: false
useDinAdditionalGauges: false
useDinGauges: false
useSpeedGauge: false
}
// id источника получения данных
// название
// одометр
// порт
// информация о протоколе
// id протокола
// получение данных
// название протокола
// сбор данных
// стабильность
// заголовок
// отправка данных
// id протокола
// время переподключения
// количество потоков
// часовой пояс
// использование аналоговых датчиков
// использование дополнительных цифровых датчиков
// использование цифровых датчиков
// использование скоростного датчика
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование источника получения данных
Доступно только для пользователей с правами администратора
PUT /daemon/listeners/{id}
Структура запроса:
PUT /daemon/listeners/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id источника данных
Формат: json
{
id: 401
name: "Тест"
odometr: false
port: 1231
protocolId: 2
reconnectTime: 5
threads: 4
timezone: 4
useAnalogGauges: false
useDinAdditionalGauges: true
useDinGauges: false
useSpeedGauge: false
}
// id источника получения данных
// название
// одометр
// порт
// id протокола
// время переподключения
// количество потоков
// часовой пояс
// использование аналоговых датчиков
// использование дополнительных цифровых датчиков
// использование цифровых датчиков
// использование скоростного датчика
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
id: 401
name: "Тест"
odometr: false
port: 1231
protocolId: 2
reconnectTime: 5
threads: 4
timezone: 4
useAnalogGauges: false
useDinAdditionalGauges: true
useDinGauges: false
useSpeedGauge: false
}
// id источника получения данных
// название
// одометр
// порт
// id протокола
// время переподключения
// количество потоков
// часовой пояс
// использование аналоговых датчиков
// использование дополнительных цифровых датчиков
// использование цифровых датчиков
// использование скоростного датчика
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление источника получения данных
Доступно только для пользователей с правами администратора
DELETE /daemon/listeners/{id}
Структура запроса:
DELETE /daemon/listeners/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id источника получения данных
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество источников получения данных
GET /daemon/listeners/count
Структура запроса:
GET /daemon/listeners/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
3
// количество источников получения данных
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Сбор данных
GET /daemon/receivers
Структура запроса:
GET /daemon/receivers?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
port: 5690,
login: "adminGR",
password: "6F5Wx4",
reconnectTime: 5,
useEnginePort: true,
defaultEnginePort: 2,
timezone: 0,
useDinGauges: true,
useDinAdditionalGauges: false,
useAnalogGauges: true,
useSpeedGauge: false,
name: null,
defaultGroupId: 1,
defaultModelId: 42,
defaultMarkId: 23,
protocolId: 27 id: 413,
host: "81.211.58.244",
}
]
// массив источников сбора данных
// порт
// логин
// пароль
// время переподключения
// использование порта зажигания
// порт зажигания по умолчанию
// часовой пояс
// использование цифровых датчиков
// использование дополнительных цифровых датчиков
// использование аналоговых датчиков
// использование скоростного датчика
// название
// id группы по умолчанию
// id модели по умолчанию
// id марки по умолчанию
// id протокола по умолчанию
// хост
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Источник сбора данных
GET /daemon/receivers/{id}
Структура запроса:
GET /daemon/receivers/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id источника сбора данных
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
id: 413,
host: "81.211.58.244",
port: 5690,
login: "adminGR",
password: "6F5Wx4",
reconnectTime: 5,
useEnginePort: true,
defaultEnginePort: 2,
timezone: 0,
useDinGauges: true,
useDinAdditionalGauges: false,
useAnalogGauges: true,
useSpeedGauge: false,
name: null,
defaultGroupId: 1,
defaultModelId: 42,
defaultMarkId: 23,
protocolId: 27
}
// id источника сбора данных
// хост
// порт
// логин
// пароль
// время переподключения
// использование порта зажигания
// порт зажигания по умолчанию
// часовой пояс
// использование цифровых датчиков
// использование дополнительных цифровых датчиков
// использование аналоговых датчиков
// использование скоростного датчика
// название
// id группы по умолчанию
// id модели по умолчанию
// id марки по умолчанию
// id протокола по умолчанию
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Создание источника сбора данных
Доступно только для пользователей с правами администратора
POST /daemon/receivers
Структура запроса:
POST /daemon/receivers?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
defaultEnginePort: "123",
defaultGroupId: "702",
defaultMarkId: "29",
defaultModelId: "108",
host: "213.ru",
login: "123",
name: "213",
password: "123123",
port: "213",
protocolId: "21",
reconnectTime: "5",
timezone: "0",
useAnalogGauges: false,
useDinAdditionalGauges: true,
useDinGauges: false,
useEnginePort: true,
useSpeedGauge: false
}
// порт зажигания по умолчанию
// id группы по умолчанию
// id марки по умолчанию
// id модели по умолчанию
// хост
// логин
// название
// пароль
// порт
// id протокола
// время переподключения
// часовой пояс
// использование аналоговых датчиков
// использование дополнительных цифровых датчиков
// использование цифровых датчиков
// использование порта зажигания
// использование скоростного датчика
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
defaultEnginePort: "123",
defaultGroupId: "702",
defaultMarkId: "29",
defaultModelId: "108",
host: "213.ru",
id: 554,
login: "123",
name: "213",
password: "123123",
port: "213",
protocol{
id: 21,
listener: false,
name: "autotracker",
receiver: true,
stable: true,
title: "РНТ (АвтоТрекер)",
writer: false
}
protocolId: "21",
reconnectTime: "5",
timezone: "0",
useAnalogGauges: false,
useDinAdditionalGauges: true,
useDinGauges: false,
useEnginePort: true,
useSpeedGauge: false
}
// порт зажигания по умолчанию
// id группы по умолчанию
// id марки по умолчанию
// id модели по умолчанию
// хост
// id источника сбора данных
// логин
// название
// пароль
// порт
// информация о протоколе
// id протокола
// получение данных
// название протокола
// сбор данных
// стабильность
// заголовок
// отправка данных
// id протокола
// время переподключения
// часовой пояс
// использование аналоговых датчиков
// использование дополнительных цифровых датчиков
// использование цифровых датчиков
// использование порта зажигания
// использование скоростного датчика
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование источника сбора данных
Доступно только для пользователей с правами администратора
PUT /daemon/receivers/{id}
Структура запроса:
PUT /daemon/receivers/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id источника сбора данных
Формат: json
{
defaultEnginePort: null
host: "213.ru"
id: 514
login: "213213"
name: "12321321"
password: "123213"
port: 12
reconnectTime: 5
timezone: 0
useAnalogGauges: false
useDinAdditionalGauges: false
useDinGauges: false
useEnginePort: false
useSpeedGauge: false
}
// порт зажигания по умолчанию
// хост
// id источника сбора данных
// логин
// название
// пароль
// порт
// время переподключения
// часовой пояс
// использование аналоговых датчиков
// использование дополнительных цифровых датчиков
// использование цифровых датчиков
// использование порта зажигания
// использование скоростного датчика
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
defaultEnginePort: null,
host: "213.ru",
id: 514,
login: "213213",
name: "12321321",
password: "123213",
port: 12,
protocolId : 2,
reconnectTime: 5,
timezone: 0,
useAnalogGauges: false,
useDinAdditionalGauges: false,
useDinGauges: false,
useEnginePort: false,
useSpeedGauge: false
}
// порт зажигания по умолчанию
// хост
// id источника сбора данных
// логин
// название
// пароль
// порт
// id протокола
// время переподключения
// часовой пояс
// использование аналоговых датчиков
// использование дополнительных цифровых датчиков
// использование цифровых датчиков
// использование порта зажигания
// использование скоростного датчика
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление источника сбора данных
Доступно только для пользователей с правами администратора
DELETE /daemon/receivers/{id}
Структура запроса:
DELETE /daemon/receivers/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id источника сбора данных
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество источников сбора данных
GET /daemon/receivers/count
Структура запроса:
GET /daemon/receivers/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
4
// количество источников сбора данных
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Отправка данных
GET /daemon/writers
Структура запроса:
GET /daemon/writers?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 1401,
host: "1.1.1.1",
port: 1123,
path: "123",
needAuth: false,
authUser: null,
authPassword: null,
reconnectTime: 5,
resendAttempts: 3,
loggerTimeout: 60,
name: "11111",
rightId: null,
tagId: 1501,
protocolId: 13
}
]
// массив источников отправки данных
// id источника отправки данных
// хост
// порт
// путь
// требуется авторизация на сервере
// логин
// пароль
// время переподключения
// максимальное количество неудачных попыток отправки данных
// период времени, для которого будет подсчитано и записано в лог
// количество отправленных сообщений. Измеряется в секундах
// название
// id прав
// id метки
// id протокола
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Настройки отправки данных по id
GET /daemon/writers/{id}
Структура запроса:
GET /daemon/writers/{id}?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
id: 1401,
host: "1.1.1.1",
port: 1123,
path: "123",
needAuth: false,
authUser: null,
authPassword: null,
reconnectTime: 5,
resendAttempts: 3,
loggerTimeout: 60,
name: "11111",
rightId: null,
tagId: 1501,
protocolId: 13
}
// id источника отправки данных
// хост
// порт
// путь
// требуется авторизация на сервере
// логин
// пароль
// время переподключения
// максимальное количество неудачных попыток отправки данных
// период времени, для которого будет подсчитано и записано в лог
// количество отправленных сообщений. Измеряется в секундах
// название
// id прав
// id метки
// id протокола
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Создание настройки отправки данных
Доступно только для пользователей с правами администратора
POST /daemon/writers
Структура запроса:
POST /daemon/writers?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
host: "1.1.1.1",
name: "2121",
needAuth: false,
path: "123",
port: "123",
protocolId: "11",
reconnectTime: "5",
resendAttempts: "3",
rightId: "1063"
}
// хост
// название
// требуется авторизация на сервере
// путь
// порт
// id протокола
// время переподключения
// максимальное количество неудачных попыток отправки данных
// id прав
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
authPassword: null
authUser: null
host: "12.ru"
id: 1561
loggerTimeout: 60
name: "Тест1"
needAuth: false
path: "213"
port: 1233
protocol: {
id: 11
listener: true
name: "native"
receiver: false
stable: true
title: "Внутренний формат"
writer: true
}
protocolId: 11
reconnectTime: 5
resendAttempts: 3
right: {
admin: false
id: 43
name: "12345"
organization: {
id: 1
info: {
address: ""
email: ""
homepage: ""
inn: ""
kpp: ""
orgId: 1
phone: ""
}
mapAerialProvider: "MICROSOFT_AERIAL"
mapExtent: "55.712, 55.603, 49.4361, 48.73"
mapRoadProvider: "MAPKZN"
name: "ГрадоСервис ООО"
order: 100
toDelete: false
}
usersCount: 2
wheel: false
}
rightId: 43
tag: null
tagId: null
}
// пароль
// пользовател
// хост
// id
// период времени, для которого будет подсчитано и записано в лог
// количество отправленных сообщений. Измеряется в секундах
// название
// требуется авторизация на сервере
// путь
// порт
// информация о протоколе
// id протокола
// получение данных
// название протокола
// сбор данных
// стабильность
// заголовок
// отправка данных
// id протокола
// время переподключения
// максимальное количество неудачных попыток отправки данных
// администрирование
// id
// название
// информация об организации
// id организации
// адрес
// email
// домашняя страница
// ИНН
// КПП
// id организации
// телефон
// видимая часть карты(координаты левой нижней и правой верхней точек)
// провайдер карты дорог
// название
// порядок организации
// в процессе на удаление
// количество пользователей
// всевидящий
// id прав
// метка
// id метки
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование настройки отправки данных
Доступно только для пользователей с правами администратора
PUT /daemon/writers/{id}
Структура запроса:
PUT /daemon/writers/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id настройки отправки данных
Формат: json
{
authPassword: null
authUser: null
host: "12.ru"
id: 1481
loggerTimeout: 60
name: "1"
needAuth: false
path: "213"
port: 123
protocolId: 14
reconnectTime: 5
resendAttempts: 3
rightId: 43
tagId: null
}
// пароль
// логин
// хост
// id источника отправки данных
// период времени, для которого будет подсчитано и записано в лог
// количество отправленных сообщений. Измеряется в секундах
// название
// требуется авторизация на сервере
// путь
// порт
// id протокола
// время переподключения
// максимальное количество неудачных попыток отправки данных
// id прав
// id метки
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
authPassword: null
authUser: null
host: "12.ru"
id: 1561
loggerTimeout: 60
name: "Тест11"
needAuth: false
path: "213"
port: 1233
protocolId: 11
reconnectTime: 5
resendAttempts: 3
rightId: 43
tagId: null
}
// пароль
// пользователь
// хост
// id
// период времени, для которого будет подсчитано и записано в лог
// количество отправленных сообщений. Измеряется в секундах
// название
// требуется авторизация на сервере
// путь
// порт
// id протокола
// время переподключения
// максимальное количество неудачных попыток отправки данных
// id прав
// id метки
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление настройки отправки данных
Доступно только для пользователей с правами администратора
DELETE /daemon/writers/{id}
Структура запроса:
DELETE /daemon/writers/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id настройки отправки данных
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество настроек отправки данных
GET /daemon/writers/count
Структура запроса:
GET /daemon/writers/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
4
// количество настроек отправки данных
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — geozones
Геозоны
Получение списка геозон
GET /zones
Структура запроса:
GET /zones?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 17,
"geom": {
"type": "Polygon",
"coordinates": [[47.85021186,55.99901992],
[47.85045862,55.99903792],
[47.85022259,55.99921791],
[47.85021186,55.99901992]]
},
"name": "Геозона",
"color": "66ff33",
"active": true,
"isBase": false,
"organizationId": 10,
"coordinates":[[47.85021185874939,55.99901992242232],
[47.85045862197876,55.99903792134154],
[47.85022258758545,55.9992179100726],
[47.85021185874939,55.99901992242232]],
"carsIds": []
},...]
// id геозоны, целое число
// информация о геометрии, объект
// тип геометрии, строка
// координаты
// название, строка
// цвет, строка
// является активной, булева переменная
// является базой, булева переменная
// id организации, целое число
// координаты, массив
// id ТС, массив
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление геозоны
Доступно только для пользователей с правами администратора
POST /zones
Структура запроса:
POST /zones?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"cars": [],
"color": "33eeff",
"geom": {
"coordinates": [[48.451080322265625,56.9752985148217],
[48.871307373046875,56.9820339049709]],
"type": "Polygon"
},
"isBase": true,
"name": "Новая зона контроля",
"organizationId": 1
}
// id ТС, целое число
// цвет геозоны, строка
// информация о геометрии
// координаты, массив
// тип геометрии, строка
// является базой, булева переменная
// название зоны, строка
// id организации, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 230,
"geom": {
"type": "Polygon",
"coordinates": [[48.45108032,56.97529851],
[48.87130737,56.9820339]]
},
"name": "Новая зона контроля",
"color": "33eeff",
"active": true,
"isBase": true,
"organizationId": 1,
"coordinates": [[48.451080322265625,56.9752985148217],
[48.871307373046875,56.9820339049709]],
"carsIds": []
}
// id геозоны, целое число
// информация о геометрии, объект
// тип геометрии, строка
// координаты, массив
// название, строка
// цвет, строка
// является активной, булева переменная
// является базой, булева переменная
// id организации, целое число
// координаты, массив
// id ТС, массив
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование геозоны
Доступно только для пользователей с правами администратора
PUT /zones/{id}
Структура запроса:
PUT /zones/621?token=gtr543lpas87
id: id геозоны
token: ключ доступа
Структура запроса:
Формат: json
{
"cars": [631,224,634,625,582],
"color": "ffb833",
"geom": {
"coordinates": [[37.65915871,55.74218747],
[37.65933037,55.74081045],
[37.66147614,55.74131778]],
"type": "Polygon"
},
"isBase": false,
"name": "Новое название зоны",
"organizationId": 1
}
// список ТС, прикрепленных к зоне
// цвет зоны, строка
// информация о геометрии, объект
// координаты, массив
// тип геометрии, строка
// является базой, булева переменная
// название зоны, строка
// id организации, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 621,
"geom": {
"type": "Polygon",
"coordinates": [[37.65915871,55.74218747],
[37.65933037,55.74081045],
[37.66147614,55.74131778]]
},
"name": "Новое название зоны",
"color": "ffb833",
"active": true,
"isBase": false,
"organizationId": 1,
"coordinates": [[37.65915871,55.74218747],
[37.65933037,55.74081045],
[37.66147614,55.74131778]],
"carsIds": [631,224,634,625,582]
}
// id геозоны, целое число
// информация о геометрии, объект
// тип геометрии, строка
// координаты, массив
// название геозоны, строка
// цвет геозоны, строка
// активность геозоны, булева переменная
// является базой, булева переменная
// id организации, целое число
// координаты, массив
// id ТС, массив
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление геозоны
Доступно только для пользователей с правами администратора
DELETE /zones/id
Структура запроса:
DELETE /zones/6?token=bw3ty3h46yth
id: id геозоны
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Выбранные ТС для геозоны
GET /zones/id/cars
Структура запроса:
GET /zones/1121/cars?token=bw3ty3h46yth
id: id геозоны
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"carId": 1,
"inZone": true,
"zoneId": 1121
},...]
// id ТС, целое число
// ТС находится в геозоне, булевое поле
// id геозоны, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Принадлежность ТС к геозонам
GET /zones/cars
Структура запроса:
GET /zones/cars?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"inZone": false,
"carId": 4077,
"zoneId": 1201
},...]
// ТС находится в геозоне, булевое поле
// id ТС, целое число
// id геозоны, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — putLists
Путевые листы
Путевые листы по всем ТС за определенный промежуток времени
GET /putlists/{timestampFrom}/{timestampTo}
Структура запроса:
GET /putlists/1385064000000/1385150399000?token=bw3ty3h46yth
timestampFrom: начало промежутка
timestampTo: конец промежутка
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"carId": 3994,
"dateFrom": 1385064000000,
"dateTill": 1385150399000,
"distance": 0
},...]
// id ТС, целое число
// начальное время, timestamp
// конечное время, timestamp
// расстояние, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Путевые лист ТС за определенный период времени
GET /putlists/$carId<[0-9]+>/{timestampFrom}/{timestampTo}
Структура запроса:
GET /putlists/3/1383768000000/1383854399000?token=bw3ty3h46yth
carId: id ТС
timestampFrom: начало промежутка
timestampTo: конец промежутка
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"carId": 3,
"dateFrom": 1383768000000,
"dateTill": 1383854399000,
"distance": 240
},...]
// id ТС, целое число
// начальное время, timestamp
// конечное время, timestamp
// расстояние, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Создание путевого листа
Доступно только для пользователей с правами администратора
POST /putlists
Структура запроса:
POST /putlists?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"carId": 2,
"dateFrom": 1383768000000,
"dateTill": 1383854399000,
"distance": 24
}
// id ТС, целое число
// начальное время, timestamp
// конечное время, timestamp
// расстояние, целое число
Ответ:
Статус: 200 — успешное выполнение
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки