Žinynas · Paskyra

Organizacijos

Pateikia organizacijas, prie kurių naudotojas turi prieigą, ir kiekvienai iš jų nurodo, ką jis gali gauti per API. Šis atsakymas puslapiais neskaidomas.

Parametrai

Šis galinis taškas neturi parametrų.

Kiekvieno elemento laukai

uid string

Organizacijos identifikatorius. Naudokite jį sąrašų parametre organization.

name string

Organizacijos pavadinimas.

neutral_zone boolean

true, jei tai neutralios zonos organizacija, kurios failus ir grojaraščius gali naudoti visos kitos organizacijos.

admin boolean

true, jei naudotojas yra organizacijos arba pagrindinės organizacijos administratorius. Tokiu atveju jis mato viską organizacijoje.

permissions object

Ką naudotojas gali gauti šioje organizacijoje.

permissions.tvs boolean

true, jei gali matyti televizorius.

permissions.files boolean

true, jei gali matyti failus.

permissions.playlists boolean

true, jei gali matyti grojaraščius.

Galimos klaidos

• Rakto ir apribojimų klaidos galioja visiems galiniams taškams. Žiūrėti visas klaidas

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