Анықтамалық · Ойнату тізімдері

Ойнату тізімдерін тізімдеу

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