You are here: Home / 2013 / Ноябрь / 26 / Automap — rest — geozones

Automap — rest — geozones

26 ноября 2013 admin
назад
Automap / Руководство разработчика REST /Геозоны

GET /zones

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


GET /zones?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

[{
        "id": 17,
        "geom": {
                "type": "Polygon",
                "coordinates": [[47.85021186,55.99901992],
                        [47.85045862,55.99903792],
                        [47.85022259,55.99921791],
                        [47.85021186,55.99901992]]
        },
        "name": "Геозона",
        "color": "66ff33",
        "active": true,
        "isBase": false,
        "organizationId": 10,
        "coordinates":[[47.85021185874939,55.99901992242232],
                [47.85045862197876,55.99903792134154],
                [47.85022258758545,55.9992179100726],
                [47.85021185874939,55.99901992242232]],
        "carsIds": []
},...]

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




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



// id ТС, массив

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

Формат: text/plain

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

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

Формат: text/plain

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

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

POST /zones

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


POST /zones?token=bw3ty3h46yth

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

Формат: json

{
        "cars": [],
        "color": "33eeff",
        "geom": {
                "coordinates": [[48.451080322265625,56.9752985148217],
                        [48.871307373046875,56.9820339049709]],
                "type": "Polygon"
        },
        "isBase": true,
        "name": "Новая зона контроля",
        "organizationId": 1
}

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

// тип геометрии, строка

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

Ответ:

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

Формат: json

{
        "id": 230,
        "geom": {
                "type": "Polygon",
                "coordinates": [[48.45108032,56.97529851],
                        [48.87130737,56.9820339]]
        },
        "name": "Новая зона контроля",
        "color": "33eeff",
        "active": true,
        "isBase": true,
        "organizationId": 1,
        "coordinates": [[48.451080322265625,56.9752985148217],
                [48.871307373046875,56.9820339049709]],
        "carsIds": []
}

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


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

// id ТС, массив

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

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

Формат: text/plain

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

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

PUT /zones/{id}

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


PUT /zones/621?token=gtr543lpas87

id: id геозоны

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

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

Формат: json

{
        "cars": [631,224,634,625,582],
        "color": "ffb833",
        "geom": {
                "coordinates": [[37.65915871,55.74218747],
                        [37.65933037,55.74081045],
                        [37.66147614,55.74131778]],
                "type": "Polygon"
        },
        "isBase": false,
        "name": "Новое название зоны",
        "organizationId": 1
}

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


// тип геометрии, строка

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

Ответ:

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

Формат: json

{
        "id": 621,
        "geom": {
                "type": "Polygon",
                "coordinates": [[37.65915871,55.74218747],
                        [37.65933037,55.74081045],
                        [37.66147614,55.74131778]]
        },
        "name": "Новое название зоны",
        "color": "ffb833",
        "active": true,
        "isBase": false,
        "organizationId": 1,
        "coordinates": [[37.65915871,55.74218747],
                [37.65933037,55.74081045],
                [37.66147614,55.74131778]],
        "carsIds": [631,224,634,625,582]
}

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



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


// id ТС, массив

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

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

Формат: text/plain

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

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

DELETE /zones/id

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


DELETE /zones/6?token=bw3ty3h46yth

id: id геозоны

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

Ответ:

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

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

Формат: text/plain

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

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

Формат: text/plain

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

GET /zones/id/cars

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


GET /zones/1121/cars?token=bw3ty3h46yth

id: id геозоны

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

Ответ:

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

Формат: json

[{
		"carId": 1,
		"inZone": true,
		"zoneId": 1121
},...]

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

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

Формат: text/plain

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

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

Формат: text/plain

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

GET /zones/cars

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


GET /zones/cars?token=bw3ty3h46yth

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

Ответ:

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

Формат: json

[{
	"inZone": false,
	"carId": 4077,
	"zoneId": 1201
},...]

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

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

Формат: text/plain

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

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

Формат: text/plain

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

Posted in