ข้อมูลอ้างอิง · บัญชี

องค์กร

GET /v1/organizations

แสดงรายการองค์กรที่ผู้ใช้เข้าถึงได้ และสิ่งที่ผู้ใช้ดึงข้อมูลผ่าน 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();
การตอบกลับ200
{
  "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
      }
    }
  ]
}