Referència · Compte

Organitzacions

GET /v1/organizations

Retorna les organitzacions a què té accés l'usuari i, per a cadascuna, què hi pot consultar a través de l'API. Aquesta resposta no està paginada.

Paràmetres

Aquest endpoint no admet paràmetres.

Camps de cada element

uid string
Identificador de l'organització. Feu-lo servir al paràmetre organization dels llistats.
name string
Nom de l'organització.
neutral_zone boolean
true si és una organització de zona neutra, els fitxers i les llistes de reproducció de la qual poden utilitzar totes les altres organitzacions.
admin boolean
true si l'usuari és administrador de l'organització o de l'organització principal. En aquest cas, ho veu tot de l'organització.
permissions object
Què pot consultar l'usuari en aquesta organització.
permissions.tvs boolean
true si pot veure les TV.
permissions.files boolean
true si pot veure els fitxers.
permissions.playlists boolean
true si pot veure les llistes de reproducció.

Errors possibles

Sol·licitud
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();
Resposta200
{
  "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
      }
    }
  ]
}