Referanse · Konto

Organisasjoner

Viser organisasjonene brukeren har tilgang til, og for hver av dem hva brukeren kan hente via API-et. Svaret er ikke delt inn i sider.

Parametere

Dette endepunktet tar ingen parametere.

Felter for hvert element

uid string

Organisasjonens ID. Bruk den i parameteren organization i listene.

name string

Organisasjonens navn.

neutral_zone boolean

true hvis det er en organisasjon i nøytral sone, der filene og spillelistene kan brukes av alle andre organisasjoner.

admin boolean

true hvis brukeren er administrator for organisasjonen eller for hovedorganisasjonen. Da ser brukeren alt i organisasjonen.

permissions object

Hva brukeren kan hente i denne organisasjonen.

permissions.tvs boolean

true hvis brukeren kan se TV-ene.

permissions.files boolean

true hvis brukeren kan se filene.

permissions.playlists boolean

true hvis brukeren kan se spillelistene.

Mulige feil

• Feil knyttet til nøkkel og grenser gjelder for alle endepunkter. Se alle feil

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