v2.1 Каналы Видео

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

Запрос:

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]	int	0	Пропустить несколько первых записей
page[limit]	int	200	Количество объектов в выводе
fields[VideoChannel]	string		Фильтрация полей отображаемых в объектов.
filter	string		Фильтрация результатов (см раздел "Фильтрация результатов")
sort	string		Сортировка результатов.
include	string		Добавить в ответ связанные объекты

Ответ:

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

Поле

Описание

links

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

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

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

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

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

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

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

Аттрибуты:

Поле	Тип	Nullable	Описание
Name	string	нет	Название канала
Number	int	нет	номер канала

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

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

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

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"
                    }
                }
            }
        }
    ]
}

Page tree