Referencja · Konto

Organizacje

Zwraca listę organizacji, do których użytkownik ma dostęp, a dla każdej z nich informację, co może odczytywać przez API. Ta odpowiedź nie jest podzielona na strony.

Parametry

Ten endpoint nie przyjmuje parametrów.

Pola każdego elementu

uid string

Identyfikator organizacji. Używaj go w parametrze organization list.

name string

Nazwa organizacji.

neutral_zone boolean

true, jeśli organizacja jest strefą neutralną, czyli jej pliki i playlisty mogą być używane przez wszystkie inne organizacje.

admin boolean

true, jeśli użytkownik jest administratorem organizacji lub organizacji głównej. W takim przypadku widzi wszystko w organizacji.

permissions object

Co użytkownik może odczytywać w tej organizacji.

permissions.tvs boolean

true, jeśli może widzieć telewizory.

permissions.files boolean

true, jeśli może widzieć pliki.

permissions.playlists boolean

true, jeśli może widzieć playlisty.

Możliwe błędy

• Błędy klucza i limitu dotyczą wszystkich endpointów. Zobacz wszystkie błędy

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