المرجع · قوائم التشغيل

عرض قوائم التشغيل

تعرض قوائم التشغيل في المؤسسات التي يمكن للمستخدم فيها رؤية قوائم التشغيل، بالترتيب الأبجدي.

استجابة مقسّمة إلى صفحات: تأتي العناصر في data ومعلومات الصفحة في meta. ترقيم الصفحات والتصفية

المعاملات

حقول كل عنصر

uid string

معرّف قائمة التشغيل.

name string

اسم قائمة التشغيل.

organization object

مؤسسة قائمة التشغيل: uid وname.

total_time integer

المدة الإجمالية لقائمة التشغيل بالثواني.

total_time_is_approximate boolean

true إذا كانت المدة الإجمالية تقديرية.

الأخطاء المحتملة

• 400 invalid_parameter أحد المعاملات له قيمة غير صالحة، مثل per_page بقيمة أكبر من الحد الأقصى.
• 404 organization_not_found قيمة organization المحددة لا تخص مؤسسة يمكن للمستخدم فيها رؤية هذا النوع من العناصر.
• تنطبق أخطاء المفتاح وحد الطلبات على جميع نقاط النهاية. عرض جميع الأخطاء

curl "https://api.on-cloud.live/v1/playlists?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/playlists?per_page=2');
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/playlists?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

{
  "data": [
    {
      "uid": "1f0e3dad99908345f7439f8ffabdffc4",
      "name": "Lista do caixa",
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      },
      "total_time": 40,
      "total_time_is_approximate": false
    },
    {
      "uid": "e4da3b7fbbce2345d7772b0674a318d5",
      "name": "Lista principal",
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      },
      "total_time": 85,
      "total_time_is_approximate": true
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 2,
    "total_pages": 1
  }
}