Referenca · Seznami predvajanja

Pregled seznamov predvajanja

GET /v1/playlists

Vrne sezname predvajanja organizacij, v katerih lahko uporabnik vidi sezname predvajanja, po abecednem vrstnem redu.

Odgovor, razdeljen na strani: elementi so v data, podatki o strani pa v meta. Ostranjevanje in filtri

Parametri

Ime	Vrsta	Opis
`organization`	`string`	uid organizacije, če želite samo njene elemente (glejte `/organizations`).
`q`	`string`	Del imena, največ 100 znakov.
`page`	`integer`	Stran, od 1 naprej. Privzeto: 1.
`per_page`	`integer`	Število elementov na stran, od 1 do 100. Privzeto: 50.

Polja posameznega elementa

uid string: Identifikator seznama predvajanja.
name string: Ime seznama.
organization object: Organizacija seznama: uid in name.
total_time integer: Skupni čas seznama v sekundah.
total_time_is_approximate boolean: true, če je skupni čas ocena.

Možne napake

400 invalid_parameter Parameter ima neveljavno vrednost, na primer per_page nad največjo dovoljeno vrednostjo.
404 organization_not_found Podana vrednost organization ni organizacija, v kateri lahko uporabnik vidi to vrsto elementov.
Napake ključa in omejitve zahtev veljajo za vse končne točke. Prikaži vse napake

ZahtevacURLPHPJavaScript

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

Odgovor200

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