Referencia · Lejátszási listák

Lejátszási listák listázása

GET /v1/playlists

Ábécérendben listázza azoknak a szervezeteknek a lejátszási listáit, amelyekben a felhasználó láthatja a lejátszási listákat.

Lapozott válasz: az elemek a data, a lap adatai a meta mezőben érkeznek. Lapozás és szűrők

Paraméterek

Név	Típus	Leírás
`organization`	`string`	Egy szervezet uid azonosítója, ha csak annak elemeit szeretné lekérni (lásd: `/organizations`).
`q`	`string`	A név egy része, legfeljebb 100 karakter.
`page`	`integer`	Oldalszám, 1-től kezdve. Alapértelmezés: 1.
`per_page`	`integer`	Elemek száma oldalanként, 1 és 100 között. Alapértelmezés: 50.

Az egyes elemek mezői

uid string: A lejátszási lista azonosítója.
name string: A lista neve.
organization object: A lista szervezete: uid és name.
total_time integer: A lista teljes időtartama másodpercben.
total_time_is_approximate boolean: true, ha a teljes időtartam becsült érték.

Lehetséges hibák

400 invalid_parameter Egy paraméter értéke érvénytelen, például a per_page meghaladja a maximumot.
404 organization_not_found A megadott organization nem olyan szervezet, amelyben a felhasználó láthatja az ilyen típusú elemeket.
A kulccsal és a kéréskorláttal kapcsolatos hibák minden végpontra vonatkoznak. Az összes hiba megtekintése

KéréscURLPHPJavaScript

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

Válasz200

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