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

प्लेलिस्ट की सूची

GET /v1/playlists

उन संगठनों की प्लेलिस्ट की सूची वर्णानुक्रम में देता है जिनमें उपयोगकर्ता प्लेलिस्ट देख सकता है।

पेजों में बँटा रिस्पॉन्स: आइटम data में आते हैं और पेज की जानकारी meta में। पेजिनेशन और फ़िल्टर

पैरामीटर

नाम	प्रकार	विवरण
`organization`	`string`	किसी संगठन का uid, ताकि केवल उसी के आइटम आएँ (देखें `/organizations`)।
`q`	`string`	नाम का कोई हिस्सा, अधिकतम 100 कैरेक्टर।
`page`	`integer`	पेज, 1 से शुरू। डिफ़ॉल्ट: 1।
`per_page`	`integer`	प्रति पेज आइटम, 1 से 100 तक। डिफ़ॉल्ट: 50।

हर आइटम के फ़ील्ड

uid string: प्लेलिस्ट का पहचानकर्ता।
name string: प्लेलिस्ट का नाम।
organization object: प्लेलिस्ट का संगठन: uid और name।
total_time integer: प्लेलिस्ट का कुल समय, सेकंड में।
total_time_is_approximate boolean: अगर कुल समय एक अनुमान है, तो true।

संभावित त्रुटियाँ

400 invalid_parameter किसी पैरामीटर का मान अमान्य है, जैसे per_page अधिकतम सीमा से ज़्यादा।
404 organization_not_found दिया गया organization ऐसा संगठन नहीं है जिसमें उपयोगकर्ता इस प्रकार के आइटम देख सकता हो।
कुंजी और सीमा से जुड़ी त्रुटियाँ सभी एंडपॉइंट पर लागू होती हैं। सभी त्रुटियाँ देखें

अनुरोधcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/playlists?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/playlists?per_page=2');
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?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

रिस्पॉन्स200

{
  "data": [
    {
      "uid": "1f0e3dad99908345f7439f8ffabdffc4",
      "name": "Lista do caixa",
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      },
      "total_time": 40,
      "total_time_is_approximate": false
    },
    {
      "uid": "e4da3b7fbbce2345d7772b0674a318d5",
      "name": "Lista principal",
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      },
      "total_time": 85,
      "total_time_is_approximate": true
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 2,
    "total_pages": 1
  }
}