Archives by date

You are browsing the site archives by date.

AutoMap — rest — geosearch

23 января 2015 admin

mapSurfer GS / Руководство разработчика REST / Геопоиск

Геопоиск

GET /geocode/{lat}/{lon}

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


GET /geocode/55/49?token=mbs90lon2a8

lat: ширина

lon: долгота

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

Ответ:

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

Формат: json

{
	"lat": 55.35229063582012,
	"lng": 50.91684936226006,
	"label": "Республика Татарстан",
	"kind": 40,
	"distance": 0.0
}





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

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

Формат: text/plain

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

AutoMap — rest — daemon

23 января 2015 admin

mapSurfer GS / Руководство разработчика REST / Журнал демона

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

Логи демона

GET /log/daemon

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


GET /log/daemon?token=mbs90lon2a8

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

Ответ:

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

Формат: json

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


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

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

Формат: text/plain

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

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

GET /log/daemon/count

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


GET /log/daemon/count?token=mbs90lon2a8

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

Ответ:

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

Формат: json

2815

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

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

Формат: text/plain

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

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

GET /log/daemon/levels

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


GET /log/daemon/levels?token=mbs90lon2a8

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

Ответ:

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

Формат: json

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


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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /log/daemon/count

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


GET /log/daemon/count?token=mbs90lon2a8

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

Ответ:

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

Формат: json

254

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

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

Формат: text/plain

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

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

Формат: text/plain

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

AutoMap — rest — info

23 января 2015 admin

mapSurfer GS / Руководство разработчика REST / Информация о приложении

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

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

GET /version

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


GET /version?token=mbs90lon2a8

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

Ответ:

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

Формат: json


2.4.5-SNAPSHOT-581

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /config

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


GET /config?token=mbs90lon2a8

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

Ответ:

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

Формат: json

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





// порт, строка

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Статистика

GET /statistics

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


GET /statistics?token=mbs90lon2a8

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

Ответ:

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

Формат: json

{
	"cars": {
		"active": 0,
		"total": 141,
		"active_in_base": 0
	},
	"users": {
		"active": 3,
		"total": 45,
		"connections": 88
	},
	"organizations": [{
		"name": "Компания",
		"cars": {
			"active": 0,
			"total": 1,
		        "active_in_base": 0
		},
	},…]
}





// информация о ТС
// количество активных ТС, целое число
// общее количество ТС, целое число
// активных в базе, целое число

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

// информация об организациях, строка
// название организации, строка
// информация о ТС организации
// количество активных ТС, целое число
// общее количество ТС, целое число
// активных в базе, целое число

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

Формат: text/plain

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

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

Формат: text/plain

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

AutoMap — rest — protocols

22 января 2015 admin

mapSurfer GS / Руководство разработчика REST / Протоколы

Протоколы

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

GET /daemon/protocols

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


GET /daemon/protocols?token=mbs90lon2a8

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

Ответ:

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

Формат: json

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


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

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

Формат: text/plain

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

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

GET /daemon/protocols/{id}

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


GET /daemon/protocols/12?token=mbs90lon2a8

id: id протокола

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

Ответ:

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

Формат: json

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


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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /daemon/protocols/count

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


GET /daemon/protocols/count?token=mbs90lon2a8

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

Ответ:

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

Формат: json

52

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

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

Формат: text/plain

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

AutoMap — rest — graphreport

22 января 2015 admin

mapSurfer GS / Руководство разработчика REST / Графические отчеты

Графический отчет

Информация о графическом отчете ТС по его ГЛОНАСС ID

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

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


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

glonassId: id ГЛОНАСС

tsFrom: время, начиная с которого необходимо построить отчет

tsTo: время окончания построения отчета

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

Ответ:

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

Формат: json

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


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


// средняя скорость, целое число
// тип, целое число

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

Формат: text/plain

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

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

Формат: text/plain

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

Потери сигнала

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

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


GET /reports/nosignal/1220/1390359960000/1421917560000?token=mbs90lon2a8

glonassId: id ГЛОНАСС

tsFrom: время, начиная с которого необходимо построить отчет

tsTo: время окончания построения отчета

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

Ответ:

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

Формат: json

[{
	"date": 1416484479000,
	"eventId": 2,
	"line": {
		"type": "LineString",
		"coordinates": [[47.63689041, 65.75249005],
		[48.55682373, 56.79862241]]
	},
	"direction": 996812,
	"duration": 4667080000,
	"info": "Потеря сигнала (00 01:17:47)"
},...]


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


// направление, целое число
// продолжительность, целое число
// информация, строка

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

Формат: text/plain

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

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

Формат: text/plain

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

Повороты

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

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


GET /reports/turns/1220/1390359960000/1421917560000?token=mbs90lon2a8

glonassId: id ГЛОНАСС

