Referință · Playlisturi

Detaliile unui playlist

GET /v1/playlists/{uid}

Returnează un playlist după uid, cu elementele în ordinea de redare și TV-urile care îl folosesc.

Parametru în cale

Nume	Tip	Descriere
`uid`	`string`	uid-ul playlistului.

Câmpurile răspunsului

uid string: Identificatorul playlistului.
name string: Numele playlistului.
organization object: Organizația playlistului: uid și name.
total_time integer: Durata totală a playlistului, în secunde.
total_time_is_approximate boolean: true dacă durata totală este o estimare.
items array: Elementele playlistului, în ordinea de redare.
items[].position integer: Poziția elementului în playlist.
items[].type string: file pentru fișier sau entertainment pentru conținut de divertisment. Pot apărea și alte tipuri.
items[].uid string: Identificatorul fișierului sau al conținutului de divertisment.
items[].display_time integer | null: Timpul de afișare setat pentru element, în secunde, sau null dacă nu este setat.
items[].file object | null: Datele fișierului, cu aceleași câmpuri ca în „Listarea fișierelor”, sau null dacă elementul nu este un fișier ori dacă utilizatorul nu poate vedea fișierele organizației din care face parte.
tvs array: TV-urile care folosesc playlistul (uid, name și organization). Apar doar TV-urile pe care utilizatorul le poate vedea.

Erori posibile

404 not_found Endpointul nu există sau elementul nu există ori aparține unei organizații pe care utilizatorul nu o poate vedea.
Erorile de cheie și de limită se aplică tuturor endpointurilor. Vedeți toate erorile

CererecURLPHPJavaScript

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

Răspuns200

{
  "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 inexistent sau fără acces404

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