Referans · Hesap
Kuruluşlar
GET
/v1/organizations
Kullanıcının erişebildiği kuruluşları ve her birinde API üzerinden neleri sorgulayabileceğini listeler. Bu yanıt sayfalanmaz.
Parametreler
Bu uç nokta parametre almaz.
Her öğenin alanları
uidstring- Kuruluş tanımlayıcısı. Listelerdeki
organizationparametresinde kullanın. namestring- Kuruluşun adı.
neutral_zoneboolean- Kuruluş, dosyaları ve oynatma listeleri diğer tüm kuruluşlar tarafından kullanılabilen bir tarafsız bölge kuruluşuysa
true. adminboolean- Kullanıcı kuruluşun veya ana kuruluşun yöneticisiyse
true. Bu durumda kullanıcı kuruluştaki her şeyi görür. permissionsobject- Kullanıcının bu kuruluşta neleri sorgulayabileceği.
permissions.tvsboolean- Kullanıcı TV'leri görebiliyorsa
true. permissions.filesboolean- Kullanıcı dosyaları görebiliyorsa
true. permissions.playlistsboolean- Kullanıcı oynatma listelerini görebiliyorsa
true.
Olası hatalar
- Anahtar ve limit hataları tüm uç noktalar için geçerlidir. Tüm hataları görün
İstek
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();Yanıt200
{
"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
}
}
]
}