Referentie · Playlists

Playlists opvragen

GET /v1/playlists

Geeft de playlists van de organisaties waarin de gebruiker playlists kan zien, in alfabetische volgorde.

Gepagineerd antwoord: de items staan in data en de pagina-informatie in meta. Paginering en filters

Parameters

Naam	Type	Beschrijving
`organization`	`string`	uid van een organisatie, om alleen de items daarvan op te halen (zie `/organizations`).
`q`	`string`	Deel van de naam, maximaal 100 tekens.
`page`	`integer`	Pagina, vanaf 1. Standaard: 1.
`per_page`	`integer`	Items per pagina, van 1 tot 100. Standaard: 50.

Velden van elk item

uid string: ID van de playlist.
name string: Naam van de playlist.
organization object: Organisatie van de playlist: uid en name.
total_time integer: Totale duur van de playlist, in seconden.
total_time_is_approximate boolean: true als de totale duur een schatting is.

Mogelijke fouten

400 invalid_parameter Een parameter heeft een ongeldige waarde, zoals per_page boven het maximum.
404 organization_not_found De opgegeven organization is geen organisatie waarin de gebruiker dit type item kan zien.
Fouten rond de sleutel en de verzoeklimiet gelden voor alle endpoints. Alle fouten bekijken

VerzoekcURLPHPJavaScript

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

Antwoord200

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