Referință · Cont

Organizații

GET /v1/organizations

Listează organizațiile la care utilizatorul are acces și, pentru fiecare, ce poate consulta prin API. Acest răspuns nu este paginat.

Parametri

Acest endpoint nu primește parametri.

Câmpurile fiecărui element

uid string
Identificatorul organizației. Folosiți-l în parametrul organization al listelor.
name string
Numele organizației.
neutral_zone boolean
true dacă este o organizație din zona neutră, ale cărei fișiere și playlisturi pot fi folosite de toate celelalte organizații.
admin boolean
true dacă utilizatorul este administrator al organizației sau al organizației principale. În acest caz, vede tot din organizație.
permissions object
Ce poate consulta utilizatorul în această organizație.
permissions.tvs boolean
true dacă poate vedea TV-urile.
permissions.files boolean
true dacă poate vedea fișierele.
permissions.playlists boolean
true dacă poate vedea playlisturile.

Erori posibile

Cerere
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();
Răspuns200
{
  "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
      }
    }
  ]
}