Reference · Playlister

Hent playlister

GET /v1/playlists

Viser playlisterne i de organisationer, hvor brugeren kan se playlister, i alfabetisk rækkefølge.

Svar opdelt i sider: Elementerne ligger i data og sideoplysningerne i meta. Sideinddeling og filtre

Parametre

Navn	Type	Beskrivelse
`organization`	`string`	uid for en organisation, så kun dens elementer returneres (se `/organizations`).
`q`	`string`	Del af navnet, op til 100 tegn.
`page`	`integer`	Side, startende ved 1. Standard: 1.
`per_page`	`integer`	Elementer pr. side, fra 1 til 100. Standard: 50.

Felter for hvert element

uid string: Playlistens id.
name string: Playlistens navn.
organization object: Playlistens organisation: uid og name.
total_time integer: Playlistens samlede tid i sekunder.
total_time_is_approximate boolean: true, hvis den samlede tid er et skøn.

Mulige fejl

400 invalid_parameter En parameter har en ugyldig værdi, f.eks. per_page over maksimum.
404 organization_not_found Den angivne organization er ikke en organisation, hvor brugeren kan se denne type elementer.
Fejl vedrørende nøgle og grænser gælder for alle endpoints. Se alle fejl

ForespørgselcURLPHPJavaScript

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

Svar200

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