v2.1 Изменение списка привязанных к ТС геозон

Изменение списка привязанных геозон.

Заменяет текущий список привязанных зон на новый.

Запрос:

URL:

Изменение списка привязанных геозон:

PATCH https://api.url/v2.1/user/<user_id>/cars/<car_id>/relationships/OperatedZones

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

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

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

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

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

Запрос отсылается в формате JSON API.

Поле

Описание

data

Содержит список геозон которые должны быть привязанных к ТС.

Каждый объект содержит:

Поле	Тип	Описание
type	string	тип ресурса (всегда "zone")
id	string	идентификатор зоны

Ответ:

Ответ присылается в формате JSON API.

Поле

Описание

links

Поле links содержит ссылки на ресурсы.

Минимально он должен содержать ссылку на текущий ресурс (self).

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

200 ОК - Сервер обработал запрос, список привязанных гео зон изменён на тот что пришёл в запросе. В теле ответа содержится текущий список привязанных зон.

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

403 Forbidden - нет прав на изменение зон у данной тс.

404 Not Found - ТС не найдена или принадлежит другому пользователю.

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

Также возможны другие ошибки.

Пример

Запрос списка всех ТС:

PATCH https://api.url/v2.1/user/1/cars/1/relationships/OperatedZones HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer <auth token>

{      "data": [
        { "type": "zone", "id": "1" },
        { "type": "zone", "id": "2" },
        { "type": "zone", "id": "3" },
        { "type": "zone", "id": "4" }
   ]
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Allow: GET
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT
					
{
    "links": {
        "self": "http://api.url/v2.1/user/1/cars/1/relationships/OperatedZones"
    },
    "meta":{
        "total_count": 4
    },
    "data": [
        { "type": "zone", "id": "1" },
        { "type": "zone", "id": "2" },
        { "type": "zone", "id": "3" },
        { "type": "zone", "id": "4" }
    ]
}

Page tree