Referens · Konto

Organisationer

Listar de organisationer som användaren har åtkomst till och, för var och en, vad användaren kan hämta via API:et. Svaret är inte sidindelat.

Parametrar

Den här endpointen tar inga parametrar.

Fält för varje objekt

uid string

Organisationens id. Använd det i parametern organization i listorna.

name string

Organisationens namn.

neutral_zone boolean

true om det är en organisation i neutral zon, vars filer och spellistor kan användas av alla andra organisationer.

admin boolean

true om användaren är administratör för organisationen eller för huvudorganisationen. I så fall ser användaren allt i organisationen.

permissions object

Vad användaren kan hämta i den här organisationen.

permissions.tvs boolean

true om användaren kan se TV-apparaterna.

permissions.files boolean

true om användaren kan se filerna.

permissions.playlists boolean

true om användaren kan se spellistorna.

Möjliga fel

• Fel som rör nyckeln och anropsgränsen gäller för alla endpoints. Visa alla fel

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