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

Сокеты

Подключение вебсокета

GET /ws

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

GET /ws?token=bw3ty3h46yth

Ответ:

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

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

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

Подключение сокета

GET /comet

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

GET /comet?token=bw3ty3h46yth

Ответ:

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

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

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

Отправление запроса через сокет

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

POST /comet/msg/$sessionId<[0-9a-z\-]+>

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

POST /comet/msg/dfd2134erfe?token=bw3ty3h46yth

Ответ:

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

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

Информация о приложении

Версия приложения

GET /version

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

GET /version?token=bw3ty3h46yth

Ответ:

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

2.2-SNAPSHOT-214

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

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

Получение текущей конфигурации приложения

GET /config

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

GET /config ?token=bw3ty3h46yth

Ответ:

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

{
	port: "9000",
	monitor: {
		showGroupInPopup: true,
		carsUpdateTime: 30,
		onlyActiveCars: true,
		stayActive: 60,
		showMarkInPopup: false,
		showOrgInPopup: true,
		setInactiveInZone: true
	}
}

// порт

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

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

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

Статистика

GET /statistics

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

GET /statistics?token=bw3ty3h46yth

Ответ:

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

{
	cars: {
		active: 0,
		total: 154
	},
	users: {
		active: 1,
		total: 33,
		connections: 1
	},
	organizations: 
	[
		{
			name: "Организация",
			cars: {
				active: 0,
				total: 1
			}
		}
	],
	tags:
	[
		{
			name: "30",
			cars: {
				active: 0,
				total: 1
			}
		}
	]
}

// количество активных ТС
// общее количество ТС


// количество активных пользователей
// общее количество пользователей
// количество подключений от всех пользователей в текущее время

// массив организаций


// название организации

// количество активных ТС данной организации
// общее количество ТС данной организации



// массив меток


// название метки

// количество активных ТС 
// общее количество ТС 

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

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

Калибровка

Калибровка ТС

GET /cars/{carId}/gauges/{typeId}/{port}/calibration

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

GET /cars/196/gauges/3/1547?token=bw3ty3h46yth

Ответ:

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

{
	"calibration": [{
		"in":1,
		"out":1
	}],
	"invertThreshold": false,
	"isConverter": false,
	"threshold": 0,
	"unitName": "km" 
}

// калибровка, объект	
// вход, целое число
// выход, целое число

// инвертирование порога, булевое поле
// конвертирование, булевое поле
// порог, целое число
// единицы измерения, строка

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

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

Изменение калибровки

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

POST /cars/{carId}/gauges/{typeId}/{port}/calibration

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

POST /cars/39/gauges/11/1228/calibration?token=bw3ty3h46yth

{
	"calibration":[{
		"in": 1,
		"out": 1
	}],
	"isConverter": false,
	"unitName": "km"    
}

// калибровка, объект
// вход, целое число
// выход, целое число

// конвертирование, булевое поле
// единицы измерения, строка

Ответ:

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

{
	"calibration":[{
		"in": 1,
		"out": 1
	}],
	"invertThreshold": false,
	"isConverter": false,
	"threshold": 0,
	"unitName": "km"   
}

// калибровка, объект
// вход, целое число
// выход, целое число

// инвертировать порог, булевое поле
// конвертирование, булевое поле
// порог, целое число
// единицы измерения, строка

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

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

Функционал геопортала

Обращение к функционалу геопортала (см. документацию по REST API Геопортала )

