Page tree

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

Skip to end of metadata
Go to start of metadata

Запрос

URL:

GET http://api.url/api/v2.1/user/<user_id>/cars/<car_id>/videoTasks/<task_id>/files

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

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

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

Данные ответа:

Данные присылаются в формате JSON API. Формат данных аналогичен формату данных в ответе на запрос получения данных пользователя, за исключением, что не должно указываться Id.

Ответ присылается в формате JSON API. В заголовке Location будет содержаться ссылка на задачу. В теле ответа будет полное описание созданной задачи

Ответ:

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

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

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

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

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

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

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

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

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

metaСодержит total_count - количество фрагментов
data

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

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

ПолеТипОписание
idstringИдентификатор фрагмента
typestringТип ресурса (всегда "VideoFile")

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

        200 -Всё ок, в теле ответа, содержится список файлов.

404 - ТС либо канал не найден,

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


GET https://api.citypoint.ru/api/v2.1/user/1/cars/1/videoTasks/502/files HTTP/1.1
Accept: application/json
   
HTTP/1.1 200 OK
 
{
    "links": {
        "self": "https://api.citypoint.ru/api/v2.1/user/1/cars/1/videoTasks/502/files"
    },
    "data": [
         {
             "id": "QzpcVmlkZW9cWDFcMjAyMC0wNi0yM1xyZWNvcmRcMTY=@X1-200623-144042-145647-01p401000000.mp4",
             "type": "VideoFile"
         },
         {
             "id": "QzpcVmlkZW9cWDFcMjAyMC0wNi0yM1xyZWNvcmRcMTY=@X1-200623-145647-175647-01p401000000.mp4",
             "type": "VideoFile"
         }
    ]
    "meta": { "total_count": 2 }
}
  • No labels