রেফারেন্স · প্লেলিস্ট
প্লেলিস্টের তালিকা
GET
/v1/playlists
যেসব প্রতিষ্ঠানে ব্যবহারকারী প্লেলিস্ট দেখতে পারেন, সেগুলোর প্লেলিস্টের তালিকা বর্ণানুক্রমে দেয়।
পেজে ভাগ করা রেসপন্স: আইটেমগুলো আসে data-তে এবং পেজের তথ্য আসে meta-তে। পেজিনেশন ও ফিল্টার
প্যারামিটার
| নাম | ধরন | বিবরণ |
|---|---|---|
organization | string | কোনো প্রতিষ্ঠানের uid, শুধু সেই প্রতিষ্ঠানের আইটেম আনার জন্য (দেখুন /organizations)। |
q | string | নামের অংশ, সর্বোচ্চ 100টি অক্ষর। |
page | integer | পেজ, 1 থেকে শুরু। ডিফল্ট: 1। |
per_page | integer | প্রতি পেজে আইটেম, 1 থেকে 100 পর্যন্ত। ডিফল্ট: 50। |
প্রতিটি আইটেমের ফিল্ড
uidstring- প্লেলিস্টের শনাক্তকারী।
namestring- প্লেলিস্টের নাম।
organizationobject- প্লেলিস্টের প্রতিষ্ঠান:
uidওname। total_timeinteger- প্লেলিস্টের মোট সময়, সেকেন্ডে।
total_time_is_approximateboolean- মোট সময়টি আনুমানিক হলে
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();রেসপন্স200
{
"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
}
}