GET /geoportal/*path

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

GET /geoportal/*path?token=bw3ty3h46yth

Ответ:

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

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

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

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

POST /geoportal/*path

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

POST /geoportal/*path?token=bw3ty3h46yth

Ответ:

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

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

Отчеты

Графический отчет за выбранный промежуток времени

GET /reports/graphical/{glonassId}/{tsFrom}/{tsTo}

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

GET   /reports/graphical/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth    

Ответ:

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

                               
{
	extent: [49.0916, 55.7301, 49.2581, 55.8429]
	speedTracks: [
		{
			dateFrom:1381361961000,	
			dateTill:1381362010000,	
			length:221,	
			line:{
					type:"LineString",
					coordinates:[[49.1697,55.7559]]
				},	
			avgSpeed:13,	
			type:1
		}
	]
}

// координаты левой нижней и правой верхней точек графика 
// массив треков скорости

// начало промежутка времени
// конец промежутка времени
// расстояние

// тип линии
// массив координат

// средняя скорость
// тип

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

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

Потери сигнала за промежуток времени

GET /reports/nosignal/{glonassId}/{tsFrom}/{tsTo}

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

GET    /reports/nosignal/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

   
[                                 
	{
		date: 1381484138000,
		direction: 6373,
		duration: 1073000,
		info: "info (00:17:53)",
		line:{
			type:"LineString",
			coordinates:[[49.1697,55.7559],...]
		},	
	}
]

// массив потери сигнала

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

// тип линии
// координаты

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

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

Статистика ТС за выбранный промежуток времени

GET /reports/short/{glonassId}/{tsFrom}/{tsTo}

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

GET /reports/short/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

{
	fuel: 0
	glonassAvg: 0
	gpsAvg: 8.74
	length: 489.532
	motorHours: null
}

// топливо
// среднее количество ГЛОНАСС спутников за период времени
// среднее количество GPS спутников за период времени
// расстояние
// коэффициенты моточасов

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

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

Повороты

GET /reports/turns/{glonassId}/{tsFrom}/{tsTo}

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

GET /reports/turns/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		date:1381321524000,
		address:"-",
		info:"Поворот с восток на северозапад",
		point:
			{
				type:"Point",
				coordinates:[49.1696,55.7559]
			},
		direction:295
	}
]

// массив данных о поворотах

// время
// адрес
// информация


// тип
// координаты

// угол, под которым вошло ТС

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

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

Остановки

GET /reports/parkings/{glonassId}/{tsFrom}/{tsTo}

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

GET /reports/parkings/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		address: "-",
		date: 1381316004000,
		info: "Остановка (12:46:08)",
		point: 
			{
				type:"Point",
				coordinates:[49.1697,55.7559]
			}
	}
]

// массив данных об остановках

// адрес
// время
// информация


// тип
// координаты

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

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

События, генерируемые датчиками

GET /reports/gaugeevents/{glonassId}/{tsFrom}/{tsTo}

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

GET /reports/gaugeevents/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		date:null,
		address:"-",
		info:"Датчик Зажигание: Вкл.",
		point:null
	}
]

// массив событий

// время
// адрес
// информация
// информация о точке

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

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

Скорость

GET /reports/speedhistory/{glonassId}/{tsFrom}/{tsTo}

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

GET /reports/speedhistory/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		date: 1382090876000,
		value: 16
	}
] 

// массив скоростей

// время
// скорость

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

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

Список событий от датчиков данного ТС в заданный промежуток времени

GET /reports/gaugehistory/$carId<[0-9]+>/$port<[0-9]+>/$typeId<[0-9]+>/{tsFrom}/{tsTo}

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

GET  /reports/gaugehistory/$carId<[0-9]+>/$port<[0-9]+>/$typeId<[0-9]+>/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		date: 1384840112000,
		value: 0
	}
]

// массив событий

// время
// значение

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

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

История

GET /reports/history/{glonassId}/{tsFrom}/{tsTo}

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

GET /reports/history/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		 data: 1381316004000,
		 speed: 0,
		 direction: 45,
		 odometr: 0,
		 lat: 55.7559,
		 lng: 49.1559
	}
]

// массив данных

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

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

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

Графический отчет, события входа и выхода из контрольной зоны

GET /reports/zones/{glonassId}/{tsFrom}/{tsTo}

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

GET /reports/zones/{glonassId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		address: "-",
		date: 1381837158000,
		direction: 308,
		info: "Вход в зону (3123123234)",
		point: 
			{
				type:"Point",
				coordinates:[49.1737,55.7354]
			}
	}
] 

// массив событий

// адрес
// время
// угол, под которым вошло ТС
// информация


// тип
// координаты

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

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

Комбоотчет по группе

GET /reports/runs/group/{groupId}/{tsFrom}/{tsTo}

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

GET /reports/runs/group/{groupId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		billrun: 0
		carId: 4937
		sysrun: 0
	}
]

// массив данных

// пройдено по путевым листам
// id ТС
// пройдено по системе

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

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

Комбоотчет по списку ТС

GET /reports/runs/cars/{carId}/{tsFrom}/{tsTo}

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

GET /reports/runs/cars/{carId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		billrun: 0
		carId: 3923
		sysrun: 0
	}
]

// массив данных

// пройдено по путевым листам
// id ТС
// пройдено по системе

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

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

Отчет по пробегу по системе и по путевым листам

GET /reports/runs/daily/{carId}/{tsFrom}/{tsTo}

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

GET /reports/runs/daily/{carId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		date: "21.11.13",
		sysrun: 0,
		billrun: 0
	},
] 

// массив данных

// дата
// пройдено по путевым листам
// пройдено по системе

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

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

Отчет по плохим ТС

GET /reports/badcars/{tsFrom}/{tsTo}

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

GET /reports/badcars/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		billrun: 0
		carId: 3913
		count: 4
		distance: 126.07
		duration: 86000
		glonassId: 393
		sysrun: 52.86
	}
]	

// массив данных

// пройдено по путевым листам
// id ТС 
// количество 
// расстояние 
// продолжительность 
// ГЛОНАСС id 
// пройдено по системе

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

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

Отчеты по геозоне

GET /reports/zone/{zoneId}/{tsFrom}/{tsTo}

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

GET /reports/zone/{zoneId}/{tsFrom}/{tsTo}?token=bw3ty3h46yth

Ответ:

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

[
	{
		carId: 3973,
		date: 1382703138000,
		goIn: true
	}
] 

// массив данных

// id ТС
// дата
// вход в зону

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

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

Отчет для печати подробнее о JasperReports

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

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

GET  /jreports/file/{name}?token=bw3ty3h46yth

Ответ:

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

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

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

Параметры для построения отчетов подробнее о JasperReports

GET /jreports/{id}/parameters

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

GET /jreports/{id}/parameters?token=bw3ty3h46yth

Ответ:

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

[
	{
		id: 1,
		description: "groups ids",
		type: "text",
		name: "in_groups_ids",
		prompt: false,
		lib: false,

		order: 1
	}
] 

// массив данных

// id 
// описание 
// тип 
// название 
// доступность поля для заполнения
// списковый параметр, который требует предзагрузки 
// списка значений доступных для выбора
// порядок

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

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

Значения параметра для построения отчетов подробнее о JasperReports

GET /jreports/{id}/parameters/{parameterId}/values

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

GET /jreports/{id}/parameters/{parameterId}/values?token=bw3ty3h46yth

Ответ:

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

[
	{
		id: 9,
		name: "Педаль сцепления"
	}
] 

// массив данных

// id
// название

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

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

Список расширенных отчетов подробнее о JasperReports

GET /jreports

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

GET /jreports?token=bw3ty3h46yth

Ответ:

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

   
[
	{
		id: 38
		name: "123123"
		type: 2
	}
]

// массив данных

// id
// название
// тип

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

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

Построение расширенного отчета (JasperReports)

Для получения расширенного отчета по ТС или по группе необходимо отправить WebSocket-сообщение «GET_REPORT»,содержащее объект:

{
	extern: false,
	fileType: "pdf",
	params: [
		{
			name: "in_gauge_id",
			type: "int",
			value: 0
		}
	],
	reportId: "198"
}

// использует ли отчет стороннюю базу данных
// формат файла(pdf,doc,rtf,xls) ,
// параметры отчета






// тип отчета

Ответ:

{
	alias: "Странный отчет (PDF)",
	expire: 1389709624027,
	name: "1389623224026.pdf",
	status: 1			
}

			
			
// название типа отчета
// в указанный момент времени отчет затрется
// название файла отчета
// статус выполнения запроса 	

Параметры для построения дополнительных расширенных отчетов подробнее о JasperReports

GET /jreports/extern/{id}/parameters

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

GET  /jreports/extern/{id}/parameters?token=bw3ty3h46yth

Ответ:

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

[
	{
		id: 1,
		description: "groups ids",
		type: "text",
		name: "in_groups_ids",
		prompt: false,
		lib: false,

		order: 1
	}
]

// массив данных

// id
// описание
// тип
// название
// доступность поля для заполнения
// списковый параметр, который требует предзагрузки 
// списка значений доступных для выбора
// порядок

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

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

Дополнительные расширенные отчеты подробнее о JasperReports

GET /jreports/extern

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

GET /jreports/extern?token=bw3ty3h46yth

Ответ:

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

[
	{
		id: 38
		name: "123123"
		type: 2
	}
]  

// массив данных

// id
// название
// тип

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

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