tsFrom: время, начиная с которого необходимо построить отчет

tsTo: время окончания построения отчета

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

Ответ:

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

Формат: json

[{
	"date": 1421330137000,
	"address": "Ульяновская область",
	"point": {
		"type": "Point",
		"coordinates": [48.62493897, 53.76533768]
	},
	"direction": 351,
	"duration": 1000000,
	"info": "Поворот с юга на север",
	"eventId": 3
},...]


// дата, timestamp
// адрес, строка
// точка, объект
// тип, строка
// координаты, число с плавающей точкой

// направление, целое число
// продолжительность, целое число
// информация о повороте, строка
// id события, целое число

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

Формат: text/plain

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

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

Формат: text/plain

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

Остановки

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

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


GET /reports/parkings/1220/1390359960000/1421917560000?token=mbs90lon2a8

glonassId: id ГЛОНАСС

tsFrom: время, начиная с которого необходимо построить отчет

tsTo: время окончания построения отчета

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

Ответ:

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

Формат: json

[{
	"eventId": 1,
	"date": 1421917560000,
	"address": "Татарстан, Казань, улица Эсперанто, 29",
	"point": {
		"type": "Point",
		"coordinates": [49.1413912, 55.7741655]
	},
	"info": "Остановка (01 08:25:41)"
},...]


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

// информация, строка

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

Формат: text/plain

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

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

Формат: text/plain

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

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

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

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


GET /reports/gaugeevents/99/1390359960000/1421917560000?token=mbs90lon2a8

glonassId: id ГЛОНАСС

tsFrom: время, начиная с которого необходимо построить отчет

tsTo: время окончания построения отчета

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

Ответ:

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

Формат: json

[{
	"date": null,
	"data": null,
	"address": "-",
	"info": "Событие аналогового датчика Топливо",
	"point": null,
	"eventId": 9
},…]


// дата, timestamp
// данные
// адрес, строка
// информация о событии, строка

// id события, целое число

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

Формат: text/plain

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

События входа и выхода из контрольной зоны

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

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


GET /reports/zones/188/1390359960000/1436971763000?token=mbs90lon2a8

glonassId: id ГЛОНАСС

tsFrom: время, начиная с которого необходимо построить отчет

tsTo: время окончания построения отчета

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

Ответ:

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

Формат: json

[{
	"date": 1421917560000,
	"address": "Ульяновская область, Мелекесский район",
	"point": {
		"type": "Point",
		"coordinates": [49.75186157,54.11896983]
	},
	"direction": 0,
	"eventId": 6,
	"info": "Вход в зону(100km)"
},...]


// дата, timestamp
// адрес, строка
// информация о точке, объект
// тип, строка
// координаты, массив

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

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

Формат: text/plain

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

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

Формат: text/plain

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

AutoMap — rest — dopreports

21 января 2015 admin

mapSurfer GS / Руководство разработчика REST / Дополнительные отчеты

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

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

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

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


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

tsFrom: время, начиная с которого необходимо построить отчет

tsTo: время окончания построения отчета

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

Ответ:

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

Формат: json

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





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

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

Формат: text/plain

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

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

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

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


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

zoneId: id зоны

tsFrom: время, начиная с которого необходимо построить отчет

tsTo: время окончания построения отчета

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

Ответ:

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

Формат: json

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





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

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

Формат: text/plain

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

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

Формат: text/plain

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

История

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

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


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

glonassId: id ГЛОНАСС

tsFrom: время, начиная с которого необходимо построить отчет

tsTo: время окончания построения отчета

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

Ответ:

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

Формат: json

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





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

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

Формат: text/plain

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

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

Формат: text/plain

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

Automap — rest — orgs(before delete /all)

20 января 2015 admin

Automap GS / Руководство разработчика REST / Организации

Организации

Список организаций

Не всевидящим пользователям доступна информация только по своей организации

GET /organizations

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


GET /organizations?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

[{
	"id": 162,
	"name": "Наименование",
	"mapExtent": "63.39152, -66.79, 94.921875, -80.15625",
	"inn": "212125458752",
	"phone": "",
	"email": "email@emailDomen.com",
	"homepage": "www.myWebSite.com",
	"kpp": "0000000000000000001",
        "address": ""
},...]


// id организации, целое число
// название организации, строка
// видимая часть карты(координаты левой нижней и правой верхней точек), строка
// ИНН, целое число
// телефон, строка
// email, строка
// домашняя страница, строка
// КПП, целое число
// адрес, строка

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

Формат: text/plain

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

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

Формат: text/plain

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

Создание организации

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

POST /organizations

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


POST /organizations?token=bw3ty3h46yth

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

Пример запроса:

Формат: json

