Marejeleo · Akaunti

Mashirika

GET /v1/organizations

Huorodhesha mashirika ambayo mtumiaji ana ufikiaji kwayo na, kwa kila moja, anachoweza kusoma kupitia API. Jibu hili halijagawanywa katika kurasa.

Vigezo

Endpoint hii haipokei vigezo.

Sehemu za kila kipengee

uid string
Kitambulisho cha shirika. Kitumie katika kigezo organization cha orodha.
name string
Jina la shirika.
neutral_zone boolean
true ikiwa ni shirika la eneo huru, ambalo faili na orodha zake za kucheza zinaweza kutumiwa na mashirika mengine yote.
admin boolean
true ikiwa mtumiaji ni msimamizi wa shirika au wa shirika kuu. Hapo, huona kila kitu cha shirika.
permissions object
Kile ambacho mtumiaji anaweza kusoma katika shirika hili.
permissions.tvs boolean
true ikiwa anaweza kuona TV.
permissions.files boolean
true ikiwa anaweza kuona faili.
permissions.playlists boolean
true ikiwa anaweza kuona orodha za kucheza.

Hitilafu zinazowezekana

Ombi
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();
Jibu200
{
  "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
      }
    }
  ]
}