রেফারেন্স · প্লেলিস্ট

একটি প্লেলিস্ট দেখুন

GET /v1/playlists/{uid}

uid অনুযায়ী একটি প্লেলিস্ট দেখায়, সঙ্গে প্রদর্শনের ক্রমে এর আইটেম এবং যেসব টিভি এই প্লেলিস্ট ব্যবহার করে।

পাথ প্যারামিটার

নাম	ধরন	বিবরণ
`uid`	`string`	প্লেলিস্টের uid।

রেসপন্সের ফিল্ড

uid string: প্লেলিস্টের শনাক্তকারী।
name string: প্লেলিস্টের নাম।
organization object: প্লেলিস্টের প্রতিষ্ঠান: uid ও name।
total_time integer: প্লেলিস্টের মোট সময়, সেকেন্ডে।
total_time_is_approximate boolean: মোট সময়টি আনুমানিক হলে true।
items array: প্লেলিস্টের আইটেম, প্রদর্শনের ক্রমে।
items[].position integer: প্লেলিস্টে আইটেমের অবস্থান।
items[].type string: ফাইলের জন্য file অথবা বিনোদন কনটেন্টের জন্য entertainment। অন্য ধরনও আসতে পারে।
items[].uid string: ফাইল বা বিনোদন কনটেন্টের শনাক্তকারী।
items[].display_time integer | null: আইটেমে নির্ধারিত প্রদর্শনের সময়, সেকেন্ডে, অথবা নির্ধারিত না থাকলে null।
items[].file object | null: ফাইলের তথ্য, “ফাইলের তালিকা”-র মতো একই ফিল্ডসহ, অথবা আইটেমটি ফাইল না হলে বা ব্যবহারকারী এর প্রতিষ্ঠানের ফাইল দেখতে না পারলে null।
tvs array: যেসব টিভি এই প্লেলিস্ট ব্যবহার করে (uid, name ও organization)। শুধু সেই টিভিগুলো দেখানো হয়, যা ব্যবহারকারী দেখতে পারেন।

সম্ভাব্য ত্রুটি

404 not_found এন্ডপয়েন্টটির অস্তিত্ব নেই, অথবা আইটেমটির অস্তিত্ব নেই বা এটি এমন প্রতিষ্ঠানের, যা ব্যবহারকারী দেখতে পারেন না।
কী ও সীমা-সংক্রান্ত ত্রুটিগুলো সব এন্ডপয়েন্টে প্রযোজ্য। সব ত্রুটি দেখুন

অনুরোধ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();

রেসপন্স200

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

অস্তিত্বহীন বা অ্যাক্সেস নেই এমন আইটেম404

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