{
	"address": "TestOrg",
	"email": "TestOrg@mail.ru",
	"homepage": "hoiee.com",
	"inn": "324234234",
	"kpp": "234234234234",
	"mapExtent": "74.7296, 27.37, 109.160156, 21.621",
	"name": "Name",
	"phone": "3223234"
}


// адрес, строка
// email, строка
// домашняя страница, строка
// ИНН, целое число
// КПП, целое число
// видимая часть карты(координаты левой нижней и правой верхней точек), строка
// название организации, строка
// телефон, строка

Ответ:

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

Формат: json

{
	"id": 240,
	"order": 100,
	"address": "TestOrg",
	"email": "TestOrg@mail.ru",
	"homepage": "hoiee.com",
	"inn": "324234234",
	"kpp": "234234234234",
	"mapExtent": "74.7296, 27.37, 109.160156, 21.621",
	"name": "TestOrg",
	"phone": "3223234"
}


// id организации, целое число
// название организации, строка
// адрес, строка
// email, строка
// домашняя страница, строка
// ИНН, целое число
// КПП, целое число
// видимая часть карты(координаты левой нижней и правой верхней точек), строка
// название организации, строка
// телефон, строка

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

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

Формат: text/plain

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

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

Не всевидящим пользователям доступна информация только по своей организации

GET /organizations/all

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


GET /organizations/all?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

[{
	"id": 1,
	"name": "Наименование",
	"mapExtent": "63.391, -66.79190, 94.921, -80.15625",
        "usersCount": 12,
        "groupsCount": 2,
	"inn": "357782147462",
	"phone": "",
	"email": "email@emailDomen.com",
	"homepage": "www.myWebSite.com",
	"kpp": "0000000000000000001",
	"address": "Страна, город, улица",
},...]


// id организации, целое число
// название организации, строка
// видимая часть карты(координаты левой нижней и правой верхней точек), строка
// количество пользователей, целое число
// количество групп, целое число
// ИНН, целое число
// телефон, строка
// email, строка
// домашняя страница, строка
// КПП, целое число
// адрес, строка

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

Формат: text/plain

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

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

Формат: text/plain

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

Редактирование организации

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

PUT /organizations/{id}

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


PUT /organizations/144?token=bw3ty3h46yth

id: id организации

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

Пример запроса:

Формат: json

{
	"id": 144,
	"address": "Адрес организации",
	"email": " ",
	"groupsCount": 4,
	"homepage": "http://www.oursite.com",
	"inn": " ",
	"kpp": " ",
	"mapExtent":"55.806,55.782,49.148,49.106",
	"name": "Новое название",
	"phone": "+79655908889",
	"usersCount": 8
}


// id организации, целое число
// адрес, строка
// email, строка
// количество групп, целое число
// домашняя страница, строка
// ИНН, целое число
// КПП, целое число
// видимая часть карты (координаты левой нижней и правой верхней точек), строка
// название организации, строка
// телефон, строка
// количество пользователей, целое число

Ответ:

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

Формат: json

{
	"id": 144,
	"name": "Новое название",
	"mapExtent":"55.806, 55.782, 49.148, 49.106",
	"address": "Адрес организации",
	"inn": "",
	"phone": "+79655908889",
	"email": "",
	"homepage": "http://www.oursite.com",
	"kpp": ""
}


// id, целое число
// название организации, строка
// видимая часть карты(координаты левой нижней и правой верхней точек), строка
// адрес, строка
// ИНН, целое число
// телефон, строка
// email, строка
// домашняя страница, строка
// КПП, целое число

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Удаление организации

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

DELETE /organizations/{id}

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


DELETE /organizations/32?token=bw3ty3h46yth

id: id организации

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Группы ТС данной организации

Не всевидящим пользователям доступна информация только по своей организации

GET /organizations/{id}/cars/groups

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


GET /organizations/67/cars/groups?token=bw3ty3h46yth

id: id организации

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

Ответ:

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

Формат: json

[{
	"id": 4662,
	"name": "Название",
	"notes": "",
	"organizationId": 67
},...]


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

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

Формат: text/plain

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

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

Формат: text/plain

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

Количество организаций

Не всевидящим пользователям доступна информация только по своей организации

GET /organizations/count

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


GET /organizations/count?token=bw3ty3h46yth

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

Ответ:

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

Формат: text

410

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Нет комментариев

Automap — rest — carGroups(before delete /all)

20 января 2015 admin

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

Группы ТС

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

GET /cars/groups

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


GET /cars/groups?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

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


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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

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

PUT /cars/groups/{id}

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


PUT /cars/groups/id?token=bw3ty3h46yth

id: id группы

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

Формат: json

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


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

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

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

Формат: json

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


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

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

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

POST /cars/groups

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


POST /cars/groups?token=bw3ty3h46yth

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

Формат: json

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


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

Ответ:

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

Формат: json

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


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

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

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

Формат: text/plain

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

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

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

