Referencia · Playlisty

Zoznam playlistov

GET /v1/playlists

Vypíše v abecednom poradí playlisty z organizácií, v ktorých môže používateľ vidieť playlisty.

Stránkovaná odpoveď: položky prichádzajú v data a informácie o stránke v meta. Stránkovanie a filtre

Parametre

Názov	Typ	Popis
`organization`	`string`	uid organizácie, ak chcete iba jej položky (pozri `/organizations`).
`q`	`string`	Časť názvu, najviac 100 znakov.
`page`	`integer`	Stránka, od 1. Predvolená hodnota: 1.
`per_page`	`integer`	Počet položiek na stránku, od 1 do 100. Predvolená hodnota: 50.

Polia každej položky

uid string: Identifikátor playlistu.
name string: Názov playlistu.
organization object: Organizácia playlistu: uid a name.
total_time integer: Celková dĺžka playlistu v sekundách.
total_time_is_approximate boolean: true, ak je celková dĺžka iba odhad.

Možné chyby

400 invalid_parameter Parameter má neplatnú hodnotu, napríklad per_page nad povoleným maximom.
404 organization_not_found Zadaný parameter organization nezodpovedá organizácii, v ktorej môže používateľ vidieť tento typ položiek.
Chyby kľúča a limitu platia pre všetky endpointy. Zobraziť všetky chyby

PožiadavkacURLPHPJavaScript

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();

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