Лавлах · Тоглуулах жагсаалтууд

Тоглуулах жагсаалтуудыг жагсаах

GET /v1/playlists

Хэрэглэгчийн тоглуулах жагсаалт харах эрхтэй байгууллагуудын тоглуулах жагсаалтуудыг цагаан толгойн дарааллаар жагсаана.

Хуудаслагдсан хариу: зүйлс data талбарт, хуудасны мэдээлэл meta талбарт ирнэ. Хуудаслалт ба шүүлтүүр

Параметрүүд

Нэр	Төрөл	Тайлбар
`organization`	`string`	Зөвхөн тухайн байгууллагын зүйлсийг авах байгууллагын uid (`/organizations` хэсгийг үзнэ үү).
`q`	`string`	Нэрийн хэсэг, 100 хүртэл тэмдэгт.
`page`	`integer`	Хуудас, 1-ээс эхэлнэ. Анхдагч: 1.
`per_page`	`integer`	Хуудас тутмын зүйлсийн тоо, 1-ээс 100 хүртэл. Анхдагч: 50.

Зүйл бүрийн талбарууд

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 нь хэрэглэгч энэ төрлийн зүйлсийг харах эрхтэй байгууллага биш.
Түлхүүр болон хязгаарын алдаанууд бүх эндпоинтод хамаарна. Бүх алдааг харах

ХүсэлтcURLPHPJavaScript

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
  }
}