Reference · Playlisty

Seznam playlistů

GET /v1/playlists

Vypíše v abecedním pořadí playlisty z organizací, ve kterých uživatel může vidět playlisty.

Stránkovaná odpověď: položky přicházejí v data a informace o stránce v meta. Stránkování a filtry

Parametry

Název	Typ	Popis
`organization`	`string`	uid organizace, pokud chcete jen její položky (viz `/organizations`).
`q`	`string`	Část názvu, nejvýše 100 znaků.
`page`	`integer`	Stránka, počínaje 1. Výchozí hodnota: 1.
`per_page`	`integer`	Počet položek na stránku, od 1 do 100. Výchozí hodnota: 50.

Pole každé položky

uid string: Identifikátor playlistu.
name string: Název playlistu.
organization object: Organizace playlistu: uid a name.
total_time integer: Celková délka playlistu v sekundách.
total_time_is_approximate boolean: true, pokud je celková délka jen odhad.

Možné chyby

400 invalid_parameter Parametr má neplatnou hodnotu, například per_page nad povoleným maximem.
404 organization_not_found Zadaný parametr organization neodpovídá organizaci, ve které uživatel může vidět tento typ položek.
Chyby klíče a limitu platí pro všechny endpointy. Zobrazit všechny chyby

PožadavekcURLPHPJavaScript

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

Odpověď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
  }
}