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

Журнал приложения

Логи приложения

GET /log/app

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

GET /log/app?token=mbs90lon2a8

Ответ:

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

[{
	"id": "546378fbe4b07e72b48d8933",
	"time": 1415805179252,
	"message": "Exception notice sent to Airbrake",
	"level": "NOTICE",
	"logger": "application",
	"thread": "play-akka.actor.default-dispatcher-33266",
	"caller": null,
	"mdc": null
},…]

// id лога, целое число
// время, timestamp
// сообщение, строка
// уровень, строка
// источник логов приложения, строка
// поток логов приложения, строка

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

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

Количество логов приложения

GET /log/app/count

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

GET /log/app/count?token=mbs90lon2a8

Ответ:

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

5124

// количество логов приложения

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

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

Потоки логов приложения

GET /log/app/threads

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

GET /log/app/threads?token=mbs90lon2a8

Ответ:

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

[{
	"value": "play-akka.actor.default-dispatcher-32474"
},…]

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

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

Количество потоков логов приложения

GET /log/app/threads/count

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

GET /log/app/threads/count?token=mbs90lon2a8

Ответ:

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

145

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

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

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

Список уровней ошибок

GET /log/app/levels

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

GET /log/app/levels?token=mbs90lon2a8

Ответ:

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

[{
	"id": 1,
	"type": "EMERGENCY"
},…]

// id уровня ошибки, целое число
// тип уровня ошибки, строка

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

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

Количество уровней ошибок

GET /log/app/levels/count

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

GET /log/app/levels/count?token=mbs90lon2a8

Ответ:

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

19

// количество уровней ошибок

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

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

Журнал демона

Логи демона

GET /log/daemon

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

GET /log/daemon?token=mbs90lon2a8

Ответ:

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

[{
	"id": "546367b2bd7296fbcd53f2c1",
	"time": 1415800754928,
	"level": "DEBUG",
	"objectId": 0,
	"objectType": "listener",
	"protocolId": 0,
	"glonassId": 0,
	"message": "parser destructed"
},…]

// id лога, строка
// время, timestamp
// уровень лога, строка
// id источника данных для лога, целое число
// тип источника данных для лога, строка
// id протокола, целое число
// id ГЛОНАСС, целое число
// сообщение, строка

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

Количество логов демона

GET /log/daemon/count

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

GET /log/daemon/count?token=mbs90lon2a8

Ответ:

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

2815

// количество уровней ошибок

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

Список уровней ошибок

GET /log/daemon/levels

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

GET /log/daemon/levels?token=mbs90lon2a8

Ответ:

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

[{
	"id": 1,
	"type": "EMERGENCY"
},…]

// id уровня ошибок, целое число
// тип уровня, строка

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

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

Количество уровней ошибок

GET /log/daemon/count

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

GET /log/daemon/count?token=mbs90lon2a8

Ответ:

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

254

// количество уровней ошибок

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

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

Протоколы

Список протоколов

GET /daemon/protocols

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

GET /daemon/protocols?token=mbs90lon2a8

Ответ:

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

[{
	"id": 1,
	"name": "galileo",
	"title": "Галилео",
	"listener": true,
	"receiver": false,
	"writer": false,
	"stable": true
},…]

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

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

Информация о протоколе по ID

GET /daemon/protocols/{id}

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

GET /daemon/protocols/12?token=mbs90lon2a8

Ответ:

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

{
	"id": 12,
	"name": "protocol",
	"title": "protocol",
	"listener": true,
	"receiver": false,
	"writer": false,
	"stable": true
}

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

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

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

Количество протоколов

GET /daemon/protocols/count

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

GET /daemon/protocols/count?token=mbs90lon2a8

Ответ:

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

52

// количество протоколов

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

Дополнительные отчеты

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

GET /reports/badcars/$tsFrom<-?[0-9]+>/$tsTo<-?[0-9]+>

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

GET /reports/badcars/1420059600000/1421873999000?token=mbs90lon2a8

Ответ:

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

[{
	"carId": 24,
	"glonassId": 12,
	"count": 16,
	"duration": 16000,
	"distance": 0.0,
	"billrun": 0.0,
	"sysrun": 806.44
}]

