Viiteopas · Tili

Organisaatiot

Listaa organisaatiot, joihin käyttäjällä on pääsy, ja kustakin sen, mitä hän voi hakea API:n kautta. Tätä vastausta ei ole sivutettu.

Parametrit

Tämä päätepiste ei ota parametreja.

Kunkin kohteen kentät

uid string

Organisaation tunniste. Käytä sitä luetteloiden parametrissa organization.

name string

Organisaation nimi.

neutral_zone boolean

true, jos organisaatio on neutraali alue, jonka tiedostoja ja soittolistoja kaikki muut organisaatiot voivat käyttää.

admin boolean

true, jos käyttäjä on organisaation tai pääorganisaation ylläpitäjä. Silloin hän näkee kaiken organisaatiossa.

permissions object

Mitä käyttäjä voi hakea tässä organisaatiossa.

permissions.tvs boolean

true, jos hän voi nähdä TV:t.

permissions.files boolean

true, jos hän voi nähdä tiedostot.

permissions.playlists boolean

true, jos hän voi nähdä soittolistat.

Mahdolliset virheet

• Avaimeen ja pyyntörajaan liittyvät virheet koskevat kaikkia päätepisteitä. Näytä kaikki virheet

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