Referentie · Playlists

Een playlist opvragen

GET /v1/playlists/{uid}

Geeft een playlist op basis van de uid, met de items in afspeelvolgorde en de TV's die de playlist gebruiken.

Padparameter

Naam	Type	Beschrijving
`uid`	`string`	uid van de playlist.

Velden van het antwoord

uid string: ID van de playlist.
name string: Naam van de playlist.
organization object: Organisatie van de playlist: uid en name.
total_time integer: Totale duur van de playlist, in seconden.
total_time_is_approximate boolean: true als de totale duur een schatting is.
items array: Items van de playlist, in afspeelvolgorde.
items[].position integer: Positie van het item in de playlist.
items[].type string: file voor een bestand of entertainment voor entertainmentcontent. Er kunnen ook andere typen voorkomen.
items[].uid string: ID van het bestand of de entertainmentcontent.
items[].display_time integer | null: Weergavetijd die voor het item is ingesteld, in seconden, of null als er geen is ingesteld.
items[].file object | null: Gegevens van het bestand, met dezelfde velden als bij “Bestanden opvragen”, of null als het item geen bestand is of de gebruiker de bestanden van de organisatie ervan niet kan zien.
tvs array: TV's die de playlist gebruiken (uid, name en organization). Alleen TV's die de gebruiker kan zien, worden getoond.

Mogelijke fouten

404 not_found Het endpoint bestaat niet, of het item bestaat niet of hoort bij een organisatie die de gebruiker niet kan zien.
Fouten rond de sleutel en de verzoeklimiet gelden voor alle endpoints. Alle fouten bekijken

VerzoekcURLPHPJavaScript

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

Antwoord200

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

Item bestaat niet of geen toegang404

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