Referenca · Seznami predvajanja

Podrobnosti seznama predvajanja

GET /v1/playlists/{uid}

Vrne seznam predvajanja glede na uid, skupaj z elementi v vrstnem redu predvajanja in televizorji, ki ga uporabljajo.

Parameter poti

Ime	Vrsta	Opis
`uid`	`string`	uid seznama predvajanja.

Polja odgovora

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.
items array: Elementi seznama v vrstnem redu predvajanja.
items[].position integer: Položaj elementa na seznamu.
items[].type string: file za datoteko ali entertainment za zabavno vsebino. Pojavijo se lahko tudi druge vrste.
items[].uid string: Identifikator datoteke ali zabavne vsebine.
items[].display_time integer | null: Čas prikaza, nastavljen za element, v sekundah ali null, če ni nastavljen.
items[].file object | null: Podatki o datoteki z enakimi polji kot v razdelku »Pregled datotek« ali null, če element ni datoteka ali če uporabnik ne more videti datotek njegove organizacije.
tvs array: Televizorji, ki uporabljajo seznam (uid, name in organization). Prikazani so samo televizorji, ki jih uporabnik lahko vidi.

Možne napake

404 not_found Končna točka ne obstaja ali pa element ne obstaja oziroma pripada organizaciji, ki je uporabnik ne more videti.
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/e4da3b7fbbce2345d7772b0674a318d5" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/playlists/e4da3b7fbbce2345d7772b0674a318d5');
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/e4da3b7fbbce2345d7772b0674a318d5', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

Odgovor200

{
  "data": {
    "uid": "e4da3b7fbbce2345d7772b0674a318d5",
    "name": "Lista principal",
    "organization": {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro"
    },
    "total_time": 85,
    "total_time_is_approximate": true,
    "items": [
      {
        "position": 1,
        "type": "file",
        "uid": "a87ff679a2f3e71d9181a67b7542122c",
        "display_time": null,
        "file": {
          "uid": "a87ff679a2f3e71d9181a67b7542122c",
          "name": "Promoção de verão",
          "type": "video",
          "duration": 30,
          "archived": false,
          "organization": {
            "uid": "8f14e45fceea167a5a36dedd4bea2543",
            "name": "Loja Centro"
          }
        }
      },
      {
        "position": 2,
        "type": "entertainment",
        "uid": "noticias",
        "display_time": 15,
        "file": null
      },
      {
        "position": 3,
        "type": "file",
        "uid": "6512bd43d9caa6e02c990b0a82652dca",
        "display_time": 10,
        "file": {
          "uid": "6512bd43d9caa6e02c990b0a82652dca",
          "name": "Cardápio do dia",
          "type": "image",
          "duration": 10,
          "archived": false,
          "organization": {
            "uid": "8f14e45fceea167a5a36dedd4bea2543",
            "name": "Loja Centro"
          }
        }
      }
    ],
    "tvs": [
      {
        "uid": "c98cb8f9cc62887d1f6cf5693df9219c",
        "name": "Recepção",
        "organization": {
          "uid": "8f14e45fceea167a5a36dedd4bea2543",
          "name": "Loja Centro"
        }
      },
      {
        "uid": "45c48cce2e2d7fbdea1afc51c7c6ad26",
        "name": "Vitrine",
        "organization": {
          "uid": "8f14e45fceea167a5a36dedd4bea2543",
          "name": "Loja Centro"
        }
      }
    ]
  }
}

Element ne obstaja ali ni dostopa404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}