Automap — rest — cars !examples no true
Транспортные средства
Список ТС
GET /cars
Структура запроса:
GET /cars?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации:
GET /cars?onService=true&organizations=1362,1
name: поиск ТС по названию
glonassId: поиск ТС по glonass ID
onService: получение списка ТС, находящихся на обслуживании или нет, в зависимости от заданного значения
devphone: поиск ТС по номеру телефона блока навигации
devimei: поиск ТС по imei блока навигации
stopped: Получение списка ТС, у которых состояние остановки соответствует заданному булевому значению
groups: получение списка ТС, принадлежащих хотя бы одной из заданных групп
organizations: получение списка ТС, принадлежащих хотя бы одной из заданных организаций
Ответ:
Статус: 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: [ ]
}
]
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование ТС
Доступно только для пользователей с правами администратора
PUT /cars/{id}
Структура запроса:
PUT /cars/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id ТС
Формат: 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: ""
}
carNo: "0000001"
devimei: null
devphone: ""
direction: 0
driversIds: []
glonassId: 100000
group: {
extGroup: null
id: 701
name: "001"
notes: null
organizationId: 1143
view: true
}
groupId: "701"
hasPic: false
iconIndex: 1
iconStandard: true
id: 4339
info: null
isStopped: false
kmNextTo: "0"
lastUpdate: null
lat: 0
lon: 0
markId: "410"
modelId: "1680"
motohours: {
carId: 4339
move: null
stop: null
}
motohoursMove: null
motohoursStop: null
name: "00000005"
notes: ""
onService: false
organizationId: 1143
parameters: []
pic: null
projectPoints: false
speed: 0
stopped: {
carId: 4339
}
tags: []
tagsIds: null
toDelete: false
view: true
}
// информация о ТС
// id ТС
// номер ТС
// км до ТО
// марка ТС
// id марки
// название марки
// модель ТС
// расход на 100км
// id модели
// марка ТС
// id марки
// название марки
// id марки
// объем бака (в литрах)
// коэффициент моточасов на стоянке
// коэффициент моточасов при движении
// название модели
// описание
// номер ТС
// imei блока навигации
// номер телефона блока навигации
// угол, под которым вошло ТС
// id водителей
// ГЛОНАСС id
// объект группы
// id группы
// название группы
// описание группы
// id организации
// видима ли
// id группы
// наличие картинки
// индекс иконки
// стандартная иконка
// id ТС
// информация
// остановлена
// км до ТО
// последнее обновление
// широта
// долгота
// 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
isStopped: false
kmNextTo: "0"
lastUpdate: null
markId: "410"
modelId: "1680"
motohours: {
carId: 4339
move: null
stop: null
}
name: "00000005"
onService: false
projectPoints: false
speed: 0
stopped: {
carId: 4339
}
tags: []
tagsIds: null
toDelete: false
view: true
}
// информация о ТС
// id ТС
// номер ТС
// км до ТО
// марка ТС
// id марки
// название марки
// модель ТС
// расход на 100км
// id модели
// марка ТС
// id марки
// название марки
// id марки
// объем бака (в литрах)
// коэффициент моточасов на стоянке
// коэффициент моточасов при движении
// название модели
// описание
// imei блока навигации
// номер телефона блока навигации
// угол, под которым вошло ТС
// id водителей
// ГЛОНАСС id
// объект группы
// id группы
// название группы
// описание группы
// id организации
// видима ли
// наличие картинки
// индекс иконки
// стандартная иконка
// 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 ТС
// информация
// последнее обновление
// id марки
// id модели
// объект моточасов
// id ТС
// коэффициент моточасов при движении
// коэффициент моточасов на стоянке
// название ТС
// на сервисном обсллуживании
// id ТС
// метки
// id меток
// в процессе удаления
// видима ли
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление ТС
Доступно только для пользователей с правами администратора
DELETE /cars/{id}
Структура запроса:
DELETE /cars/{id}
token: ключ доступа
id: id ТС
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список транспортных средств в xlsx файле
GET /cars.xlsx
Структура запроса:
GET /cars.xlsx?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: application/vnd.ms-excel
Статус: 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/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id TC
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
id: 3889,
name: "autotracker",
glonassId: 369,
view: true,
group: {
id: 1,
name: "Градосервис",
notes: "",
extGroup: null,
view: true,
organizationId: 1
},
lastUpdate: 1381200202000,
projectPoints: false,
onService: false,
devphone: "+79131558214",
devimei: null,
iconStandard: true,
iconIndex: 1,
toDelete: false,
info: {
id: {
glonassId: 369,
data: 1381200202000
},
speed: 0,
direction: 0,
height: 0,
odometr: 0,
gpsCount: 0,
glonassCount: 0,
sysData: 1381200245287,
wayid: 0,
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"
},
stopped: {
carId: 3889,
stoped: true,
stopedBegin: 1381137338000,
stopEvent: 249950,
stopNew: false
},
tags: [ ],
motohours: {
carId: 3889,
stop: null,
move: null
},
markId: 23,
modelId: 42,
hasPic: false,
driversIds: [
541,
441
],
tagsIds: [ ]
}
// объект ТС
// id ТС
// название
// ГЛОНАСС id
// видима ли
// объект группы
// id группы
// название группы
// описание группы
// видима ли
// id организации
// последнее обновление
// на сервисном обслуживании
// номер телефона блока навигации
// imei блока навигации
// стандартная иконка
// индекс иконки
// в процессе удаления
// ГЛОНАСС id
// данные
// текущая скорость
// угол, под которым вошло ТС
// высота точки
// показатели одометра
// количество GPS спутников
// количество ГЛОНАСС спутников
// время, в которое точка записывается в базу данных
// ширина
// долгота
// информация о ТС
// id ТС
// объект марки ТС
// id марка
// название марки
// объект модели ТС
// id модели
// название модели
// объект марки ТС
// id марки
// название марки
// расход на 100км
// объем бака (в литрах)
// коэффициент моточасов на стоянке
// коэффициент моточасов при движении
// id марки
// км до ТО
// номер ТС
// описание
// id ТС
// остановлена
// время остановки
// id события
// предположение об остановки
// метки
// моточасы
// id ТС
// коэффициент моточасов на стоянке
// коэффициент моточасов при движении
// id марки
// id модели
// наличие картинки
// id водителей
// id меток
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Обновление данных о ТС
Для подписки на обновление информации о конкретных ТС необходимо отправить WebSocket-сообщение «SET_OBSERVABLE_CARS», содержащее массив glonassID данных ТС
Структура запроса:
Формат: json
{
command: "SET_OBSERVABLE_CARS",
data: [3333,107285,107305,107328]
}
// заголовок сообщения
// glonassId ТС, на которые собираемся подписаться
Ответ:
Формат: json
{
command: "CAR_UPDATES",
data: [
{
data: 1390223036000,
direction: 187,
glonassId: 211206,
lat: 55.6038,
lon: 52.006,
speed: 0,
sysData: 1390223032413
}
]
}
// заголовок сообщения
// дата
// угол, под которым вошло ТС
// глонасс id
// ширина
// долгота
// текущая скорость
// время, в которое точка записывается в базу данных
Фотография ТС
GET /cars/{id}/pic
Структура запроса:
GET /cars/{id}/pic?token=bw3ty3h46yth
token: ключ доступа
{id}: id ТС
Ответ:
Статус: 200 — успешное выполнение
Формат:image/png
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Уменьшенная фотография ТС
GET /cars/{id}/thumb
Структура запроса:
GET /cars/{id}/thumb?token=bw3ty3h46yth
token: ключ доступа
{id}: id ТС
Ответ:
Статус: 200 — успешное выполнение
Формат:image/png
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование фотографии ТС
PUT /cars/{id}/pic
Структура запроса:
PUT /cars/{id}/pic?token=bw3ty3h46yth
token: ключ доступа
{id}: id ТС
Формат: json
{
fileName: "p18du3mejc108jne51db9g34e1b3.png"
}
// имя файла
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
message: null,
status: 1
}
// сообщение
// статус выполнения
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление фотографии ТС
DELETE /cars/{id}/pic
Структура запроса:
DELETE /cars/{id}/pic
token: ключ доступа
id: id ТС
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — usersGroups
Группы пользователей
Список групп пользователей
Доступно только для всевидящих администраторов
GET /users/groups
Структура запроса:
GET /users/groups?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации
GET /users/groups?organizations=1,12,2&wheel=true
name: получение списка групп пользователей по названию
organizations: получение списка групп пользователей, принадлежащих хотя бы к одной из заданных организаций
wheel: поиск групп пользователей, у которых права соответствует заданному булевому значению
admin: поиск групп пользователей, у которых права соответствует заданному булевому значению
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 2,
name: "adminGS",
wheel: true,
admin: true,
organizationId: 2
}
]
// массив групп пользователей
// id группы
// название группы
// всевидящие
// администраторы
// id организации
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование группы пользователей
Доступно только для всевидящих администраторов
PUT /users/groups/{id}
Структура запроса:
PUT /users/groups/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id группы пользователей
Формат: json
{
admin: false
carGroups: [6141]
geoportalLogin: ""
geoportalPassword: ""
id: 1223
name: "234512"
organizationId: "1323"
usersCount: 0
wheel: false
}
// администрирование
// id групп ТС
// логин на GeoPortal
// пароль на GeoPortal
// id группы пользователей
// название группы пользователей
// id организации
// количество пользователей
// всевидящие
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
admin: false
id: 1223
name: "234512"
organizationId: 1323
usersCount: 0
wheel: false
}
// администрирование
// id группы пользователей
// название группы пользователей
// id организации
// количество пользователей
// всевидящие
Статус: 400 — ошибка в запросе
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Создание группы пользователей
Доступно только для всевидящих администраторов
POST /users/groups
Структура запроса:
POST /users/groups?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
admin: false
carGroups: [4901, 5102, 4722, 4881, 4982, 4981, 4724]
geoportalLogin: "123"
geoportalPassword: "123"
name: "qqq"
organizationId: "1162"
usersCount: 0
wheel: true
}
// администрирование
// id групп ТС
// логин на GeoPortal
// пароль на GeoPortal
// название группы пользователей
// id организации
// количество пользователей
// всевидящие
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
admin: false
id: 1223
name: "23451"
organizationId: 1323
usersCount: 0
wheel: false
}
// администрирование
// id группы пользователей
// название группы пользователей
// id организации
// количество пользователей
// всевидящие
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление группы пользователей
Доступно только для всевидящих администраторов
DELETE /users/groups/{id}
Структура запроса:
DELETE /users/groups/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id группы пользователей
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список групп пользователей в xlsx файле
Доступно только для всевидящих администраторов
GET /users/groups.xlsx
Структура запроса:
GET /users/groups.xlsx?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: application/vnd.ms-excel
Статус: 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/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id группы пользователей
Ответ:
Статус: 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/{id}/cars/groups?token=bw3ty3h46yth
token: ключ доступа
{id}: id группы пользователей
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 1,
name: "Группа 1",
notes: "-",
extGroup: null,
view: true,
organizationId: 1
}
]
// Массив групп ТС определенной группы пользователей
// id группы ТС
// название группы ТС
// примечания
// видима ли
// id организации
Статус: 404 — Объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — orgs
Организации
Список организаций
Не всевидящим пользователям доступна информация только по своей организации
GET /organizations
Структура запроса:
GET /organizations?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации
GET /organizations?name=org name
name: поиск организаций по названию
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 1162,
name: "name",
mapExtent: "63.39152, -66.79, 94.921875, -80.15625",
order: 100,
address: "город и улица",
inn: "00000000001",
phone: "",
email: "email@emailDomen.com",
homepage: "www.myWebSite.com",
kpp: "0000000000000000001"
}
]
// массив объектов с органзациями
// id организации
// название организации
// видимая часть карты(координаты левой нижней и правой верхней точек)
// порядок организаци
// адрес
// инн
// телефон
// email
// домашняя страница
// КПП
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование организации
Доступно только для всевидящих администраторов
PUT /organizations/{id}
Структура запроса:
PUT /organizations/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id контрольной точки
Формат: json
{
id: 1422,
address: "TestOrg",
email: "TestOrg@mail.ru",
homepage: "TestOrg.ru",
inn: "12333322333",
kpp: "12222222222",
mapExtent: "75.715633, 30.7512, 142.91, 55.3710",
name: "TestOrg",
phone: "89647333642",
order: 100
}
// id
// адрес
// email
// домашняя страница
// инн
// КПП
// видимая часть карты(координаты левой нижней и правой верхней точек)
// название организации
// телефон
// название организации
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
id: 1422,
address: "TestOrg",
email: "TestOrg@mail.ru",
homepage: "TestOrg.ru",
inn: "12333322333",
kpp: "12222222222",
mapExtent: "75.715633, 30.7512, 142.91, 55.3710",
name: "TestOrg",
phone: "89647333642",
order: 100
}
// id
// адрес
// email
// домашняя страница
// ИНН
// КПП
// видимая часть карты(координаты левой нижней и правой верхней точек)
// название организации
// телефон
// название организации
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Создание организации
Доступно только для всевидящих администраторов
POST /organizations
Структура запроса:
POST /organizations?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
address: "TestOrg"
email: "TestOrg@mail.ru"
homepage: "hoiee.com"
inn: "324234234"
kpp: "234234234234"
mapExtent: "74.7296, 27.37, 109.160156, 21.621"
name: "refrfe"
phone: "3223234"
}
// адрес
// email
// домашняя страница
// инн
// КПП
// видимая часть карты(координаты левой нижней и правой верхней точек)
// название организации
// телефон
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
id: 1422
order: 100
address: "TestOrg"
email: "TestOrg@mail.ru"
homepage: "hoiee.com"
inn: "324234234"
kpp: "234234234234"
mapExtent: "74.7296, 27.37, 109.160156, 21.621"
name: "TestOrg"
phone: "3223234"
}
// id организации
// название организации
// адрес
// email
// домашняя страница
// ИНН
// КПП
// видимая часть карты(координаты левой нижней и правой верхней точек)
// название организации
// телефон
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление организации
Доступно только для всевидящих администраторов
DELETE /organizations/{id}
Структура запроса:
DELETE /organizations/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id организации
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Смена организации
Доступно только для всевидящих администраторов
POST /organizations/change
Структура запроса:
POST /organizations/change?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
id: "123"
}
// id организации
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
status: 1
}
// статус выполнение
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество организаций
Не всевидящим пользователям доступна информация только по своей организации
GET /organizations/count
Структура запроса:
GET /organizations/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: text
10
// количество доступных организаций
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Группы ТС данной организации
Не всевидящим пользователям доступна информация только по своей организации
GET /organizations/{id}/cars/groups
Структура запроса:
GET /organizations/{id}/cars/groups?token=bw3ty3h46yth
token: ключ доступа
{id}: id организации
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 4662,
name: "234",
notes: "",
extGroup: null,
view: true,
organizationId: 1143
}
]
// массив объектов групп
// id группы
// название группы
// описание
// видима ли
// id организации
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — controlPoints
Контрольные точки
Список контрольных точек
GET /cars/checkpoints
Структура запроса:
GET /cars/checkpoints?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"description": "2222222222",
"arrivalData": 1381393740000,
"arrivedData": null,
"arrivalInterval": 1800000,
"address": "3333333333333",
"cycle": false,
"id": 1181,
"carId": 3973,
"lat": 55.75957720924986,
"lon": 48.72711181640625
},...]
// описание, строка
// время прибытия, timestamp
// интервал прибытия, целое число
// адрес, строка
// id контрольной точки, целое число
// id ТС, целое число
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование контрольной точки
Доступно только для пользователей с правами администратора
PUT /cars/checkpoints/id
Структура запроса:
PUT /cars/checkpoints/1?token=bw3ty3h46yth
id: id контрольной точки
token: ключ доступа
Формат: json
{
"id": 1,
"address": "Новый адрес",
"arrivalData": 1384862460000,
"arrivalInterval": 600000,
"carId": 1,
"description": "description",
"lat": 55.79819333412856,
"lon": 48.702392578125
}
// id контрольной точки, целое число
// адрес, строка
// время прибытия, timestamp
// интервал прибытия, целое число
// id ТС, целое число
// описание, строка
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"description": "emulating in progress..",
"arrivalData": 1416470760000,
"arrivedData": 1416470781000,
"arrivalInterval": 600000,
"address": "New address",
"cycle": false,
"id": 99345,
"carId": 134375,
"lat": 61.81466389468391,
"lon": 34.365234375
}
// описание, строка
// время прибытия, timestamp
// интервал прибытия, timestamp
// адрес, строка
// id, целое число
// id ТС, целое число
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Создание контрольной точки
Доступно только для пользователей с правами администратора
POST /cars/checkpoints
Структура запроса:
POST /cars/checkpoints?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"address": "адрес",
"arrivalData": 1384862520000,
"arrivalInterval": 600000,
"carId": 4034,
"description": "описание",
"lat": 56.01757535614987,
"lon": 49.23316955566406
}
// адрес, строка
// время прибытия, timestamp
// интервал прибытия, целое число
// id ТС, целое число
// описание, строка
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"address": "Полный адрес",
"arrivalData": 1386152820000,
"arrivalInterval": 600000,
"arrivedData": null,
"car": null,
"carId": 4820,
"cycle": false,
"description": "test desc",
"id": 1421,
"lat": 55.67835873246176,
"lon": 49.1748046875
}
// адрес, строка
// время прибытия, timestamp
// интервал прибытия, целое число
// ТС
// id ТС, целое число
// описание, строка
// id контрольной точки, целое число
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление контрольной точки
Доступно только для пользователей с правами администратора
DELETE /cars/checkpoints/{id}
Структура запроса:
DELETE /cars/checkpoints/25?token=bw3ty3h46yth
id: id контрольной точки
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Контрольные точки определенного ТС
GET /cars/{id}/checkpoints
Структура запроса:
GET /cars/4034/checkpoints?token=bw3ty3h46yth
id: id машины
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"description": "home",
"arrivalData": 1427361720000,
"arrivedData": null,
"arrivalInterval": 600000,
"address": "",
"cycle": false,
"id": 128601,
"carId": 4034,
"lat": 55.76002392688244,
"lon": 49.171940088272095
},...]
// описание, строка
// время прибытия, timestamp
// интервал прибытия, целое число
// адрес, строка
// id контрольной точки, целое число
// id ТС, целое число
// широта, число с плавающей точкой
// долгота, число с плавающей точкой
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — carGroups
Группы машин
Список групп машин
GET /cars/groups
Структура запроса:
GET /cars/groups?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации:
GET /cars/groups?organizations=1162,1&name=группа
name: поиск группы по названию
organizations: получение списка групп, принадлежащих хотя бы одной из заданных организаций
notes: поиск группы по записям
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 703,
name: "003",
notes: null,
extGroup: null,
view: true,
organizationId: 1
}
]
// массив объектов с информацией по группе
// id группы, целое число
// название группы, строка
// описание группы, строка
// видима ли
// id организации
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование группы
Доступно только для пользователей с правами администратора
PUT /cars/groups/{id}
Структура запроса:
PUT /cars/groups/{id}?token=bw3ty3h46yth
{id}: id группы
token: ключ доступа
Формат: json
{
extGroup: null,
id: 4901,
name: "name",
notes: "",
organizationId: "1143",
view: true
}
// id группы
// название группы
// описание группы
// id организации
// видима ли
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
extGroup: null,
id: 4901,
name: "name",
notes: "",
organizationId: "1143",
view: true
}
// 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
{
extGroup: null,
id: 4901,
name: "name",
notes: "",
organizationId: "1143",
view: true
}
// id группы
// название группы
// описание группы
// id организации
// видима ли
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление группы
Доступно только для пользователей с правами администратора
DELETE /cars/groups/{groupId}
Структура запроса:
DELETE /cars/groups/{groupId}?token=bw3ty3h46yth
{groupId}: id группы
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список групп машин в xlsx файле
GET /cars/groups.xlsx
Структура запроса:
GET /cars/groups.xlsx?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: application/vnd.ms-excel
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список машин группы
GET /cars/groups/{groupId}/cars
Структура запроса:
GET /cars/groups/{groupId}/cars?token=bw3ty3h46yth
{groupId}: id группы
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 4158,
name: "testDrivers",
glonassId: 354235,
view: true,
lastUpdate: null,
projectPoints: false,
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
// видима ли
// последнее обновление
// если true - машина на сервисном обслуживании
// стандартная иконка
// индекс иконки
// машина в процессе удаления
// id марки
// id модели
// id группы
// текущая скорость
// угол, под которым вошло ТС
// широта
// долгота
// номер ТС
// остановлена
// 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
Содержит описание ошибки