Документация-вспомогательные

Automap — rest — serviceReason

25 ноября 2013 admin

Automap / Руководство разработчика REST /Причины ТО

Причины ТО

Список причин постановки ТС на ТО

GET /cars/service/reason

Структура запроса:


GET /cars/service/reason?token=bw3ty3h46yth

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

[{
	"id": 1,
	"name": "Трекер: зависание"
},...]


// id причины, целое число
// название причины, строка

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Информация о причине постановке по ID

GET /cars/service/reason/{id}

Структура запроса:


GET /cars/service/reason/2?token=bw3ty3h46yth

id: id причины

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 2,
	"name": "Трекер: выход из строя"
}


// id причины, целое число
// название причины, строка

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Добавление причины постановки ТС на ТО

Доступно только для пользователей с правами администратора

POST /cars/service/reason

Структура запроса:


POST /cars/service/reason?token=bw3ty3h46yth

token: ключ доступа

Формат: json

{
	"name": "Трекер: зависание"
}


// название причины, строка

Ответ:

Статус: 200 — успешное выполнение

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Редактирование причины постановки ТС на ТО

Доступно только для пользователей с правами администратора

PUT /cars/service/reason/{id}

Структура запроса:


PUT /cars/service/reason/4?token=bw3ty3h46yth

id: id причины

token: ключ доступа

Формат: json

{
	"id": 4,
	"name": "Измененная причины"
}


// id причины, целое число
// название причины, строка

Ответ:

Статус: 200 — успешное выполнение

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Удаление причины постановки ТС на ТО

Доступно только для пользователей с правами администратора

DELETE /cars/service/reason/{id}

Структура запроса:


DELETE /cars/service/reason/6?token=bw3ty3h46yth

id: id причины

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Automap — rest — files

25 ноября 2013 admin

Automap / Руководство разработчика REST /Файлы

Файлы

Получение файла

GET /files/$uuid<[0-9a-z]+\.[a-z]{2,4}>

Структура запроса:


GET /files/$uuid<[0-9a-z]+\.[a-z]{2,4}>?token=bw3ty3h46yth

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Добавление картинки

Доступно только для пользователей с правами администратора

POST /files/upload

Структура запроса:


POST /files/upload?token=bw3ty3h46yth

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	name: "p189tc0i1f1pjb17j91kphlia1qsc7.gif",
	status: "ok",
	uploaded: true
}



// название файла 
// статус
// загружено

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Automap — rest — users

21 ноября 2013 admin

Automap / Руководство разработчика REST / Пользователи

Пользователи

Текущий пользователь

Доступно только для всевидящих администраторов

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
}





// id текущего пользователя
// логин
// ФИО
// информация об организации
// id организации
// название организации
// видимая часть карты(координаты левой нижней и правой верхней точек)
// порядок организации
// провайдер схем дорог

// в процессе удаления

// id организации
// адрес
// телефон
// ИНН
// КПП
// email
// домашняя страница


// права
// id
// название
// всевидящий
// администрирование
// информация об организации
// id организации
// название организации
// видимая часть карты(координаты левой нижней и правой верхней точек)
// порядок организации
// провайдер схем дорог

// в процессе удаления

// id организации
// адрес
// телефон
// ИНН
// КПП
// email
// домашняя страница


// количество пользователей

// телефон

// виден при старте


// включен
// id группы
// идентификатор
// id организации
// id текущей организации

Статус: 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

21 ноября 2013 admin

Automap / Руководство разработчика REST / Марки ТС

Марки ТС

Список марок ТС

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

21 ноября 2013 admin

Automap / Руководство разработчика REST / Водители

Водители

Список водителей

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

21 ноября 2013 admin

Automap / Руководство разработчика REST / Модели ТС

Модели ТС

Список моделей ТС

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

21 ноября 2013 admin

Automap / Руководство разработчика REST / Иконки

Иконки

Список иконок

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

Содержит описание ошибки

Automap — rest —service

20 ноября 2013 admin

Automap / Руководство разработчика REST /Техническое Обслуживание

Техническое обслуживание

Информация о тех.обслуживании ТС

GET /cars/{id}/service

Структура запроса:


GET /cars/4059/service?token=bw3ty3h46yth

id: id транспортного средства

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": {
		"carId": 4059,
		"dataFrom": 1421836494752
	},
	"reasonId": 2,
	"comments": "",
	"dataTill": null
}


// информация о ТС, объект
// id ТС, целое число
// время постановки на ТО, timestamp

// id причины, целое число
// комментарии, строка
// время окончания ТО, timestamp

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Постановка ТС на ТО

