Automap — rest — users
Пользователи
Текущий пользователь
Доступно только для всевидящих администраторов
GET /users/current
Структура запроса:
GET /users/current?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
id: 373,
login: "admin",
fio: "admin",
organization: {
id: 1,
name: "ГрадоСервис ООО",
mapExtent: "63.39152, -66.79, 94.921875, -80.15625",
order: 100,
mapRoadProvider: "MAPKZN",
mapAerialProvider: "MICROSOFT_AERIAL",
toDelete: false,
info: {
orgId: 1,
address: "",
phone: "",
inn: "",
kpp: "",
email: "",
homepage: ""
}
},
right: {
id: 1,
name: "Градосервис",
wheel: true,
admin: true,
organization: {
id: 1,
name: "ГрадоСервис ООО",
mapExtent: "63.39152, -66.79, 94.921875, -80.15625",
order: 100,
mapRoadProvider: "MAPKZN",
mapAerialProvider: "MICROSOFT_AERIAL",
toDelete: false,
info: {
orgId: 1,
address: "",
phone: "",
inn: "",
kpp: "",
email: "",
homepage: ""
}
},
usersCount: 11
},
phone: "",
monitor: false,
visible: false,
modTravelorder: "standard",
modAutoe: "standard",
enabled: true,
groupId: 1,
identifier: "373",
organizationId: 1,
currentOrgId: 1
}
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список пользователей
Доступно только для всевидящих администраторов
GET /users
Структура запроса:
GET /users?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации
GET /users?fio=name?organizations=1,12
fio: поиск пользователей по имени
email: поиск пользователей по email
login: поиск пользователей по login
organizations: поиск пользователяей, принадлежащих хотя бы к одной из заданных организаций
phone: поиск пользователей по номеру телефона
visible: поиск пользователей, видимость которых соответствует заданному булевому значению
rights: поиск пользователей, имеющих хотя бы одно из заданных прав
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
id: 22,
login: "sid",
fio: "Шушарин Иван Иванович",
phone: "960055555",
monitor: false,
visible: true,
modTravelorder: "standard",
modAutoe: "standard",
enabled: true,
groupId: 3,
identifier: "22",
organizationId: 2
}
]
// массив объектов пользователей
// id пользователя
// логин
// имя
// телефон
// виден при старте
// включен
// id групы пользователя
// идентификатор
// id организации
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Изменение пользователя
Доступно только для всевидящих администраторов
PUT /users/{id}
Структура запроса:
PUT /users/{id}?token=bw3ty3h46yth
token: ключ доступа
{id}: id пользователя
Формат: json
{
enabled: true,
fio: "fio1",
groupId: "1103",
id: 1305,
identifier: "1305",
login: "login1",
modAutoe: "standard",
modTravelorder: "standard",
monitor: false,
organizationId: "1162",
password: "123452",
phone: "1234567345",
visible: false
}
// включен
// фио
// id группы
// id пользователя
// идентификатор
// логин
// id организации
// пароль
// телефон
// виден при старте
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
enabled: true,
fio: "fio1",
groupId: 1103,
id: 1305,
identifier: "1305",
login: "login1",
modAutoe: "standard",
modTravelorder: "standard",
monitor: false,
organizationId: 1162,
phone: "1234567345",
visible: false
}
// включен
// фио
// id группы
// id пользователя
// идентификатор
// логин
// id организации
// телефон
// виден при старте
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Создание пользователя
Доступно только для всевидящих администраторов
POST /users
Структура запроса:
POST /users?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
fio: "имя пользователя",
groupId: "1103",
login: "login",
organizationId: "1162",
password: "пароль",
phone: "89630453323",
visible: true
}
// фио
// id группы
// логин
// id организации
// пароль
// телефон
// виден при старте
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
enabled: true,
fio: "имя пользователя",
groupId: 1103,
id: 1305,
identifier: "1305",
login: "login",
modAutoe: "standard",
modTravelorder: "standard",
monitor: false,
organizationId: 1162,
phone: "89630453323",
visible: true
}
// включюен
// фио
// id группы
// id пользователя
// идентификатор
// логин
// id организации
// телефон
// виден при старте
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление пользователя
Доступно только для всевидящих администраторов
DELETE /users/{id}
Структура запроса:
DELETE /users/{id}
token: ключ доступа
{id}: id пользователя
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список пользователей в xlsx файле
Доступно только для всевидящих администраторов
GET /users.xlsx
Структура запроса:
GET /users.xlsx?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: application/vnd.ms-excel
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество пользователей
Доступно только для всевидящих администраторов
GET /users/count
Структура запроса:
GET /users/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: text
224
// Количество пользователей
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — marks
Марки ТС
Список марок ТС
GET /cars/marks
Структура запроса:
GET /cars/marks?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации:
GET /cars/marks?name=markname
name: получение списка марок по названию
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 1,
"name": "nameMark"
},...]
// id марки, целое число
// название, строка
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Полный список марок ТС
GET /cars/marks/full
Структура запроса:
GET /cars/marks/full?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 1,
"name": "nameMark"
},...]
// id марки, целое число
// название, строка
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество марок
GET /marks/count
Структура запроса:
GET /marks/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: text
24
// количество марок
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление марки ТС
Доступно только для пользователей с правами администратора
POST /cars/marks
Структура запроса:
POST /cars/marks?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"name":"name"
}
// название марки, строка
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 300,
"name":"name"
}
// id марки, целое число
// название марки, строка
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование марки ТС
Доступно только для пользователей с правами администратора
PUT /cars/marks/{id}
Структура запроса:
PUT /cars/marks/17?token=bw3ty3h46yth
id: id марки ТС
token: ключ доступа
Формат: json
{
"id": 17,
"name":"Newname"
}
// id марки, целое число
// название марки, строка
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 17,
"name":"Newname"
}
// id марки, целое число
// название марки, строка
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление марки ТС
Доступно только для пользователей с правами администратора
DELETE /cars/marks/{id}
Структура запроса:
DELETE /cars/marks/14?token=bw3ty3h46yth
id: id марки ТС
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список марок в xlsx файле
GET /cars/marks.xlsx
Структура запроса:
GET /cars/marks.xlsx?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: application/vnd.ms-excel
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — drivers
Водители
Список водителей
GET /drivers
Структура запроса:
GET /drivers?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации:
GET /drivers?organizations=1,2,3
organizations: получение списка водителей, принадлежащих хотя бы одной из заданных организаций
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 1,
"fio": "Петренко А.П.",
"phone": "+79172525246",
"notes": "Опыт вождения более 10 лет",
"hasPhoto": true,
"organizationId": 1
},...]
// id водителя, целое число
// ФИО, строка
// телефон, строка
// примечание, строка
// у водителя имеется фото, булевое поле
// id организации, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список водителей ТС
GET /cars/{id}/drivers
Структура запроса:
GET /cars/53/drivers?token=bw3ty3h46yth
id: id ТС
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"active": false,
"driver": {
"id": 1,
"fio": "ФИО водителя",
"phone": "",
"notes": "Примечание",
"hasPhoto": false,
"organizationId": 92
}
},...]
// активность ТС, булевое поле
// информация о водителе
// id водителя, целое число
// ФИО, строка
// телефон, строка
// примечание, строка
// у водителя имеется фото, булевое поле
// id организации, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Поиск водителя по id
GET /drivers/{id}
Структура запроса:
GET /drivers/11?token=bw3ty3h46yth
id: id водителя
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 20081,
"fio": "111",
"phone": "",
"notes": "",
"hasPhoto": false,
"organizationId": 102
}
// id водителя, целое число
// ФИО, строка
// телефон, строка
// примечание, строка
// у водителя имеется фото, булевое поле
// id организации, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактировать информацию о водителе
Доступно только для пользователей с правами администратора
PUT /drivers/{id}
Структура запроса:
PUT /drivers/123?token=bw3ty3h46yth
id: id водителя ТС
token: ключ доступа
Формат: json
{
"fio": "Ренуков Павел Андреевич",
"hasPhoto": false,
"id": 20181,
"notes": "Права категории Б, опыт вождения 8 лет",
"organizationId": "439",
"phone": "+79170542871"
}
// ФИО, строка
// есть фото, булева переменная
// id водителя, целое число
// примечание, строка
// id организации, целое число
// телефон, строка
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 20181,
"fio": "Ренуков Павел Андреевич",
"phone": "+79170542871",
"notes": "Права категории Б, опыт вождения 8 лет",
"hasPhoto": false,
"organizationId": 439
}
// id водителя, целое число
// ФИО, строка
// телефон, строка
// примечание, строка
// наличие фото, булевое поле
// id организации, целое число
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Создание водителя
Доступно только для пользователей с правами администратора
POST /drivers
Структура запроса:
POST /drivers?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"fio": "Иванченко Артем Сергеевич",
"notes": "Опыт вождения 4 года",
"organizationId": "242",
"phone": "+79655978473"
}
// ФИО, строка
// примечание, строка
// id организации, целое число
// телефон, строка
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 20301,
"fio": "Иванченко Артем Сергеевич",
"phone": "+79655978473",
"notes": "Опыт вождения 4 года",
"hasPhoto": false,
"organizationId": 242
}
// id водителя, целое число
// ФИО, строка
// телефон, строка
// примечание, строка
// наличие фото, булевое поле
// id организации, целое число
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление водителя
Доступно только для пользователей с правами администратора
DELETE /drivers/{id}
Структура запроса:
DELETE /drivers/125?token=bw3ty3h46yth
id: id водителя ТС
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Выбрать водителей ТС
Доступно только для пользователей с правами администратора
PUT /cars/{id}/drivers/allow
Структура запроса:
PUT /cars/31/drivers/allow?token=bw3ty3h46yth
id: id ТС
token: ключ доступа
Формат: json
{
"drivers": [123,432]
}
// id водителей
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"active": false,
"driver": {
"fio": "Фамилия Имя Отчество",
"hasPhoto": false,
"id": 123,
"notes": "",
"organizationId": 1,
"phone": ""
}
},...]
// состояние активности, булевое поле
// информация о водителе, объект
// ФИО, строка
// наличие фото, булевое поле
// id водителя, целое число
// примечание, строка
// id организации, целое число
// телефон, строка
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Назначить водителя ТС
Доступно только для пользователей с правами администратора
PUT /cars/{id}/drivers/accept
Структура запроса:
PUT /cars/64/drivers/accept?token=bw3ty3h46yth
id: id ТС
token: ключ доступа
Формат: json
{
"driverId": "881"
}
// id водителя, целое число
Ответ:
Статус: 200 — успешное выполнение
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список водителей в xlsx файле
GET /drivers.xlsx
Структура запроса:
GET /drivers.xlsx?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: application/vnd.ms-excel
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Фотография водителя
GET /drivers/{id}/photo
Структура запроса:
GET /drivers/87/photo?token=bw3ty3h46yth
id: id водителя
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: image/png
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — models
Модели ТС
Список моделей ТС
GET /cars/models
Структура запроса:
GET /cars/models?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации
GET /cars/models?mark=1,43&expenseOn100km=12
name: типы датчиков по названию
mark: id марок (через запятую)
expenseOn100km: расход топлива на 100 км
maxTank: вместимость топливного бака
motohoursStop: коэффициент моточасов на стоянке
motohoursMove: коэффициент моточасов при движении
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 2,
"name": "Auris",
"expenseOn100km": 11,
"maxTank": 100,
"motohoursStop": null,
"motohoursMove": null,
"markId": 21
},...]
// id модели, целое число
// название модели, строка
// расход на 100 км, целое число
// вместимость топливного бака, целое число
// коэффициент моточасов на стоянке, целое число
// коэффициент моточасов при движении, целое число
// id марки, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Создание модели ТС
Доступно только для пользователей с правами администратора
POST /cars/models
Структура запроса:
POST /cars/models?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"name": "Newmodel",
"expenseOn100km": 11,
"maxTank": 80,
"motohoursStop": "",
"motohoursMove": "",
"markId": 39
}
// название модели, строка
// расход на 100 км, целое число
// вместимость топливного бака, целое число
// коэффициент моточасов на стоянке, целое число
// коэффициент моточасов при движении, целое число
// id марки, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"expenseOn100km": 11,
"id": 1,
"mark": {
"id":39,
"name": "Newmark"
},
"markId": 39,
"maxTank": 80,
"motohoursMove": 1,
"motohoursStop": 1,
"name": "Newmodel"
}
// расход на 100 км, целое число
// id, целое число
// id марки, целое число
// название марки, строка
// id марки, целое число
// вместимость топливного бака, целое число
// коэффициент моточасов при движении, целое число
// коэффициент моточасов на стоянке, целое число
// название, строка
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Изменение модели ТС
Доступно только для пользователей с правами администратора
PUT /cars/models/{id}
Структура запроса:
PUT /cars/models/3?token=bw3ty3h46yth
id: id модели ТС
token: ключ доступа
Формат: json
{
"expenseOn100km": "14",
"markId": "44",
"maxTank": "50",
"motohoursMove": "12",
"motohoursStop": "4",
"name": "GLK"
}
// расход на 100 км, целое число
// id марки, целое число
// вместимость топливного бака, целое число
// коэффициент моточасов при движении, целое число
// коэффициент моточасов на стоянке, целое число
// название, строка
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 3147,
"name": "GLK",
"mark": {
"id": 44,
"name": "MERCEDES-BENZ\t"
},
"expenseOn100km": 14.0,
"maxTank": 50,
"motohoursStop": 4.0,
"motohoursMove": 12.0,
"markId": 44
}
// id, целое число
// название, строка
// информация о марке, объект
// id марки, целое число
// название марки, строка
// расход на 100 км, целое число
// вместимость топливного бака, целое число
// коэффициент моточасов при движении, целое число
// коэффициент моточасов на стоянке, целое число
// id марки, целое число
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление модели ТС
Доступно только для пользователей с правами администратора
DELETE /cars/models/{id}
Структура запроса:
DELETE /cars/models/4?token=bw3ty3h46yth
id: id модели ТС
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество моделей
GET /cars/models/count
Структура запроса:
GET /cars/models/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: text
24
// количество моделей
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список моделей ТС определенной марки
GET /cars/marks/{id}/models
Структура запроса:
GET /cars/marks/14/models?token=bw3ty3h46yth
id: id марки
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 15,
"name": "21011",
"expenseOn100km": 11,
"maxTank": 100,
"motohoursStop": null,
"motohoursMove": null,
"markId": 35
},...]
// id модели, целое число
// название модели, строка
// расход топлива на 100км, целое число
// вместимость топливного бака, целое число
// коэффициент моточасов на стоянке, целое число
// коэффициент моточасов при движении, целое число
// id марки, целое число
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Список моделей в xlsx файле
GET /cars/models.xlsx
Структура запроса:
GET /cars/models.xlsx?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: application/vnd.ms-excel
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Automap — rest — icons
Иконки
Список иконок
GET /cars/icons
Структура запроса:
GET /cars/icons?token=bw3ty3h46yth
token: ключ доступа
Параметры фильтрации
GET /cars/icons?name=iconName&rotate=true
name: получение списка иконок по названию
rotate: получение списка иконок, у которых состояние поворота соответствует заданному булевому значению
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[
{
"id": 222,
"name": "Автобус 3D",
"width": 384,
"height": 48,
"initialRotation": 0,
"rotate": true,
"type": 1,
"src0": "/cars/icons/222/0",
"src1": "/cars/icons/222/1",
"src2": "/cars/icons/222/2"
}
]
// массив иконок
// id иконки, целое число
// название иконки, строка
// ширина, целое число
// высота, целое число
// первоначальный поворот, целое число
// если true, поворачиваемая, булевое поле
// тип иконки, целое число
// неактивное ТС, строка
// активное ТС, строка
// выделенное ТС, строка
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Информация об иконке по ID
GET /cars/icons/{id}/{status}
Структура запроса:
GET /cars/icons/25/2?token=bw3ty3h46yth
id: id иконки
status: статус иконки
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Количество иконок
GET /cars/icons/count
Структура запроса:
GET /cars/icons/count?token=bw3ty3h46yth
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: text
{
24
}
// Количество иконок
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление иконки
POST /cars/icons
Структура запроса:
POST /cars/icons?token=bw3ty3h46yth
token: ключ доступа
Формат: json
{
"initialRotation": "",
"name": "тест",
"rotate": false,
"src0": "p18duadbq31lgi1pp3591k5r14rh2d.png",
"src1": "p18duadfjf11opguk1ckb3fle8n2f.png",
"src2": "p18duadlpt1u2i18i5bms1l8ni0m2h.png",
"type": 0
}
// первоначальный поворот, целое число
// название иконки, строка
// если true поворачиваемая, булевое поле
// новая иконка в неактивном состоянии, строка
// новая иконка в активном состоянии, строка
// новая иконка в выделенном состоянии, строка
// тип иконки, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"height": 3,
"id": 135,
"initialRotation": 0,
"name": "тест",
"rotate": false,
"src0": "/cars/icons/135/0",
"src1": "/cars/icons/135/1",
"src2": "/cars/icons/135/2",
"type": 0,
"width": 30
}
// высота, целое число
// id иконки, целое число
// первоначальный поворот, целое число
// название иконки, строка
// если true поворачиваемая, булевое поле
// новая иконка в неактивном состоянии, строка
// новая иконка в активном состоянии, строка
// новая иконка в выделенном состоянии, строка
// тип иконки, целое число
// ширина иконки, целое число
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование иконки ТС
Доступно только для пользователей с правами администратора
PUT /cars/icons/{id}
Структура запроса:
PUT /cars/icons/55?token=bw3ty3h46yth
id: id иконки ТС
token: ключ доступа
Формат: json
{
"height": 19,
"id": 55,
"initialRotation": "13",
"name": "lambo",
"rotate": false,
"src0": null,
"src1": "p189slg9l9vms1qg94mu1ldd140c7.jpg",
"src2": null,
"type": 0,
"width": 30
}
// высота, целое число
// id иконки, целое число
// первоначальный поворот, целое число
// название иконки, строка
// если true поворачиваемая, булевое поле
// новая иконка в неактивном состоянии, строка
// новая иконка в активном состоянии, строка
// новая иконка в выделенном состоянии, строка
// тип иконки, целое число
// ширина иконки, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"height": 19,
"id": 55,
"initialRotation": 13,
"name": "lambo",
"rotate": false,
"src0": "/cars/icons/55/0",
"src1": "/cars/icons/55/1",
"src2": "/cars/icons/55/2",
"type": 0,
"width": 30
}
// высота иконки, целое число
// id иконки, целое число
// первоначальный поворот, целое число
// название иконки, строка
// если true поворачиваемая, булевое поле
// src иконки в неактивном состоянии, строка
// src иконки в активном состоянии, строка
// src иконки в выделенном состоянии, строка
// тип иконки, целое число
// ширина иконки, целое число
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление иконки
Доступно только для пользователей с правами администратора
DELETE /cars/icons/{id}
Структура запроса:
DELETE /cars/icons/59?token=bw3ty3h46yth
id: id иконки
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Миниатюра иконки
GET /cars/icons/{id}/{status}/preview/
Структура запроса:
GET /cars/icons/34/0/preview?token=bw3ty3h46yth
id: id иконки
status: 0 — неактивное ТС, 1 — активное ТС, 2 — выделенное ТС
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: image/png
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Предпоказ только что загруженной иконки
GET /cars/icons/{src}/{type}/preview
Структура запроса:
GET /cars/icons/"/cars/icons/25/0"/1/preview?token=bw3ty3h46yth
src: src загруженной иконки
type: 0 — сжатая иконка, 1 — вторая из восьми частей, в несжатом виде
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: image/png
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Предпоказ части иконки
GET /cars/icons/{id}/{state}/preview/{type}
Структура запроса:
GET /cars/icons/94/1/preview/0?token=bw3ty3h46yth
id: id иконки
state: состояние иконки
type: 0 — сжатая иконка, 1 — вторая из восьми частей, в несжатом виде
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: image/png
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки