Page tree

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

Skip to end of metadata
Go to start of metadata

Метод заменяет список Групп привязанных к геозоне на новый.

Запрос:

URL:

PATCH 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

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

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

ПолеТипОписание
typestringтип ресурса (всегда "group")
idstringидентификатор ТС

Ответ:

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

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

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

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

metaСодержит total_count - количество связанных Групп у зоны
data

Содержит массив объектов ссылок на зоны в формате JSON API.

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

ПолеТипОписание
idintИдентификатор зоны (передаётся как строка для соответствия JSON API)
typestringТип ресурса (всегда "group")

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

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

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

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

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

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

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

Пример

PATCH 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": "3" },
        { "type": "group", "id": "4" }
    ]
}


  • No labels