Page tree

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

Skip to end of metadata
Go to start of metadata

Возвращает список видео каналов на ТС.

Запрос:

URL:

Все каналы на ТС:

http://api.urlapi/v2.1/user/<user_id>/cars/<car_id>/videoChannels

              Отдельный канал на ТС:

http://api.url/api/v2.1/user/<user_id>/cars/<car_id>/videoChannels/<channel_id>

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

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

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

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

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

Фильтрация полей отображаемых в объектов.

filterstring
Фильтрация результатов (см раздел "Фильтрация результатов")
sortstring
Сортировка результатов.
includestring
Добавить в ответ связанные объекты


Ответ:

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

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

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

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

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

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

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

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

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

metaСодержит total_count - количество каналов на данной ТС (с учетом фильтра)
data

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

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

ПолеТипОписание
idintИдентификатор (передаётся как строка для соответствия jsonapi)
typestringТип ресурса (всегда "VideoChannel")
attributesobjectДанные объекта (см. Описание атрибутов)
relationshipsобъектСвязанные объекты.

Аттрибуты:

ПолеТипNullableОписание
Namestringнет

Название канала

Numberintнетномер канала

Связанные объекты:

ПолеТипNullableОписание
CarcarнетСсылка ТС

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

200 ОК - Сервер обработал запрос.

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

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

404 Not Found - тс или канал (при запросе одного канала по id) не найдены.

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

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

Пример:

Список всех зон

GET http://api.url/v2.1/user/1/cars/1/videoChannels 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/cars/1/videoChannels"
    },
    "meta": {
        "total_count": 2
    },
    "data": [
        {
            "id": "1",
            "type": "VideoChannel",
            "attributes": {
                "Name": "Front view",
                "Number": 1
            },
            "relationships": {
                "Car": {
                    "data": {
                        "id": "1",
                        "type": "car"
                    }
                }
            }
        },
        {
            "id": "3",
            "type": "VideoChannel",
            "attributes": {
                "Name": "Back view",
                "Number": 2
            },
            "relationships": {
                "Car": {
                    "data": {
                        "id": "1",
                        "type": "car"
                    }
                }
            }
        }
    ]
}
  • No labels