Referensi · Akun

Organisasi

Menampilkan daftar organisasi yang dapat diakses pengguna dan, untuk masing-masing, apa saja yang dapat ia baca melalui API. Respons ini tidak dipaginasi.

Parameter

Endpoint ini tidak menerima parameter.

Field setiap item

uid string

ID organisasi. Gunakan di parameter organization pada daftar.

name string

Nama organisasi.

neutral_zone boolean

true jika ini organisasi zona netral, yang file dan playlist-nya dapat digunakan oleh semua organisasi lain.

admin boolean

true jika pengguna adalah administrator organisasi tersebut atau organisasi utama. Dalam hal ini, ia dapat melihat semua isi organisasi.

permissions object

Apa saja yang dapat dibaca pengguna di organisasi ini.

permissions.tvs boolean

true jika ia dapat melihat TV.

permissions.files boolean

true jika ia dapat melihat file.

permissions.playlists boolean

true jika ia dapat melihat playlist.

Kemungkinan error

• Error kunci dan batas permintaan berlaku untuk semua endpoint. Lihat semua error

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