Atsauce · Atskaņošanas saraksti

Uzskaitīt atskaņošanas sarakstus

GET /v1/playlists

Alfabētiskā secībā uzskaita atskaņošanas sarakstus tajās organizācijās, kurās lietotājs var redzēt atskaņošanas sarakstus.

Lapās dalīta atbilde: vienumi tiek atgriezti laukā data, bet informācija par lapu — laukā meta. Lapošana un filtri

Parametri

Nosaukums	Tips	Apraksts
`organization`	`string`	Organizācijas uid, lai iegūtu tikai tās vienumus (skatiet `/organizations`).
`q`	`string`	Nosaukuma daļa, līdz 100 rakstzīmēm.
`page`	`integer`	Lapa, sākot no 1. Noklusējums: 1.
`per_page`	`integer`	Vienumu skaits lapā, no 1 līdz 100. Noklusējums: 50.

Katra vienuma lauki

uid string: Atskaņošanas saraksta identifikators.
name string: Saraksta nosaukums.
organization object: Saraksta organizācija: uid un name.
total_time integer: Saraksta kopējais ilgums sekundēs.
total_time_is_approximate boolean: true, ja kopējais ilgums ir aptuvens.

Iespējamās kļūdas

400 invalid_parameter Parametram ir nederīga vērtība, piemēram, per_page pārsniedz maksimumu.
404 organization_not_found Norādītais organization nav organizācija, kurā lietotājs var redzēt šāda veida vienumus.
Atslēgas un ierobežojumu kļūdas attiecas uz visiem galapunktiem. Skatīt visas kļūdas

PieprasījumscURLPHPJavaScript

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

Atbilde200

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