Reference · Konto

Organisationer

GET /v1/organizations

Viser de organisationer, brugeren har adgang til, og for hver af dem, hvad brugeren kan hente via API'et. Svaret er ikke opdelt i sider.

Parametre

Dette endpoint har ingen parametre.

Felter for hvert element

uid string
Organisationens id. Brug det i parameteren organization i listerne.
name string
Organisationens navn.
neutral_zone boolean
true, hvis det er en organisation i den neutrale zone, hvis filer og playlister kan bruges af alle andre organisationer.
admin boolean
true, hvis brugeren er administrator af organisationen eller af hovedorganisationen. I så fald ser brugeren alt i organisationen.
permissions object
Hvad brugeren kan hente i denne organisation.
permissions.tvs boolean
true, hvis brugeren kan se TV'erne.
permissions.files boolean
true, hvis brugeren kan se filerne.
permissions.playlists boolean
true, hvis brugeren kan se playlisterne.

Mulige fejl

  • Fejl vedrørende nøgle og grænser gælder for alle endpoints. Se alle fejl
Forespørgsel
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();
Svar200
{
  "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
      }
    }
  ]
}