Reference · Účet

Organizace

GET /v1/organizations

Vypíše organizace, ke kterým má uživatel přístup, a u každé z nich, co může přes API načítat. Tato odpověď není stránkovaná.

Parametry

Tento endpoint nemá žádné parametry.

Pole každé položky

uid string
Identifikátor organizace. Použijte ho v parametru organization u výpisů.
name string
Název organizace.
neutral_zone boolean
true, pokud je organizace neutrální zónou, takže její soubory a playlisty mohou používat všechny ostatní organizace.
admin boolean
true, pokud je uživatel administrátorem organizace nebo hlavní organizace. V takovém případě vidí v organizaci vše.
permissions object
Co může uživatel v této organizaci načítat.
permissions.tvs boolean
true, pokud může vidět TV.
permissions.files boolean
true, pokud může vidět soubory.
permissions.playlists boolean
true, pokud může vidět playlisty.

Možné chyby

Požadavek
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();
Odpověď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
      }
    }
  ]
}