Page tree

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

Skip to end of metadata
Go to start of metadata

Получение привязанных к ТС геозон.

Запрос:

URL:

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

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

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

If-Modified-Since - Если ранее уже запрашивался полный привязанных геозон, то при обновлении следует указывать заголовок If-Modified-Since с датой полученной заголовка ответа Last-Modified

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

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

Доп. Параметры запроса:

ИмяТипЗначение по умолчаниюМаксимальное значениеОписание
page[offset]int0
Пропустить несколько первых записей
page[limit]int100010000Количество объектов в выводе


Ответ:

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

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

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

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

Если объекты не удалось поместить в одном ответе то также будет содержаться

next - следующая страница (если есть)

prev - предыдущая страница (если есть)

first - первая страница с результатами

last - последняя страница с результатами


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

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

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

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

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

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

304 Not Modified - Сервер обработал запрос. Изменения не найдены.

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

403 Forbidden - нет прав на просмотр.

404 Not Found - ТС не найдена.

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

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

Пример

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

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

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": 450
    },
    "data": [
        { "type": "zone", "id": "1" },
        { "type": "zone", "id": "2" },
        { "type": "zone", "id": "3" },
        { "type": "zone", "id": "4" },
        { "type": "zone", "id": "15" },
         ... остальные привязанные зоны ...
    ]
}




  • No labels