Riferimento · Playlist

Elenca le playlist

GET /v1/playlists

Elenca le playlist delle organizzazioni in cui l'utente può vedere le playlist, in ordine alfabetico.

Risposta paginata: gli elementi arrivano in data e le informazioni sulla pagina in meta. Paginazione e filtri

Parametri

Nome	Tipo	Descrizione
`organization`	`string`	uid di un'organizzazione, per restituire solo i suoi elementi (vedi `/organizations`).
`q`	`string`	Parte del nome, fino a 100 caratteri.
`page`	`integer`	Pagina, a partire da 1. Predefinito: 1.
`per_page`	`integer`	Elementi per pagina, da 1 a 100. Predefinito: 50.

Campi di ogni elemento

uid string: Identificativo della playlist.
name string: Nome della playlist.
organization object: Organizzazione della playlist: uid e name.
total_time integer: Durata totale della playlist, in secondi.
total_time_is_approximate boolean: true se la durata totale è una stima.

Errori possibili

400 invalid_parameter Un parametro ha un valore non valido, ad esempio per_page oltre il massimo.
404 organization_not_found Il valore di organization indicato non corrisponde a un'organizzazione in cui l'utente può vedere questo tipo di elemento.
Gli errori relativi alla chiave e al limite valgono per tutti gli endpoint. Vedi tutti gli errori

RichiestacURLPHPJavaScript

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

Risposta200

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