חומר עזר · פלייליסטים

רשימת פלייליסטים

מציג את הפלייליסטים של הארגונים שבהם המשתמש יכול לראות פלייליסטים, לפי סדר אלפביתי.

תגובה מחולקת לעמודים: הפריטים מגיעים ב-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
  }
}