Хранилища

Список хранилищ

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

GET /datastores

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

GET /datastores?token=mbs90lon2a8

Ответ:

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

[{
    "id": 1,
    "name": "Datastore",
    "host": "192.168.63.36",
    "port": 5432,
    "database": "data",
    "login": "login",
    "isInfrastructure": true,
    "schemaName": "data"
},...]

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

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

Создание хранилища

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

POST /datastores

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

POST /datastores?token=mbs90lon2a8

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

{
    "name": "Datastore",
    "host": "192.168.63.36",
    "port": 5432,
    "database": "data",
    "login": "login",
    "isInfrastructure": true,
    "schemaName": "data"
}

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

Ответ:

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

{
    "id": 25,
    "name": "Datastore",
    "host": "192.168.63.36",
    "port": 5432,
    "database": "data",
    "login": "login",
    "isInfrastructure": true,
    "schemaName": "data"
}

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

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

Изменение хранилища

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

PUT /datastores/{id}

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

PUT /datastores/64?token=mbs90lon2a8

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

{
    "id": 64,
    "name": "Datastore",
    "host": "192.164.63.32",
    "port": 5874,
    "database": "data",
    "login": "login",
    "password": "654321",
    "isInfrastructure": true,
    "schemaName": "data"
}

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

Ответ:

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

{
    "id": 64,
    "name": "Datastore",
    "host": "192.164.63.32",
    "port": 5874,
    "database": "data",
    "login": "login",
    "isInfrastructure": true,
    "schemaName": "data"
}

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

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

Удаление хранилища

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

DELETE /datastores/{id}

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

DELETE /datastores/64?token=mbs90lon2a8

Ответ:

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

{
    "delete": true
}

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

Экспорт хранилищ

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

GET /datastores.xlsx

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

GET /datastores.xlsx?token=mbs90lon2a8

Ответ:

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

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

Проекции хранилищ

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

GET /datastores/projections

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

GET /datastores/projections?token=mbs90lon2a8

Ответ:

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

[{
    "projection": "EPSG:3819"
},...]

// проекция

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

Проекции хранилища

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

GET /datastores/{id}/projections

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

GET /datastores/42/projections?token=mbs90lon2a8

Ответ:

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

[{
    "projection": "EPSG:3819"
},...]

// проекция

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

Таблицы хранилища

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

GET /datastores/{id}/tables

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

GET /datastores/42/tables?token=mbs90lon2a8

Ответ:

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

[{
    "datastoreId": 42,
    "tableId": 0,
    "layerId": null,
    "nameDb": "departments_news_points",
    "geometryType": "POINT"
},...]

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

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

Информация о таблице хранилища

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

GET /datastores/{id}/tables/{tablename}

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

GET /datastores/42/tables/test_table?token=mbs90lon2a8

Ответ:

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

{
    "geometryType": "multilinestring",
    "name": "test_table",
    "title": "Тестовая таблица",
    "style": {
        "styleName": null,
        "geoCss": "* {\n stroke-dashoffset: 0;\n}",
        "base": false,
        "simple": false
    },
    "dataStoreId": 22,
    "attributes": [{
        "name": "attribute",
        "rusName": "Атрибут",
        "type": null,
        "isTitle": null,
        "title": null,
        "isView": true,
        "view": true,
        "order": null
    },...]
}

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

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

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

API сервиса построения маршрутов router.geo4.me

Определение местоположения

Данный сервис необходим для определения местоположения ближайшей точки дорожной сети к указанной координате.
Ближайшая точка определяется при отправке запроса следующего формата:

GET/locate?loc=lat,lon

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

GET/locate?loc=52.4224,13.333086

Ответ:

{
	"mapped_coordinate": [52.42244, 13.332101],
	"status": 0
}

// координаты на карте
// статус: 0 – успешное выполнение запроса, 207 – нет маршрута

Ближайшая точка

