Automap — rest — ways
Маршруты
Список маршрутов
GET /ways
Структура запроса:
GET /ways?token=gtr543lpas87
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 805,
"geom": {
"type": "LineString",
"coordinates":
[[48.38378906,54.0916173],
[49.9822998,54.27163997]]
},
"name": "Название маршрута",
"color": "ff0000",
"active": true,
"organizationId": 102,
"coordinates":
[[48.38378906,54.0916173],
[49.9822998,54.27163997]]
},…]Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Добавление маршрута
POST /ways
Структура запроса:
POST /ways?token=gtr543lpas87
token: ключ доступа
Пример запроса:
Формат: json
{
"color": "ff9900",
"geom": {
"coordinates": [[48.54789733886719,
56.8433391974011],
[48.830108642578125, 56.85873346253295]],
"type": "LineString"
},
"name": "Маршрут",
"organizationId": 1
}
// цвет, строка
// информация о геометрии, объект
// координаты, массив
// тип, строка
// название маршрута, строка
// id организации, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 2101,
"geom": {
"type": "LineString",
"coordinates": [[48.54789734,
56.8433392]]
},
"name": "Маршрут",
"color": "ff9900",
"active": true,
"organizationId": 1,
"coordinates": [[48.54789733886719,
56.8433391974011]]
}
// id маршрута, целое число
// информация о типе геометрии, объект
// тип геометрии, строка
// координаты, массив
// название маршрута, строка
// цвет маршрута, строка
// id организации, целое число
// координаты, массив
Статус: 400 — ошибка в запросе
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Информация о маршруте по ID
GET /ways/{id}
Структура запроса:
GET /ways/805?token=gtr543lpas87
id: id маршрута
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Формат: json
[{
"id": 805,
"geom": {
"type": "LineString",
"coordinates":
[[48.38378906,54.0916173],
[49.9822998,54.27163997]]
},
"name": "Название маршрута",
"color": "ff0000",
"active": true,
"organizationId": 102,
"coordinates":
[[48.38378906,54.0916173],
[49.9822998,54.27163997]]
},...]
// id маршрута, целое число
// информация о типе геометрии
// тип геометрии, строка
// координаты, массив
// название маршрута, строка
// цвет маршрута, строка
// id организации, целое число
// координаты, массив
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Редактирование маршрута
PUT /ways/{id}
Структура запроса:
PUT /ways/806?token=gtr543lpas87
id: id маршрута
token: ключ доступа
Пример запроса:
Формат: json
{
"color": "000dff",
"geom": {
"coordinates": [[48.75663757,
56.8645516],
[48.7147522,
56.81873278]],
"type": "LineString"
},
"name": "Новое название",
"organizationId": 242
}
// цвет, строка
// информация о геометрии
// координаты
// тип, строка
// название маршрута, строка
// id организации, целое число
Ответ:
Статус: 200 — успешное выполнение
Формат: json
{
"id": 806,
"geom": {
"type": "LineString",
"coordinates": [[48.75663757,56.8645516],
[48.7147522,56.81873278]]
},
"name": "Новое название",
"color": "000dff",
"active": true,
"organizationId": 242,
"coordinates": [[48.75663757,56.8645516],
[48.7147522,56.81873278]]
}
// id маршрута, целое число
// информация о типе геометрии, объект
// тип геометрии, строка
// координаты, массив
// название маршрута, строка
// цвет маршрута, строка
// id организации, целое число
// координаты, массив
Статус: 400 — ошибка в запросе
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Удаление маршрута
DELETE /ways/{id}
Структура запроса:
DELETE /ways/806?token=bw3ty3h46yth
id: id маршрута
token: ключ доступа
Ответ:
Статус: 200 — успешное выполнение
Статус: 404 — объект не найден
Формат: text/plain
Содержит описание ошибки
Статус: 500 — ошибка на сервере
Формат: text/plain
Содержит описание ошибки
Нет комментариев