संदर्भ · खाता

संगठन

उन संगठनों की सूची देता है जिन्हें उपयोगकर्ता एक्सेस कर सकता है, और हर संगठन में वह API से क्या देख सकता है। यह रिस्पॉन्स पेजों में बँटा नहीं होता।

पैरामीटर

यह एंडपॉइंट कोई पैरामीटर नहीं लेता।

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

uid string

संगठन का पहचानकर्ता। सूचियों के organization पैरामीटर में इसका उपयोग करें।

name string

संगठन का नाम।

neutral_zone boolean

अगर यह न्यूट्रल ज़ोन संगठन है, जिसकी फ़ाइलें और प्लेलिस्ट अन्य सभी संगठन इस्तेमाल कर सकते हैं, तो true।

admin boolean

अगर उपयोगकर्ता इस संगठन का या मुख्य संगठन का एडमिनिस्ट्रेटर है, तो true। इस स्थिति में वह संगठन का सब कुछ देखता है।

permissions object

उपयोगकर्ता इस संगठन में क्या देख सकता है।

permissions.tvs boolean

अगर वह टीवी देख सकता है, तो true।

permissions.files boolean

अगर वह फ़ाइलें देख सकता है, तो true।

permissions.playlists boolean

अगर वह प्लेलिस्ट देख सकता है, तो true।

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

• कुंजी और सीमा से जुड़ी त्रुटियाँ सभी एंडपॉइंट पर लागू होती हैं। सभी त्रुटियाँ देखें

curl "https://api.on-cloud.live/v1/organizations" \
  -H "X-API-Key: $API_KEY"

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

{
  "data": [
    {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    },
    {
      "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
      "name": "Loja Shopping Norte",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    }
  ]
}