Archives by date

You are browsing the site archives by date.

AutoMap — rest — files

23 января 2015 admin

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

Файлы

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

GET /files/{uuid}

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


GET /files/p189tc0i1f1pjb17j91k?token=mbs90lon2a8

uuid: id файла

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Добавление файла

POST /files/upload

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


POST /files/upload?token=mbs90lon2a8

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

Ответ:

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

Формат: json

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


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

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

Формат: text/plain

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

AutoMap — rest — layers

23 января 2015 admin

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

Слои

Базовые слои

GET /layers/base

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


GET /layers/base?token=mbs90lon2a8

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

Ответ:

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

Формат: json

{
	"schemas": [{
		"name": "Карта России",
		"className": "new M.Rekod()",
		"order": 0
	},...],
	"spaces": [{
		"name": "Космоснимки Роскосмос",
		"className": "new M.TileLayer",
		"order": 0
	},...]
}





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

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

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

Формат: text/plain

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

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

Формат: text/plain

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

AutoMap — rest — functional

23 января 2015 admin

mapSurfer GS / Руководство разработчика REST / Функционал геопортала

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

Обращение к функционалу геопорталу — GET запрос

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

GET /geoportal/*path

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


GET /geoportal/layers?token=mbs90lon2a8

path: путь к функционалу

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Обращение к функционалу геопортала — POST запрос

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

POST /geoportal/*path

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


POST /geoportal/layers?token=mbs90lon2a8

path: путь к функционалу

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

Ответ:

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

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

Формат: text/plain

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

AutoMap — rest — docs

23 января 2015 admin

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

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

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

GET /docs/user

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


GET /docs/user?token=mbs90lon2a8

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /docs/administration

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


GET /docs/administration?token=mbs90lon2a8

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

AutoMap — rest — log

23 января 2015 admin

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

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

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

GET /log/app

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


GET /log/app?token=mbs90lon2a8

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

Ответ:

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

Формат: json

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /log/app/count

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


GET /log/app/count?token=mbs90lon2a8

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

Ответ:

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

Формат: json

5124

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /log/app/threads

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


GET /log/app/threads?token=mbs90lon2a8

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

Ответ:

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

Формат: json

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /log/app/threads/count

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


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

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

Ответ:

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

Формат: json

145

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /log/app/levels

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


GET /log/app/levels?token=mbs90lon2a8

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

Ответ:

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

Формат: json

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


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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

GET /log/app/levels/count

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


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

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

Ответ:

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

Формат: json

19

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

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

Формат: text/plain

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

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

Формат: text/plain

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

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

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