Доступно только для пользователей с правами администратора

POST /cars/{id}/service

Структура запроса:


POST /cars/4339/service?token=bw3ty3h46yth

id: id транспортного средства

token: ключ доступа

Формат: json

{
	"comments": "Комментарий",
	"reasonId": 2
}


// комментарии, строка
// id причины, целое число

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": {
		"carId": 134375,
		"dataFrom": 1422277972999
	},
	"reasonId": 2,
	"comments": "Комментарии",
	"dataTill": null
}


// информация о ТС, объект
// id ТС, целое число
// дата постановки на ТО, timestamp

// id причины, целое число
// комментарии, строка
// дата окончания ТО, timestamp

Статус: 400 — ошибка в запросе

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Редактирование данных о ТО

Доступно только для пользователей с правами администратора

PUT /cars/{id}/service

Структура запроса:


PUT /cars/4339/service?token=bw3ty3h46yth

id: id ТС

token: ключ доступа

Формат: json

{
	"comments": "Новый комментарий к ТО",
	"reasonId": 2
}


// комментарии, строка
// id причины, целое число

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": {
		"carId": 4339,
		"dataFrom": 1422277972999
	},
	"reasonId": 2,
	"comments": "Новый комментарий к ТО",
	"dataTill": null
}


// информация о ТС, объект
// id ТС, целое число
// дата постановки на ТО, timestamp

// id причины, целое число
// комментарии, строка
// дата окончания ТО, timestamp

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Снятие ТС с ТО

Доступно только для пользователей с правами администратора

DELETE /cars/{id}/service

Структура запроса:


DELETE /cars/31/service?token=bw3ty3h46yth

id: id ТС

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Automap — rest —Tags

20 ноября 2013 admin

Automap / Руководство разработчика REST / Метки

Список меток

GET /cars/tags

Структура запроса:


GET /cars/tags?token=bw3ty3h46yth

token: ключ доступа

Параметры фильтрации

name: получение списка меток по названию

color: получение списка меток по цвету

Ответ:

Статус: 200 — успешное выполнение

Формат: json

[{
		"id": 1,
		"name": "Название метки",
		"color": "ff0000"
},...]


// id метки, целое число
// название метки, строка
// цвет метки, строка

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Создание метки

Доступно только для пользователей с правами администратора

POST /cars/tags

Структура запроса:


POST /cars/tags?token=bw3ty3h46yth

token: ключ доступа

Формат: json

{
	"color": "ffb833",
	"name": "Метка" 
}


// цвет метки, строка
// название метки, строка

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 128,
	"color": "ffb833",
	"name": "Метка" 
}


// id метки, целое число
// цвет метки, строка
// название метки, строка

Статус: 400 — ошибка в запросе

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Получение метки по id

GET /cars/tags/{id}

Структура запроса:


GET /cars/tags/15?token=bw3ty3h46yth

id: id метки

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
		"id": 15,
		"name": "Название метки",
		"color": "ff0000"
}


// id метки, целое число
// название метки, строка
// цвет метки, строка

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Редактирование метки

Доступно только для пользователей с правами администратора

PUT /cars/tags/{id}

Структура запроса:


PUT /cars/tags/15?token=bw3ty3h46yth

id id метки

token: ключ доступа

Формат: json

{
		"id": 15,
		"name": "Название метки",
		"color": "ff0000"
}


// id метки, целое число
// название метки, строка
// цвет метки, строка

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
		"id": 15,
		"name": "Название метки",
		"color": "ff0000"
}


// id метки, целое число
// название метки, строка
// цвет метки, строка

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Удаление метки

Доступно только для пользователей с правами администратора

DELETE /cars/tags/{id}

Структура запроса:


DELETE /cars/tags/6?token=bw3ty3h46yth

id: id метки

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Количество меток

GET /cars/tags/count

Структура запроса:


GET /cars/tags/count?token=bw3ty3h46yth

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: text

107

// количество меток

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Automap — rest — cars !examples no true

19 ноября 2013 admin

Automap / Руководство разработчика REST / Транспортные средства

Транспортные средства

Список ТС

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: [ ]
	}
]




// массив объектов с ТС

// id тс
// название
// глонасс id
// видима ли
// последнее обновление

// тс на сервисном обслуживании
// стандартная иконка
// индекс иконки
// машина в процессе удаления
// id марки
// id модели
// id группы 
// текущая скорость
// угол, под которым вошло ТС
// широта
// долгота
// номер ТС
// id организации
// остановлена
// id меток

Статус: 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

Содержит описание ошибки

← Previous 1 … 11 12 13 … 22 Next →