Справочник · Плейлисты

Список плейлистов

GET /v1/playlists

Возвращает в алфавитном порядке плейлисты организаций, в которых пользователь может видеть плейлисты.

Ответ с пагинацией: объекты возвращаются в data, а сведения о странице — в meta. Пагинация и фильтры

Параметры

Имя	Тип	Описание
`organization`	`string`	uid организации, чтобы получить только её объекты (см. `/organizations`).
`q`	`string`	Часть названия, до 100 символов.
`page`	`integer`	Номер страницы, начиная с 1. По умолчанию: 1.
`per_page`	`integer`	Объектов на странице, от 1 до 100. По умолчанию: 50.

Поля каждого объекта

uid string: Идентификатор плейлиста.
name string: Название плейлиста.
organization object: Организация плейлиста: uid и name.
total_time integer: Общая длительность плейлиста в секундах.
total_time_is_approximate boolean: true, если общая длительность рассчитана приблизительно.

Возможные ошибки

400 invalid_parameter У параметра недопустимое значение, например per_page больше максимума.
404 organization_not_found Указанный organization не относится к организации, в которой пользователь может видеть объекты этого типа.
Ошибки ключа и лимита запросов относятся ко всем эндпоинтам. Все ошибки

ЗапросcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/playlists?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/playlists?per_page=2');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/playlists?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

Ответ200

{
  "data": [
    {
      "uid": "1f0e3dad99908345f7439f8ffabdffc4",
      "name": "Lista do caixa",
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      },
      "total_time": 40,
      "total_time_is_approximate": false
    },
    {
      "uid": "e4da3b7fbbce2345d7772b0674a318d5",
      "name": "Lista principal",
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      },
      "total_time": 85,
      "total_time_is_approximate": true
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 2,
    "total_pages": 1
  }
}