संदर्भ · प्लेलिस्ट

एक प्लेलिस्ट देखें

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