Page tree

Citypoint - контроль и аналитика автопарка

Skip to end of metadata
Go to start of metadata

Запрос:

URL:

Все группы пользователя:

               PUSH https://api.url/v2.1/user/<user_id>/zones

Доп. Заголовки:

Content-Type - формат запроса. Должно быть "application/vnd.api+json".

Accept - указание формата ответа. Должно быть "application/vnd.api+json".

Authorization - для передачи токена. Передается в формате: Bearer <access_token>.

Данные запроса:

Данные присылаются в формате JSON API. Формат данных аналогичен формату данных в ответе на запрос получения данных зоны, за исключением, что не должно указываться Id.

Ответ присылается в формате JSON API. В заголовке Location будет содержаться ссылка на зону. В теле ответа будет полное описание созданной зоны.


ПолеОписание
data

Содержит данные в формате JSON API.

ПолеТипОписание
typestringТип ресурса (всегда "zone")
attributesobjectДанные объекта (см. Описание атрибутов)
relationshipsobjectсвязанные объекты

Описание атрибутов:

ПолеТипNullableОписание
NamestringнетНазвание зоны
DescriptionstringдаОписание зоны
Geometryobject<GeoJSON>нет

Расположение зоны (Геометрия в формате GeoJSON)


Поддерживаются только геометрии типа: Point, LineString и Polygon

Геометрии типа Polygon не должны быть самопересекающимися и содержать дыры.

Геометрии типа Point и LineString должны иметь дополнительное поле radius в properties (обозначает радиус/ширину точки/линии в метрах).

Colorhex stringнет

Цвет геозоны. Передаётся шестнадцатеричным числом RRGGBBAA

RR - красный байт

GG - зелёный байт

BB - синий байт

AA - прозрачность (0x00 - полностью прозрачный (невидимый), 0xff - полностью непрозрачный)

Коды ответов:

201 Сreated - Сервер обработал запрос. В теле ответа  содержится созданная зона. Также будет передан заголовок Last-Modified.

401 Unauthorized - не передан заголовок Authorization, либо токен не корректный или окончился период действия.

403 Forbidden - недостаточно прав.

400 Bad Request - Переданы не поддерживаемые параметры либо сервер не понял запрос (описание ошибки в теле ответа).


Пример:

POST http://api.url/v2.1/user/1/zones HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>
ContentType: application/vnd.api+json

{ 
	"data": {
        "type": "zone",
        "attributes": {
            "Name": "",
            "Description": "Test Zone",
            "Geometry": {
                "type": "Feature",
                "geometry": {
                    "type": "Point",
                    "coordinates": [
                        11.11111,
                        22.22222
                    ]
                },
                "properties": {
                    "radius": 200
                }
            },
            "Color": "FF00007F"
        }
    }
}

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
Allow: GET
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT

{
    "links": {
        "self": "https://api.url/v2.1/user/1/zones/123"
    },
    "data": {
        "id": "123",
        "type": "zone",
        "attributes": {
            "Name": "Test Zone",
            "Description": "",
            "Geometry": {
                "type": "Feature",
                "geometry": {
                    "type": "Point",
                    "coordinates": [
                        11.11111,
                        22.22222
                    ]
                },
                "properties": {
                    "radius": 200
                }
            },
            "Color": "FF00007F"
        }
    }
}
  • No labels