Sanggunian · Account
Mga Organisasyon
GET
/v1/organizations
Inililista ang mga organisasyong may access ang user at, sa bawat isa, kung ano ang mababasa niya sa pamamagitan ng API. Walang pagination ang response na ito.
Mga parameter
Walang tinatanggap na parameter ang endpoint na ito.
Mga field ng bawat item
uidstring- Identifier ng organisasyon. Gamitin ito sa parameter na
organizationng mga listahan. namestring- Pangalan ng organisasyon.
neutral_zonebooleantruekung isa itong neutral zone na organisasyon, na ang mga file at playlist ay magagamit ng lahat ng iba pang organisasyon.adminbooleantruekung administrator ang user ng organisasyon o ng pangunahing organisasyon. Sa ganitong kaso, nakikita niya ang lahat sa organisasyon.permissionsobject- Ano ang mababasa ng user sa organisasyong ito.
permissions.tvsbooleantruekung nakikita niya ang mga TV.permissions.filesbooleantruekung nakikita niya ang mga file.permissions.playlistsbooleantruekung nakikita niya ang mga playlist.
Mga posibleng error
- Umiiral sa lahat ng endpoint ang mga error sa key at sa limitasyon. Tingnan ang lahat ng error
Request
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();Response200
{
"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
}
}
]
}