Анықтамалық · Аккаунт

Ұйымдар

GET /v1/organizations

Пайдаланушының қолжетімділігі бар ұйымдарды және әрқайсысында 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();
Жауап200
{
  "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
      }
    }
  ]
}