Referenz · Playlists

Playlists auflisten

GET /v1/playlists

Listet die Playlists der Organisationen, in denen der Benutzer Playlists sehen kann, alphabetisch sortiert auf.

Paginierte Antwort: Die Elemente stehen in data, die Seiteninformationen in meta. Paginierung und Filter

Parameter

Name	Typ	Beschreibung
`organization`	`string`	uid einer Organisation, um nur deren Elemente zu erhalten (siehe `/organizations`).
`q`	`string`	Teil des Namens, bis zu 100 Zeichen.
`page`	`integer`	Seite, beginnend bei 1. Standard: 1.
`per_page`	`integer`	Elemente pro Seite, von 1 bis 100. Standard: 50.

Felder jedes Elements

uid string: Kennung der Playlist.
name string: Name der Playlist.
organization object: Organisation der Playlist: uid und name.
total_time integer: Gesamtdauer der Playlist in Sekunden.
total_time_is_approximate boolean: true, wenn die Gesamtdauer ein Schätzwert ist.

Mögliche Fehler

400 invalid_parameter Ein Parameter hat einen ungültigen Wert, z. B. per_page über dem Maximum.
404 organization_not_found Der angegebene Wert für organization gehört zu keiner Organisation, in der der Benutzer diese Art von Elementen sehen kann.
Fehler zum Schlüssel und zum Anfragelimit gelten für alle Endpunkte. Alle Fehler ansehen

AnfragecURLPHPJavaScript

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

Antwort200

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