Arayış · Hesab

Şirkətlər

GET /v1/organizations

İstifadəçinin girişi olan şirkətləri və hər birində API vasitəsilə nələri sorğulaya biləcəyini siyahıya alır. Bu cavab səhifələrə bölünmür.

Parametrlər

Bu endpoint parametr qəbul etmir.

Hər elementin sahələri

uid string
Şirkət identifikatoru. Siyahıların organization parametrində istifadə edin.
name string
Şirkətin adı.
neutral_zone boolean
Bu, faylları və pleylistləri bütün digər şirkətlər tərəfindən istifadə oluna bilən neytral zona şirkətidirsə, true.
admin boolean
İstifadəçi şirkətin və ya əsas şirkətin inzibatçısıdırsa, true. Bu halda o, şirkətdəki hər şeyi görür.
permissions object
İstifadəçinin bu şirkətdə nələri sorğulaya biləcəyi.
permissions.tvs boolean
TV-ləri görə bilirsə, true.
permissions.files boolean
Faylları görə bilirsə, true.
permissions.playlists boolean
Pleylistləri görə bilirsə, true.

Mümkün xətalar

Sorğu
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();
Cavab200
{
  "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
      }
    }
  ]
}