Данный сервис позволяет определить ближайшую точку на некотором участке улицы дорожной сети к указанной координате.
Ближайшая точка определяется при отправке запроса следующего формата:

GET/nearest?loc=lat,lon

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

GET/nearest?loc=52.4224,13.333086

Ответ:

{
	"name": "Mariannenstraße",
	"mapped_coordinate": [52.422592, 13.333837],
	"status": 0
}

// название улицы
// координаты на карте
// статус: 0 – успешное выполнение запроса, 207 – нет маршрута

При использовании вышеупомянутого синтаксиса ответ приходит в формате JSON, который может быть дополнительно обработан многими языками программирования. При этом на выходе данные могут быть отформатированы как JSONP:

GET/nearest?52.555485441735&13.342227642887&jsonp=function

Запрос возвращает результат в формате JSON, обёрнутый функцией (), которая может быть легко переработана при помощи JavaScript:

function({"status":0,"result":[52.55567, 13.34252]"})

Построение маршрута

Данный сервис позволяет построить кратчайший маршрут через указанные координаты с учетом порядка следования координат. Основные точки между координатами (lat1, lon1) и (lat2, lon2) запрашиваются следующим образом:

GET/viaroute?loc=lat1,lon1&loc=lat2,lon2

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

GET/viaroute?loc= 55.7887400, 49.1221400&loc= 55.8437600, 48.5178400

Чтобы построить маршрут через определенные координаты, перечислите их в запросе string в порядке своего появления (на текущий момент стоит максимальное ограничение в 25 точек).

При построении маршрута появляется параметр hint_data, который дает (кодированную) достоверную информацию о начальных и конечных точках. При этом при реализации API предполагается следующее:

• добавление &checksum=… в URL, где ‘…’ – это контрольная сумма в hint_data.checksum из предыдущего запроса.
• добавление &hint=… после каждого &loc=… параметра, если он не меняется по сравнению с предыдущим запросом.
• в случае, если координаты были изменены, то они не дают никакой «подсказки» для указанной координаты.
• «подсказки» должны быть размещены непосредственно после параметра &loc=…

Ответ:

{
	"hint_data": {
		"locations": ["1","2"],
		"checksum": 3637997664
	},
	"route_name": ["1","2"],
	"found_alternative": false,
	"via_points": [[55.788872,49.121826],
	[55.843784,48.517399]],
	"route_summary": {
		"end_point": "",
		"start_point": "Университетская улица",
		"total_time": 3128,
		"total_distance": 42557
	},
	"route_geometry": "",
	"status_message": "Found route between points",
	"via_indices": [0, 362],
	"status": 0
}

// информация о «подсказывающих» данных
// местоположение
// контрольная сумма

// массив строк, который хранит наименования маршрутов
// поиск альтернатив
// массив точек, в котором каждая точка представляет собой массив координат: [lat, lon]

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

// геометрия маршрута
// сообщение о статусе (находит маршрут между точками или нет)
// целочисленный массив, который содержит положение начальных и конечных путевых точек
// статус: 0 – успешное выполнение запроса, 207 – нет маршрута

Таблица расстояний по дорожной сети

Запрос по таблицам расстояний аналогичен запросу по маршруту. Схема запроса по таблице расстояний выглядит следующим образом:

GET/table?loc=lat1,lon1&loc=lat2,lon2&…loc=latX,lonX

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

GET/table?loc=52.554070,13.160621&loc=52.431272,13.720654&loc=52.554070,13.720654&loc=52.554070, 13.160621&z=14

Ответ:

{
    "distance_table": [
        [0, 26084, 22942, 26989],
        [26319, 0, 30810, 19607],
        [22782, 30482, 0, 37495],
        [27376, 19415, 37693, 0]
    ]
}

Параметры

В запрос может быть добавлен ряд дополнительных параметров:

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

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

GET /log/app

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

GET /log/app?token=bw3ty3h46yth

GET /log/app?level=3

Ответ:

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

[
	{
		id: "52bd1f69e4b0f5cc9d5de9b3",
		time: 1388126057286,
		message: "refresh inmemory car storage at Fri Dec 27",
		level: "NOTICE",
		logger: "application",
		thread: "application-akka.actor.default-d-11334",
	}
]

// массив логов

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

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

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

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

GET /log/app/count

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

GET /log/app/count?token=bw3ty3h46yth

Ответ:

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

4303

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

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

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

Источники логов

GET /log/app/loggers

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

GET /log/app/loggers?token=bw3ty3h46yth

Ответ:

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

[
	{
		value: "application"
	}
]

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

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

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

Количество источников логов

GET /log/app/loggers/count

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

GET /log/app/loggers/count?token=bw3ty3h46yth

Ответ:

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

8

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

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

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

Потоки логов

GET /log/app/threads

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

GET /log/app/threads?token=bw3ty3h46yth

Ответ:

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

[
	{
		value: "application-akka.actor.default-dispatcher-15756"
	}
]

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

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

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

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

GET /log/app/threads/count

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

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

Ответ:

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

145

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

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

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

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

GET /log/app/levels

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

GET /log/app/levels?token=bw3ty3h46yth

Ответ:

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

[
	{
		id: 1,
		type: "ALERT"
	}
]

// массив уровней ошибок

// id уровня ошибки
// тип уровня ошибки

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

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

Иконки

Список иконок

GET /cars/icons

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

GET /cars/icons?token=bw3ty3h46yth

Параметры фильтрации:

GET /cars/icons?name=iconName&rotate=true

Ответ:

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

[{
		id: 1,
		name: "Автобус 3D",
		width: 384,
		height: 48,
		initialRotation: 0,
		rotate: true,
		type: 1,
		src0: "/cars/icons/222/0",
		src1: "/cars/icons/222/1",
		src2: "/cars/icons/222/2"
},...]

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

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

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

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

GET /cars/icons/all

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

GET /cars/icons/all?token=bw3ty3h46yth

Ответ:

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

[{
		id: 222,
		name: "Автобус 3D",
		width: 384,
		height: 48,
		initialRotation: 0,
		rotate: true,
		type: 1,
		src0: "/cars/icons/222/0",
		src1: "/cars/icons/222/1",
		src2: "/cars/icons/222/2"
},...]

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

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

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

Получение иконки

GET /cars/icons/{id}/{type}

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

GET /cars/icons/24/1?token=bw3ty3h46yth

Ответ:

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

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

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

Добавление иконки ТС

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

POST /cars/icons

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

POST /cars/icons?token=bw3ty3h46yth

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

{
	"initialRotation": 25,
	"name": "Новая иконка",
	"rotate": true,
	"type": 0,
	"src0": "p19qst4j73p1a187q18np13tkqksn.jpg",
	"src1": "p19qst4lmt1iau1g0212lf1r3icchp.jpg",
	"src2": "p19qst4np91s0hcg71aoeoe7174gr.jpg"
}

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

Ответ:

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

{
	"id": 185,
	"name": "Новая иконка",
	"width": 30,
	"height": 22,
	"initialRotation": 25,
	"rotate": true,
	"type": 0,
	"src0": "/cars/icons/185/0",
	"src1": "/cars/icons/185/1",
	"src2": "/cars/icons/185/2"
}

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

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

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

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

Изменение иконки ТС

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

PUT /cars/icons/{id}

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

PUT /cars/icons/185?token=bw3ty3h46yth

{
	"id": 185,
	"height": 22,
	"initialRotation": 15,
	"name": "Новое название",
	"rotate": false,
	"src0": null,
	"src1": null,
	"src2": null,
	"type": 0,
	"width": 30
}

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

Ответ:

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

{
	"id": 185,
	"name": "Новое название",
	"width": 30,
	"height": 22,
	"initialRotation": 15,
	"rotate": false,
	"type": 0,
	"src0": "/cars/icons/185/0",
	"src1": "/cars/icons/185/1",
	"src2": "/cars/icons/185/2"
}

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

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

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

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

Удаление иконки

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

DELETE /cars/icons/{id}

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

DELETE /cars/icons/24?token=bw3ty3h46yth

Ответ:

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

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

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

Количество иконок

GET /cars/icons/count

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

GET /cars/icons/count?token=bw3ty3h46yth

Ответ:

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

24

// Количество иконок

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

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

Предпоказ иконки

GET /cars/icons/{id}/{status}/preview/

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

GET /cars/icons/31/0/preview?token=bw3ty3h46yth

Ответ:

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

Формат: image/png

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

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

Предпоказ только что загруженной иконки

GET /cars/icons/{src}/{type}/preview

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

GET /cars/icons/p19qst4j73p1a187q18np13tkqksn.jpg/0/preview?token=bw3ty3h46yth

Ответ:

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

Формат: image/png

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

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

Водители

Список водителей ТС

GET /drivers

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

GET /drivers?token=bw3ty3h46yth

Ответ:

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

[
	{
		"id": 982,
		"fio": "+",
		"phone": "",
		"notes": "",
		"hasPhoto": false,
		"orgId": 1162
	}
]

// массив объектов водителей

// id водителя
// фио
// телефон
// примечание
// у водителя имеется фото
// id организации

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

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

Список водителей ТС (с более быстрой загрузкой, без фильтрации)

GET /drivers/all

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

GET /drivers/all?token=bw3ty3h46yth

Ответ:

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

[
	{
		"id": 982,
		"fio": "+",
		"phone": "",
		"notes": "",
		"hasPhoto": false,
		"orgId": 1162
	}
]

// массив объектов водителей

// id водителя
// фио
// телефон
// примечание
// у водителя имеется фото
// id организации

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

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

Поиск водителя по id

GET /drivers/{id}

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

GET /drivers/982?token=bw3ty3h46yth

Ответ:

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

{
	"id": 982,
	"fio": "+",
	"phone": "",
	"notes": "",
	"wire": null,
	"extId": null,
	"hasPhoto": false,
	"orgId": 1162
}

// id водителя
// фио
// телефон
// примечание
// идентификатор ключа

// у водителя имеется фото
// id организации

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

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

Изменение водителя ТС

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

PUT /drivers/{id}

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

PUT /drivers/123?token=bw3ty3h46yth

{
	"fio": "ФИО",
	"notes": "Опытный водитель ",
	"orgId": 1,
	"phone": "12345678"
}

// фио
// примечание
// id организации
// телефон

Ответ:

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

{
	"fio": "ФИО",
	"hasPhoto": false,
	"id": 123,
	"notes": "Опытный водитель ",
	"orgId": 1,
	"phone": "12345678"
}

// фио
// наличие фото
// id водителя
// примечание
// id организации
// телефон

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

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

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

Создание водителя ТС

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

POST /drivers

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

POST /drivers?token=bw3ty3h46yth

{
	"fio": "ФИО",
	"notes": "Отличный водитель",
	"orgId": 1,
	"phone": "12345678"
}

// фио
// примечание
// id организации
// телефон

Ответ:

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

{
	"fio": "ФИО",
	"hasPhoto": false,
	"id": 1101,
	"notes": "Отличный водитель",
	"orgId": 1,
	"phone": "12345678"
}

// фио
// наличие фото
// id водителя
// примечание
// id организации
// телефон

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

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

Удаление водителя ТС

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

DELETE /drivers/{id}

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

DELETE /drivers/1125?token=bw3ty3h46yth

Ответ:

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

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

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

Список водителей в xlsx файле

GET /drivers.xlsx

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

GET /drivers.xlsx?token=bw3ty3h46yth

Ответ:

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

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

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

Фотография водителя

GET /drivers/{id}/photo

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

GET /drivers/1123/photo?token=bw3ty3h46yth

Ответ:

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

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

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