Cyfeirnod · Rhestrau chwarae

Gweld rhestr chwarae

GET /v1/playlists/{uid}

Yn dangos rhestr chwarae yn ôl ei uid, gyda'i heitemau yn nhrefn chwarae a'r setiau teledu sy'n ei defnyddio.

Paramedr yn y llwybr

Enw	Math	Disgrifiad
`uid`	`string`	uid y rhestr chwarae.

Meysydd yr ymateb

uid string: Dynodydd y rhestr chwarae.
name string: Enw'r rhestr chwarae.
organization object: Sefydliad y rhestr chwarae: uid a name.
total_time integer: Cyfanswm amser y rhestr chwarae, mewn eiliadau.
total_time_is_approximate boolean: true os amcangyfrif yw'r cyfanswm amser.
items array: Eitemau'r rhestr chwarae, yn nhrefn chwarae.
items[].position integer: Safle'r eitem yn y rhestr chwarae.
items[].type string: file ar gyfer ffeil neu entertainment ar gyfer cynnwys adloniant. Gall mathau eraill ymddangos.
items[].uid string: Dynodydd y ffeil neu'r cynnwys adloniant.
items[].display_time integer | null: Yr amser arddangos a osodwyd ar yr eitem, mewn eiliadau, neu null os nad oes un wedi'i osod.
items[].file object | null: Manylion y ffeil, gyda'r un meysydd â “Rhestru ffeiliau”, neu null os nad yw'r eitem yn ffeil neu os na all y defnyddiwr weld ffeiliau ei sefydliad.
tvs array: Y setiau teledu sy'n defnyddio'r rhestr chwarae (uid, name a organization). Dim ond y setiau teledu y gall y defnyddiwr eu gweld sy'n cael eu dangos.

Gwallau posibl

404 not_found Dydy'r pwynt terfyn ddim yn bodoli, neu dydy'r eitem ddim yn bodoli neu mae'n perthyn i sefydliad na all y defnyddiwr ei weld.
Mae gwallau allwedd a therfyn ceisiadau yn berthnasol i bob pwynt terfyn. Gweld pob gwall

CaiscURLPHPJavaScript

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

Ymateb200

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

Eitem nad yw'n bodoli neu heb fynediad404

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