Референца · Налог

Организације

GET /v1/organizations

Приказује организације којима корисник има приступ и, за сваку од њих, шта може да чита преко API-ја. Овај одговор није подељен на странице.

Параметри

Овај ендпоинт нема параметре.

Поља сваке ставке

uid string
Идентификатор организације. Користите га у параметру organization у листама.
name string
Назив организације.
neutral_zone boolean
true ако је ово организација неутралне зоне, чије датотеке и плејлисте могу да користе све остале организације.
admin boolean
true ако је корисник администратор организације или главне организације. У том случају види све у организацији.
permissions object
Шта корисник може да чита у овој организацији.
permissions.tvs boolean
true ако може да види ТВ уређаје.
permissions.files boolean
true ако може да види датотеке.
permissions.playlists boolean
true ако може да види плејлисте.

Могуће грешке

Захтев
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();
Одговор200
{
  "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
      }
    }
  ]
}