// id ТС, целое число
// id ГЛОНАСС, целое число
// число потерь, целое число
// суммарное время, целое число
// расстояние, целое число
// системный пробег, число с плавающей точкой
// пробег по путевым листам, число с плавающей точкой

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

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

GET /reports/zone/$zoneId<[0-9]+>/$tsFrom<-?[0-9]+>/$tsTo<-?[0-9]+>

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

GET /reports/zone/18/1417381200000/1421873999000?token=mbs90lon2a8

Ответ:

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

[{
	"carId": 1,
	"date": 1418813912000,
	"goIn": true
},...]

// id ТС, целое число
// дата и время, целое число
// состояние: true - вход в геозону, false - выход из геозоны, булевое поле

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

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

История

GET /reports/history/$glonassId<[0-9]+>/$tsFrom<-?[0-9]+>/$tsTo<-?[0-9]+>

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

GET /reports/history/152/1381361961000/1381362010000?token=mbs90lon2a8

Ответ:

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

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

// дата и время, целое число
// скорость, целое число
// направление, целое число
// показания одометра, целое число
// широта, число с плавающей точкой
// долгота, число с плавающей точкой

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

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

Группы ТС

Список групп ТС

GET /cars/groups

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

GET /cars/groups?token=bw3ty3h46yth

Ответ:

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

[{
		"id": 703,
		"name": "Группа",
		"notes": null,
		"organizationId": 1
},...]

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

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

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

Редактирование группы ТС

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

PUT /cars/groups/{id}

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

PUT /cars/groups/id?token=bw3ty3h46yth

{
	"id": 2142,
	"name": "Название группы",
	"notes": "Группа для ТС организации",
	"organizationId": 242
}

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

h2 class=»rest»>Ответ:

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

{
	"id": 2142,
	"name": "Название группы",
	"notes": "Группа для ТС организации",
	"organizationId": 242
}

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

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

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

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

Добавление группы ТС

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

POST /cars/groups

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

POST /cars/groups?token=bw3ty3h46yth

{
	"name": "Новая группа ТС",
	"notes": "Новая группа для транспорта",
	"organizationId": "82"
}

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

Ответ:

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

{
	"id": 282,
	"name": "Новая группа ТС",
	"notes": "Новая группа для транспорта",
	"organizationId": 9782
}

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

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

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

Удаление группы ТС

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

DELETE /cars/groups/groupId

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

DELETE /cars/groups/345?token=bw3ty3h46yth

Ответ:

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

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

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

Список ТС, принадлежащих выбранной группе

GET /cars/groups/groupId/cars

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

GET /cars/groups/29/cars?token=bw3ty3h46yth

Ответ:

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

[{
		"id": 4158,
		"name": "testDrivers",
		"glonassId": 354235,
		"view": true,
		"lastUpdate": null,
		"onService": false,
		"iconStandard": true,
		"iconIndex": 223,
		"toDelete": false,
		"markId": 150,
		"modelId": 1621,
		"groupId": 29,
		"speed": 0,
		"direction": 0,
		"lat": 0,
		"lon": 0,
		"carNo": "235235",
		"isStopped": false,
		"tagsIds": [ ],
		"organizationId": 1
},...]

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

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

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

Список групп ТС (с ускоренной загрузкой за счет отсутствия фильтрации)

GET cars/groups/all

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

GET /cars/groups/all?token=bw3ty3h46yth

Ответ:

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

[{
		"id": 703,
		"name": "003",
		"notes": null,
		"organizationId": 1
},...]

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

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

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

Количество доступных групп

GET /cars/groups/count

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

GET /cars/groups/count?token=bw3ty3h46yth

Ответ:

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

10

// количество доступных групп

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

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

Все группы ТС (доступно только для главного администратора)

GET /cars/groups/wheel

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

GET /cars/groups/wheel?token=bw3ty3h46yth

Ответ:

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

[{
		"id": 703,
		"name": "003",
		"notes": null,
		"organizationId": 1
},...]

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

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

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