Referencia · Účet

Organizácie

Vypíše organizácie, ku ktorým má používateľ prístup, a pri každej z nich, čo môže cez API načítať. Táto odpoveď nie je stránkovaná.

Parametre

Tento endpoint nemá žiadne parametre.

Polia každej položky

uid string

Identifikátor organizácie. Použite ho v parametri organization pri zoznamoch.

name string

Názov organizácie.

neutral_zone boolean

true, ak je organizácia neutrálnou zónou, takže jej súbory a playlisty môžu používať všetky ostatné organizácie.

admin boolean

true, ak je používateľ administrátorom organizácie alebo hlavnej organizácie. V takom prípade vidí v organizácii všetko.

permissions object

Čo môže používateľ v tejto organizácii načítať.

permissions.tvs boolean

true, ak môže vidieť TV.

permissions.files boolean

true, ak môže vidieť súbory.

permissions.playlists boolean

true, ak môže vidieť playlisty.

Možné chyby

• Chyby kľúča a limitu platia pre všetky endpointy. Zobraziť všetky chyby

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
      }
    }
  ]
}