Referenco · Konto

Organizaĵoj

GET /v1/organizations

Listigas la organizaĵojn, al kiuj la uzanto havas aliron, kaj, por ĉiu, kion tiu povas konsulti per la API. Ĉi tiu respondo ne estas paĝigita.

Parametroj

Ĉi tiu finpunkto ne ricevas parametrojn.

Kampoj de ĉiu ero

uid string
Identigilo de la organizaĵo. Uzu ĝin en la parametro organization de la listoj.
name string
Nomo de la organizaĵo.
neutral_zone boolean
true se ĝi estas organizaĵo de neŭtrala zono, kies dosierojn kaj ludlistojn povas uzi ĉiuj aliaj organizaĵoj.
admin boolean
true se la uzanto estas administranto de la organizaĵo aŭ de la ĉefa organizaĵo. Tiukaze, la uzanto vidas ĉion de la organizaĵo.
permissions object
Kion la uzanto povas konsulti en ĉi tiu organizaĵo.
permissions.tvs boolean
true se la uzanto povas vidi la televidilojn.
permissions.files boolean
true se la uzanto povas vidi la dosierojn.
permissions.playlists boolean
true se la uzanto povas vidi la ludlistojn.

Eblaj eraroj

Peto
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();
Respondo200
{
  "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
      }
    }
  ]
}