Referens · Spellistor

Hämta en spellista

GET /v1/playlists/{uid}

Visar en spellista utifrån dess uid, med objekten i uppspelningsordning och de TV-apparater som använder spellistan.

Sökvägsparameter

Namn	Typ	Beskrivning
`uid`	`string`	uid för spellistan.

Fält i svaret

uid string: Spellistans id.
name string: Spellistans namn.
organization object: Spellistans organisation: uid och name.
total_time integer: Spellistans totala tid i sekunder.
total_time_is_approximate boolean: true om den totala tiden är en uppskattning.
items array: Spellistans objekt, i uppspelningsordning.
items[].position integer: Objektets position i spellistan.
items[].type string: file för en fil eller entertainment för underhållningsinnehåll. Andra typer kan förekomma.
items[].uid string: Id för filen eller underhållningsinnehållet.
items[].display_time integer | null: Visningstid som angetts för objektet, i sekunder, eller null om ingen har angetts.
items[].file object | null: Filens data, med samma fält som i ”Lista filer”, eller null om objektet inte är en fil eller om användaren inte kan se filerna i filens organisation.
tvs array: TV-apparater som använder spellistan (uid, name och organization). Bara TV-apparater som användaren kan se visas.

Möjliga fel

404 not_found Endpointen finns inte, eller så finns objektet inte eller tillhör en organisation som användaren inte kan se.
Fel som rör nyckeln och anropsgränsen gäller för alla endpoints. Visa alla fel

AnropcURLPHPJavaScript

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

Objekt som inte finns eller saknad åtkomst404

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