Referință · Playlisturi

Listarea playlisturilor

GET /v1/playlists

Listează playlisturile din organizațiile în care utilizatorul poate vedea playlisturi, în ordine alfabetică.

Răspuns paginat: elementele vin în data, iar informațiile despre pagină, în meta. Paginare și filtre

Parametri

Nume	Tip	Descriere
`organization`	`string`	uid-ul unei organizații, pentru a returna doar elementele acesteia (vedeți `/organizations`).
`q`	`string`	O parte din nume, de cel mult 100 de caractere.
`page`	`integer`	Pagina, începând de la 1. Implicit: 1.
`per_page`	`integer`	Elemente pe pagină, de la 1 la 100. Implicit: 50.

Câmpurile fiecărui element

uid string: Identificatorul playlistului.
name string: Numele playlistului.
organization object: Organizația playlistului: uid și name.
total_time integer: Durata totală a playlistului, în secunde.
total_time_is_approximate boolean: true dacă durata totală este o estimare.

Erori posibile

400 invalid_parameter Un parametru are o valoare invalidă, de exemplu per_page peste valoarea maximă.
404 organization_not_found Valoarea organization indicată nu corespunde unei organizații în care utilizatorul poate vedea acest tip de element.
Erorile de cheie și de limită se aplică tuturor endpointurilor. Vedeți toate erorile

CererecURLPHPJavaScript

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

Răspuns200

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