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

Организации

Возвращает организации, к которым у пользователя есть доступ, и для каждой — что он может получать через 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
      }
    }
  ]
}