Referenz · Playlists

Eine Playlist abrufen

GET /v1/playlists/{uid}

Liefert eine Playlist anhand ihrer uid, mit den Elementen in Wiedergabereihenfolge und den TVs, die sie verwenden.

Pfadparameter

Name	Typ	Beschreibung
`uid`	`string`	uid der Playlist.

Antwortfelder

uid string: Kennung der Playlist.
name string: Name der Playlist.
organization object: Organisation der Playlist: uid und name.
total_time integer: Gesamtdauer der Playlist in Sekunden.
total_time_is_approximate boolean: true, wenn die Gesamtdauer ein Schätzwert ist.
items array: Elemente der Playlist in Wiedergabereihenfolge.
items[].position integer: Position des Elements in der Playlist.
items[].type string: file für eine Datei oder entertainment für Unterhaltungsinhalte. Weitere Typen sind möglich.
items[].uid string: Kennung der Datei oder des Unterhaltungsinhalts.
items[].display_time integer | null: Am Element festgelegte Anzeigedauer in Sekunden oder null, wenn keine festgelegt ist.
items[].file object | null: Daten der Datei mit denselben Feldern wie unter „Dateien auflisten“ oder null, wenn das Element keine Datei ist oder der Benutzer die Dateien ihrer Organisation nicht sehen kann.
tvs array: TVs, die die Playlist verwenden (uid, name und organization). Es werden nur TVs aufgeführt, die der Benutzer sehen kann.

Mögliche Fehler

404 not_found Der Endpunkt existiert nicht, oder das Element existiert nicht bzw. gehört zu einer Organisation, die der Benutzer nicht sehen kann.
Fehler zum Schlüssel und zum Anfragelimit gelten für alle Endpunkte. Alle Fehler ansehen

AnfragecURLPHPJavaScript

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

Antwort200

{
  "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 existiert nicht oder kein Zugriff404

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