Referenz · Konto

Organisationen

Listet die Organisationen auf, auf die der Benutzer Zugriff hat, und für jede davon, was er über die API abrufen kann. Diese Antwort ist nicht paginiert.

Parameter

Dieser Endpunkt hat keine Parameter.

Felder jedes Elements

uid string

Kennung der Organisation. Verwenden Sie sie im Parameter organization der Listen.

name string

Name der Organisation.

neutral_zone boolean

true, wenn es sich um eine Organisation der neutralen Zone handelt, deren Dateien und Playlists von allen anderen Organisationen verwendet werden können.

admin boolean

true, wenn der Benutzer Administrator der Organisation oder der Hauptorganisation ist. In diesem Fall sieht er alles in der Organisation.

permissions object

Was der Benutzer in dieser Organisation abrufen kann.

permissions.tvs boolean

true, wenn er die TVs sehen kann.

permissions.files boolean

true, wenn er die Dateien sehen kann.

permissions.playlists boolean

true, wenn er die Playlists sehen kann.

Mögliche Fehler

• Fehler zum Schlüssel und zum Anfragelimit gelten für alle Endpunkte. Alle Fehler ansehen

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