Referans · Oynatma Listeleri

Bir oynatma listesini görüntüle

GET /v1/playlists/{uid}

Bir oynatma listesini uid değerine göre; öğeleri gösterim sırasıyla ve listeyi kullanan TV'lerle birlikte döndürür.

Yol parametresi

Ad	Tür	Açıklama
`uid`	`string`	Oynatma listesinin uid değeri.

Yanıt alanları

uid string: Oynatma listesi tanımlayıcısı.
name string: Listenin adı.
organization object: Listenin kuruluşu: uid ve name.
total_time integer: Listenin toplam süresi, saniye cinsinden.
total_time_is_approximate boolean: Toplam süre bir tahminse true.
items array: Listenin öğeleri, gösterim sırasıyla.
items[].position integer: Öğenin listedeki konumu.
items[].type string: Dosya için file, eğlence içeriği için entertainment. Başka türler de görünebilir.
items[].uid string: Dosyanın veya eğlence içeriğinin tanımlayıcısı.
items[].display_time integer | null: Öğe için ayarlanan gösterim süresi, saniye cinsinden, veya ayarlanmamışsa null.
items[].file object | null: “Dosyaları listele” ile aynı alanlara sahip dosya verileri veya öğe bir dosya değilse ya da kullanıcı öğenin kuruluşundaki dosyaları göremiyorsa null.
tvs array: Listeyi kullanan TV'ler (uid, name ve organization). Yalnızca kullanıcının görebildiği TV'ler gösterilir.

Olası hatalar

404 not_found Uç nokta mevcut değil ya da öğe mevcut değil veya kullanıcının göremediği bir kuruluşa ait.
Anahtar ve limit hataları tüm uç noktalar için geçerlidir. Tüm hataları görün

İstekcURLPHPJavaScript

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

Yanıt200

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

Mevcut olmayan veya erişim izni olmayan öğe404

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