Справочник · Акаунт

Организации

Връща организациите, до които потребителят има достъп, и за всяка от тях — какво може да чете през 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();

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