v2.1 Удаление Групп из списка привязанных к Геозоне

Метод удаления привязки Групп к геозоне

Запрос:

URL:

DELETE https://api.url/v2.1/user/<user_id>/zones/<zone_id>/relationships/Groups

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

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

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

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

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

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

Поле

Описание

data

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

Каждый объект водитель содержит

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

Ответ:

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

Поле

Описание

links

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

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

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

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

204 No Content - Сервер обработал запрос, список не изменялся, все Группы, которые были в запросе, уже удалены от геозоны.

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

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

404 Not Found - зона не найдена.

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

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

Пример

Запрос на добавление зон 3 и 4, зоны привязаны:

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

{
   "data": [
        { "type": "group", "id": "3" },
        { "type": "group", "id": "4" }
   ]
}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
					
{
    "links": {
        "self": "https://api.url/v2.1/user/1/zones/1/relationships/Groups"
    },
    "meta":{
        "total_count": 2
    },
    "data": [
        { "type": "group", "id": "1" },
        { "type": "group", "id": "2" }
    ]
}

Запрос на добавление зон 3 и 4, зоны не привязаны:

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

{
   "data": [
        { "type": "group", "id": "3" },
        { "type": "group", "id": "4" }
   ]
}

HTTP/1.1 204 No Content
Content-Type: application/vnd.api+json

Page tree