# Timecodes

Методы: [info](#info) | [upload](#upload) | [enable](#enable) | [download](#download)

## info

*Информация о таймкодах*

#### Входные параметры:

* *String* **apikey** (API ключ вашего проекта)
* *String* **code** (Код вашего медиафайла)

#### Выходные параметры

* *Array* **timecodes** (Список таймкодов)
* *String* **enabled** (Статус таймкодов: "yes" или "no")

Пример запроса:

```text
https://boomstream.com/api/timecodes/info?apikey=[API_KEY]&code=[MEDIA_CODE]&format=json
```

Пример ответа:

```json
{
    "timecodes": [
        {
            "position": 1,
            "title": "first",
            "time_from": "00:00:00.000",
            "time_to": "00:00:05.000"
        },
        {
            "position": 2,
            "title": "second",
            "time_from": "00:00:05.000",
            "time_to": "00:00:20.000"
        },
        {
            "position": 3,
            "title": "third",
            "time_from": "00:00:20.000",
            "time_to": "00:00:30.000"
        },
        {
            "position": 4,
            "title": "fourth",
            "time_from": "00:00:30.000",
            "time_to": "00:00:45.000"
        }
    ],
    "enabled": "yes",
    "Status": "Success",
    "Version": "1.0"
}
```

## upload

*Загрузка таймкодов методом POST*

> **Примечание:** Это POST-запрос. Для его использования необходимо загрузить файл с таймкодами.

Пример запроса:

```text
https://boomstream.com/api/timecodes/upload
```

## enable

*Включение или отключение таймкодов*

#### Входные параметры:

Обязательные параметры:

* *String* **apikey** (API ключ вашего проекта)
* *String* **code** (Код вашего медиафайла)
* *Boolean* **enable** (Включить/отключить таймкоды, значения: 1 или 0)

#### Выходные параметры

* *String* **Message** (Сообщение о статусе)
* *String* **enable** (Статус таймкодов: "yes" или "no")

Пример запроса:

```text
https://boomstream.com/api/timecodes/enable?apikey=[API_KEY]&code=[MEDIA_CODE]&format=json&enable=1
```

Пример ответа:

```json
{
    "Message": "Changes have been successfully saved",
    "enable": "yes",
    "Status": "Success",
    "Version": "1.0"
}
```

## download

*Скачивание таймкодов*

#### Входные параметры:

* *String* **apikey** (API ключ вашего проекта)
* *String* **code** (Код вашего медиафайла)

Пример запроса:

```text
https://boomstream.com/api/timecodes/download?apikey=[API_KEY]&code=[MEDIA_CODE]
```