Page tree

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

Skip to end of metadata
Go to start of metadata

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

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

Добавляет в текущий список привязанных ТС новые.

Запрос:

URL:

POST https://api.url/v2.1/user/<user_id>/zones/<zone_id>/relationships/Cars

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

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

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

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

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

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


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

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

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

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

Ответ:

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

Пример

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

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

{
   "data": [
        { "type": "car", "id": "3" },
        { "type": "car", "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/Cars"
    },
    "meta":{
        "total_count": 4
    },
    "data": [
        { "type": "car", "id": "1" },
        { "type": "car", "id": "2" },
        { "type": "car", "id": "3" },
        { "type": "car", "id": "4" }
    ]
}


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

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

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

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




  • No labels