Referentie · Account

Organisaties

Geeft de organisaties waartoe de gebruiker toegang heeft en per organisatie wat hij via de API kan opvragen. Dit antwoord is niet gepagineerd.

Parameters

Dit endpoint heeft geen parameters.

Velden van elk item

uid string

ID van de organisatie. Gebruik dit in de parameter organization van de lijsten.

name string

Naam van de organisatie.

neutral_zone boolean

true als het een organisatie in de neutrale zone is, waarvan de bestanden en playlists door alle andere organisaties kunnen worden gebruikt.

admin boolean

true als de gebruiker beheerder is van de organisatie of van de hoofdorganisatie. In dat geval ziet hij alles van de organisatie.

permissions object

Wat de gebruiker in deze organisatie kan opvragen.

permissions.tvs boolean

true als hij de TV's kan zien.

permissions.files boolean

true als hij de bestanden kan zien.

permissions.playlists boolean

true als hij de playlists kan zien.

Mogelijke fouten

• Fouten rond de sleutel en de verzoeklimiet gelden voor alle endpoints. Alle fouten bekijken

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