Referenca · Račun

Organizacije

GET /v1/organizations

Vrne organizacije, do katerih ima uporabnik dostop, in za vsako od njih, kaj lahko bere prek API-ja. Ta odgovor ni razdeljen na strani.

Parametri

Ta končna točka nima parametrov.

Polja posameznega elementa

uid string
Identifikator organizacije. Uporabite ga v parametru organization pri seznamih.
name string
Ime organizacije.
neutral_zone boolean
true, če je organizacija nevtralno območje, kar pomeni, da lahko njene datoteke in sezname predvajanja uporabljajo vse druge organizacije.
admin boolean
true, če je uporabnik administrator organizacije ali glavne organizacije. V tem primeru vidi vse v organizaciji.
permissions object
Kaj lahko uporabnik bere v tej organizaciji.
permissions.tvs boolean
true, če lahko vidi televizorje.
permissions.files boolean
true, če lahko vidi datoteke.
permissions.playlists boolean
true, če lahko vidi sezname predvajanja.

Možne napake

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