Referencia · Conta

Organizacións

Devolve as organizacións ás que ten acceso o usuario e, para cada unha, o que pode consultar a través da API. Esta resposta non está paxinada.

Parámetros

Este endpoint non admite parámetros.

Campos de cada elemento

uid string

Identificador da organización. Úseo no parámetro organization das listaxes.

name string

Nome da organización.

neutral_zone boolean

true se é unha organización de zona neutra, cuxos ficheiros e listas de reprodución poden usar todas as demais organizacións.

admin boolean

true se o usuario é administrador da organización ou da organización principal. Nese caso, ve todo na organización.

permissions object

O que o usuario pode consultar nesta organización.

permissions.tvs boolean

true se pode ver as TV.

permissions.files boolean

true se pode ver os ficheiros.

permissions.playlists boolean

true se pode ver as listas de reprodución.

Erros posibles

• Os erros de chave e de límite aplícanse a todos os endpoints. Ver todos os erros

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