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

Списък с плейлисти

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
  }
}