Riferimento · Account

Organizzazioni

GET /v1/organizations

Elenca le organizzazioni a cui l'utente ha accesso e, per ciascuna, cosa può consultare tramite l'API. Questa risposta non è paginata.

Parametri

Questo endpoint non accetta parametri.

Campi di ogni elemento

uid string
Identificativo dell'organizzazione. Usalo nel parametro organization degli elenchi.
name string
Nome dell'organizzazione.
neutral_zone boolean
true se è un'organizzazione a zona neutra, i cui file e playlist possono essere usati da tutte le altre organizzazioni.
admin boolean
true se l'utente è amministratore dell'organizzazione o dell'organizzazione principale. In questo caso, vede tutto dell'organizzazione.
permissions object
Cosa può consultare l'utente in questa organizzazione.
permissions.tvs boolean
true se può vedere le TV.
permissions.files boolean
true se può vedere i file.
permissions.playlists boolean
true se può vedere le playlist.

Errori possibili

Richiesta
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();
Risposta200
{
  "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
      }
    }
  ]
}