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

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

Запрос:

URL:

Запрос списка привязанных ТС:

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

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

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

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

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

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

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

Ответ:

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

Поле

Описание

links

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

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

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

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

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

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

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

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

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/zones/1/relationships/Cars 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": "https://api.url/v2.1/user/1/zones/1/relationships/Cars"
    },
    "meta":{
        "total_count": 450
    },
    "data": [
        { "type": "car", "id": "1" },
        { "type": "car", "id": "2" },
        { "type": "car", "id": "3" },
        { "type": "car", "id": "4" },
        { "type": "car", "id": "15" },
         ... остальные привязанные тс ...
    ]
}

Page tree