v2.1 Удаление привязки водителя к группам

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

Запрос:

URL:

DELETE https://api.url/v2.1/user/<user_id>/drivers/<driver_id>/relationships/Groups

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

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

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

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

Поле

Описание

data

Содержит список ссылок в формате JSON API

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

Поле	Тип	Описание
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 ttps://api.url/v2.1/user/1/drivers/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": "http://api.url/v2.1/user/1/drivers/1/relationships/Groups"
    },
    "meta":{
        "total_count": 2
    },
    "data": [
        { "type": "group", "id": "1" },
        { "type": "group", "id": "2" }
    ]
}

Повторный запрос на удаление водителя из групп 3 и 4, водитель отсутствует в группах:

DELETE ttps://api.url/v2.1/user/1/drivers/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