Reference · Playlister

Hent én playliste

GET /v1/playlists/{uid}

Viser en playliste ud fra dens uid med elementerne i afspilningsrækkefølge og de TV'er, der bruger playlisten.

Stiparameter

Navn	Type	Beskrivelse
`uid`	`string`	uid for playlisten.

Felter i svaret

uid string: Playlistens id.
name string: Playlistens navn.
organization object: Playlistens organisation: uid og name.
total_time integer: Playlistens samlede tid i sekunder.
total_time_is_approximate boolean: true, hvis den samlede tid er et skøn.
items array: Playlistens elementer i afspilningsrækkefølge.
items[].position integer: Elementets placering i playlisten.
items[].type string: file for en fil eller entertainment for underholdningsindhold. Andre typer kan forekomme.
items[].uid string: Id for filen eller underholdningsindholdet.
items[].display_time integer | null: Visningstid angivet for elementet i sekunder eller null, hvis der ikke er angivet nogen.
items[].file object | null: Filens data med de samme felter som i »Hent filer« eller null, hvis elementet ikke er en fil, eller hvis brugeren ikke kan se filerne i filens organisation.
tvs array: TV'er, der bruger playlisten (uid, name og organization). Kun TV'er, som brugeren kan se, vises.

Mulige fejl

404 not_found Endpointet findes ikke, eller elementet findes ikke eller tilhører en organisation, som brugeren ikke kan se.
Fejl vedrørende nøgle og grænser gælder for alle endpoints. Se alle fejl

ForespørgselcURLPHPJavaScript

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

Svar200

{
  "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, der ikke findes eller ikke er adgang til404

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