Referenco · Ludlistoj

Vidi ludliston

GET /v1/playlists/{uid}

Montras ludliston laŭ ĝia uid, kun la eroj laŭ la montra ordo kaj la televidiloj, kiuj uzas la ludliston.

Parametro en la vojo

Nomo	Tipo	Priskribo
`uid`	`string`	uid de la ludlisto.

Kampoj de la respondo

uid string: Identigilo de la ludlisto.
name string: Nomo de la ludlisto.
organization object: Organizaĵo de la ludlisto: uid kaj name.
total_time integer: Tuta daŭro de la ludlisto, en sekundoj.
total_time_is_approximate boolean: true se la tuta daŭro estas takso.
items array: Eroj de la ludlisto, laŭ la montra ordo.
items[].position integer: Pozicio de la ero en la ludlisto.
items[].type string: file por dosiero aŭ entertainment por distra enhavo. Aliaj tipoj povas aperi.
items[].uid string: Identigilo de la dosiero aŭ de la distra enhavo.
items[].display_time integer | null: Montra tempo difinita en la ero, en sekundoj, aŭ null se ĝi ne estas difinita.
items[].file object | null: Datumoj de la dosiero, kun la samaj kampoj kiel en „Listigi dosierojn“, aŭ null se la ero ne estas dosiero aŭ se la uzanto ne povas vidi la dosierojn de ĝia organizaĵo.
tvs array: Televidiloj, kiuj uzas la ludliston (uid, name kaj organization). Aperas nur la televidiloj, kiujn la uzanto povas vidi.

Eblaj eraroj

404 not_found La finpunkto ne ekzistas, aŭ la ero ne ekzistas aŭ apartenas al organizaĵo, kiun la uzanto ne povas vidi.
La eraroj pri ŝlosilo kaj limo validas por ĉiuj finpunktoj. Vidi ĉiujn erarojn

PetocURLPHPJavaScript

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

Respondo200

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

Neekzistanta ero aŭ sen aliro404

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