Referenco · Ludlistoj

Listigi ludlistojn

Listigas la ludlistojn de la organizaĵoj, en kiuj la uzanto povas vidi ludlistojn, laŭ alfabeta ordo.

Paĝigita respondo: la eroj venas en data kaj la informoj pri la paĝo en meta. Paĝigo kaj filtriloj

Parametroj

Kampoj de ĉiu ero

uid string

Identigilo de la ludlisto.

name string

Nomo de la ludlisto.

organization object

Organizaĵo de la ludlisto: uid kaj name.

total_time integer

Tuta daŭro de la ludlisto, en sekundoj.

total_time_is_approximate boolean

true se la tuta daŭro estas takso.

Eblaj eraroj

• 400 invalid_parameter Parametro havas nevalidan valoron, ekzemple per_page super la maksimumo.
• 404 organization_not_found La indikita organization ne estas organizaĵo, en kiu la uzanto povas vidi ĉi tiun tipon de eroj.
• La eraroj pri ŝlosilo kaj limo validas por ĉiuj finpunktoj. Vidi ĉiujn erarojn

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

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