Referans · Oynatma Listeleri

Oynatma listelerini listele

GET /v1/playlists

Kullanıcının oynatma listelerini görebildiği kuruluşlardaki oynatma listelerini alfabetik sırayla listeler.

Sayfalanmış yanıt: öğeler data içinde, sayfa bilgileri ise meta içinde gelir. Sayfalama ve filtreler

Parametreler

Ad	Tür	Açıklama
`organization`	`string`	Yalnızca o kuruluşun öğelerini getirmek için bir kuruluşun uid değeri (bkz. `/organizations`).
`q`	`string`	Adın bir kısmı, en fazla 100 karakter.
`page`	`integer`	Sayfa numarası, 1'den başlar. Varsayılan: 1.
`per_page`	`integer`	Sayfa başına öğe sayısı, 1 ile 100 arasında. Varsayılan: 50.

Her öğenin alanları

uid string: Oynatma listesi tanımlayıcısı.
name string: Listenin adı.
organization object: Listenin kuruluşu: uid ve name.
total_time integer: Listenin toplam süresi, saniye cinsinden.
total_time_is_approximate boolean: Toplam süre bir tahminse true.

Olası hatalar

400 invalid_parameter Bir parametrenin değeri geçersiz, ör. per_page izin verilen en yüksek değerin üzerinde.
404 organization_not_found Belirtilen organization, kullanıcının bu tür öğeleri görebildiği bir kuruluşa ait değil.
Anahtar ve limit hataları tüm uç noktalar için geçerlidir. Tüm hataları görün

İstekcURLPHPJavaScript

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();

Yanıt200

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