DELETE /cars/groups/groupId

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


DELETE /cars/groups/345?token=bw3ty3h46yth

groupId: id группы

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /cars/groups/groupId/cars

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


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

groupId: id группы

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

Ответ:

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

Формат: json

[{
		"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 — объект не найден

Формат: text/plain

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

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

Формат: text/plain

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

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

GET cars/groups/all

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


GET /cars/groups/all?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

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


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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /cars/groups/count

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


GET /cars/groups/count?token=bw3ty3h46yth

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

Ответ:

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

Формат:text

10

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /cars/groups/wheel

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


GET /cars/groups/wheel?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

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


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

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

Формат: text/plain

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

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

Формат: text/plain

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

Нет комментариев

Automap — rest — Documentation

20 января 2015 admin

Automap GS / Руководство разработчика REST /Документация

Документация

Документация пользователя

GET /docs/user

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


GET /docs/user?token=bw3ty3h46yth

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

Ответ:

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

Формат: text/plain

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

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

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

Формат: text/plain

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

Документация администратора

GET /docs/administration

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


GET /docs/administration?token=bw3ty3h46yth

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

Ответ:

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

Формат: text/plain

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

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

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

Формат: text/plain

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

Нет комментариев

Automap — rest — CustomFields

20 января 2015 admin

Automap GS / Руководство разработчика REST / Дополнительные поля

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

Список дополнительных полей

GET /cars/customfields

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


GET /cars/customfields?token=gtr543lpas87

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

Ответ:

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

Формат: json

[{
	"id": 324,
	"name": "дробное",
	"translit": "drobnoe",
	"format": "float",
	"groupName": "",
	"possibleValues": null,
	"regexp": null,
	"minLength": 0,
	"maxLength": 0,
	"isRequired": false,
	"defaultValue": "123.640",
	"visible": false,
	"order": null
},…]


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

Примечание:

В зависимости от передаваемого формата данных пользователю становятся доступны определенные поля для добавления и редактирования информации о выбранном дополнительном поле:

Строка (string) — валидация поля (regexp), минимальная длина строки (minLength), максимальная длина строки (maxLength), значение по умолчанию (defaultValue), обязательное поле (isRequired), отображение поля (visible).
Целое число (int) — значение по умолчанию (defaultValue), обязательное поле (isRequired), отображение поля (visible).
Дробное число (float) — значение по умолчанию (defaultValue), обязательное поле (isRequired), отображение поля (visible).
Дата (date) — обязательное поле (isRequired), отображение поля (visible).
Условие (bool) — значение по умолчанию (defaultValue), обязательное поле (isRequired), отображение поля (visible).
Список (list) — возможные значения списка (possibleValues), значение по умолчанию (defaultValue), обязательное поле (isRequired), отображение поля (visible).

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

Формат: text/plain

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

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

Формат: text/plain

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

Добавление дополнительного поля

POST /cars/customfields

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


POST /cars/customfields?token=gtr543lpas87

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

Пример запроса:

Формат: json

{
	"defaultValue": 10,
	"format": "int",
	"isRequired": true,
	"name": "Новое поле",
	"visible": true
}


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

Ответ:

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

Формат: json

{
	"id": 822,
	"name": "Новое поле",
	"translit": "Novoe_pole",
	"format": "string",
	"groupName": "",
	"possibleValues": null,
	"regexp": "Регулярное выражение",
	"minLength": 0,
	"maxLength": 225,
	"isRequired": true,
	"defaultValue": null,
	"visible": true,
	"order": null
}


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

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

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

Формат: text/plain

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

Редактирование дополнительного поля

PUT /cars/customfields/{id}

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


PUT /cars/customfields/82?token=gtr543lpas87

id: id дополнительного поля

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

Пример запроса:

Формат: json

{
	"id": 82,
	"name": "Дополнительное поле",
	"translit": "Dopolnitelnoe_pole",
	"format": "list",
	"groupName": "",
	"possibleValues": ["значение 1"],
        "regexp": null,
	"minLength": 0,
	"maxLength": 0,
	"isRequired": true,
	"defaultValue": "значение 1",
	"visible": true,
	"order": null
}


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

Ответ:

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

Формат: json

{
	"id": 82,
	"name": "Дополнительное поле",
	"translit": "Dopolnitelnoe_pole",
	"format": "list",
	"groupName": "",
	"possibleValues": ["значение 1"],
	"regexp": null,
	"minLength": 0,
	"maxLength": 0,
	"isRequired": true,
	"defaultValue": "значение 1",
	"visible": true,
	"order": null
}


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

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Удаление дополнительного поля

DELETE /cars/customfields/{id}

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


DELETE /cars/customfields/82?token=gtr543lpas87

id: id дополнительного поля

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Нет комментариев

← Previous 1 2 3 … 5 Next →