Referans · Hesap

Kuruluşlar

GET /v1/organizations

Kullanıcının erişebildiği kuruluşları ve her birinde API üzerinden neleri sorgulayabileceğini listeler. Bu yanıt sayfalanmaz.

Parametreler

Bu uç nokta parametre almaz.

Her öğenin alanları

uid string
Kuruluş tanımlayıcısı. Listelerdeki organization parametresinde kullanın.
name string
Kuruluşun adı.
neutral_zone boolean
Kuruluş, dosyaları ve oynatma listeleri diğer tüm kuruluşlar tarafından kullanılabilen bir tarafsız bölge kuruluşuysa true.
admin boolean
Kullanıcı kuruluşun veya ana kuruluşun yöneticisiyse true. Bu durumda kullanıcı kuruluştaki her şeyi görür.
permissions object
Kullanıcının bu kuruluşta neleri sorgulayabileceği.
permissions.tvs boolean
Kullanıcı TV'leri görebiliyorsa true.
permissions.files boolean
Kullanıcı dosyaları görebiliyorsa true.
permissions.playlists boolean
Kullanıcı oynatma listelerini görebiliyorsa true.

Olası hatalar

İstek
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();
Yanıt200
{
  "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
      }
    }
  ]
}