Referenca · Račun

Organizacije

GET /v1/organizations

Prikazuje organizacije kojima korisnik ima pristup i, za svaku od njih, šta može čitati putem API-ja. Ovaj odgovor nije podijeljen na stranice.

Parametri

Ovaj endpoint nema parametre.

Polja svake stavke

uid string
Identifikator organizacije. Koristite ga u parametru organization u listama.
name string
Naziv organizacije.
neutral_zone boolean
true ako je ovo organizacija neutralne zone, čije datoteke i playliste mogu koristiti sve ostale organizacije.
admin boolean
true ako je korisnik administrator organizacije ili glavne organizacije. U tom slučaju vidi sve u organizaciji.
permissions object
Šta korisnik može čitati u ovoj organizaciji.
permissions.tvs boolean
true ako može vidjeti TV uređaje.
permissions.files boolean
true ako može vidjeti datoteke.
permissions.playlists boolean
true ako može vidjeti playliste.

Moguće greške

Zahtjev
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();
Odgovor200
{
  "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
      }
    }
  ]
}