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


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

// 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

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

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

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

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

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