Page tree

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

Skip to end of metadata
Go to start of metadata

Создаёт задачу на загрузку видео

URL:

POST http://api.url/api/v2.1/user/<user_id>/cars/<car_id>/videoTasks

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

Content-Type - формат запроса. Должно быть "application/vnd.api+json"

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

Данные запроса:

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

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

Структура объекта:

ПолеТипNullableОписание
idint (передаётся как строка)нетИдентификатор
typestringнетТип. всегда VideoTask
attributesобъектнетДанные этого канала
relationshipsобъектнетСвязанные объекты.

Атрибуты:

ПолеТипNullableОписание
NametextнетНазвание задачи
StartDatedatetimeнетВремя начала фрагмента для скачивания
EndDatedatetimeнетВремя окончания фрагмента для скачивания

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

ПолеТипNullableОписание
VideoChanelссылка на VideoChannelнетВидео канал.
Carссылка на CarнетТС

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

201 Created - Сервер добавил задачу в очередь для загрузки.

403 Forbidden - нет прав на создание задач.

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

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

Пример:

POST https://api.url/api/v2.1/user/1/cars/1/videoTasks HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer <auth token>
 
{
    "data": {
        "type": "VideoTask",
        "attributes": {
            "Name": "web",
            "StartDate": "2020-01-15T11:05:21Z",
            "EndDate": "2020-01-15T11:15:00Z"
        },
        "relationships": {
            "VideoChannel": {
                "data": {
                    "id": "7",
                    "type": "VideoChannel"
                }
            },
            "Car": {
                "data": {
                    "id": "1",
                    "type": "car"
                }
            }
        }
    }
}
 
 
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
Location: https://api.url/api/v2.1/user/1/dispatchers/2
     
{
    "links": {
        "self": "https://api.url/api/v2.1/user/1/cars/1/videoTasks/1"
    },
    "data": {
        "id": "42",
        "type": "VideoTask",
        "attributes": {
            "Name": "web",
            "StartDate": "2020-01-15T11:05:21Z",
            "EndDate": "2020-01-15T11:15:00Z",
            "Progress": 0,
            "Status": "waiting"
        },
        "relationships": {
            "VideoChannel": {
                "data": {
                    "id": "7",
                    "type": "VideoChannel"
                }
            },
            "Car": {
                "data": {
                    "id": "23265",
                    "type": "car"
                }
            }
        }
    }
}




  • No labels