Viiteopas · Soittolistat

Hae soittolista

GET /v1/playlists/{uid}

Palauttaa yhden soittolistan tunnisteen uid perusteella: kohteet toistojärjestyksessä ja TV:t, jotka käyttävät soittolistaa.

Polkuparametri

Nimi	Tyyppi	Kuvaus
`uid`	`string`	Soittolistan uid.

Vastauksen kentät

uid string: Soittolistan tunniste.
name string: Soittolistan nimi.
organization object: Soittolistan organisaatio: uid ja name.
total_time integer: Soittolistan kokonaiskesto sekunteina.
total_time_is_approximate boolean: true, jos kokonaiskesto on arvio.
items array: Soittolistan kohteet toistojärjestyksessä.
items[].position integer: Kohteen sijainti soittolistassa.
items[].type string: file tiedostolle tai entertainment viihdesisällölle. Myös muita tyyppejä voi esiintyä.
items[].uid string: Tiedoston tai viihdesisällön tunniste.
items[].display_time integer | null: Kohteelle määritetty näyttöaika sekunteina tai null, jos sitä ei ole määritetty.
items[].file object | null: Tiedoston tiedot samoine kenttineen kuin sivulla ”Listaa tiedostot” tai null, jos kohde ei ole tiedosto tai jos käyttäjä ei voi nähdä sen organisaation tiedostoja.
tvs array: TV:t, jotka käyttävät soittolistaa (uid, name ja organization). Mukana ovat vain TV:t, jotka käyttäjä voi nähdä.

Mahdolliset virheet

404 not_found Päätepistettä ei ole olemassa, tai kohdetta ei ole olemassa tai se kuuluu organisaatiolle, jota käyttäjä ei näe.
Avaimeen ja pyyntörajaan liittyvät virheet koskevat kaikkia päätepisteitä. Näytä kaikki virheet

PyyntöcURLPHPJavaScript

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

Vastaus200

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

Kohdetta ei ole tai siihen ei ole oikeutta404

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