חומר עזר · חשבון

ארגונים

מציג את הארגונים שלמשתמש יש גישה אליהם, ולכל אחד מהם מה הוא יכול לקרוא דרך ה-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
      }
    }
  ]
}