Page tree

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

Skip to end of metadata
Go to start of metadata

Возвращает текущее состояние (онлайн / офлайн) видео регистраторов

URL:

Cтатусы всех vrd в учетке:

GET: http://api.url/api/v2.1/user/<user_id>/videoRecorders/statuses

Cтатус конкретного vrd:

http://api.url/api/v2.1/user/<user_id>/videoRecorders/statuses/<vrd_id>

Cтатус vrd по ТС:

http://api.url/api/v2.1/user/<user_id>/cars/<car_id>/videoRecorder/status

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

ПараметртипЗначение по умолчаниюОписание
page[offset]int0Пропустить несколько первых записей
page[limit]int100Количество групп в выводе
fields[VideoRecorderDeviceStatus]string

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

includestring
Включить в ответ связанные объекты

Параметры filter и sort не поддерживаются.

Ответ:

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

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

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

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

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

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

ПолеТипОписание
idint

Идентификатор (передаётся как строка для соответствия JSON API)

Всегда равен id видео регистратора

typestringТип ресурса (всегда "VideoRecorderDeviceStatus")
attributesobjectДанные объекта (см. Описание атрибутов)
relationshipsобъектСвязанные объекты

Атрибуты:

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

Устройство на связи

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

ПолеТипNullableОписание
VideoRecorderDeviceссылка на VideoRecorderDeviceнетссылка на видео регистратор
Carссылка на Carдассылка на ТС к которому привязан регистратор

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

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

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

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

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

404 Not Found - запрошенный регистратор не найден .

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

Пример:

Возвращает текущее состояние (онлайн / офлайн) видео регистраторов:

GET: http://api.url/api/v2.1/user/1/videoRecorders/statuses HTTP/1.1
Accept: application/vnd.api+json

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/videoRecorders/statuses"
    },
    "meta": {
        "total_count": 1
    },
    "data": [
        {
            "id": "1",
            "type": "VideoRecorderDeviceStatus",
            "attributes": {
                "IsOnline": false
            },
            "relationships": {
                "VideoRecorderDevice": {
                    "data": {
                        "id": "1",
                        "type": "VideoRecorderDevice"
                    }
                },
                "Car": {
                    "data": {
                        "id": "2",
                        "type": "car"
                    }
                }
            }
        }
    ]
}
  • No labels