Referència · Llistes de reproducció

Llistar llistes

GET /v1/playlists

Retorna les llistes de reproducció de les organitzacions en què l'usuari pot veure llistes, en ordre alfabètic.

Resposta paginada: els elements es retornen a data i la informació de la pàgina, a meta. Paginació i filtres

Paràmetres

Nom	Tipus	Descripció
`organization`	`string`	uid d'una organització, per obtenir només els seus elements (vegeu `/organizations`).
`q`	`string`	Part del nom, fins a 100 caràcters.
`page`	`integer`	Pàgina, a partir d'1. Valor per defecte: 1.
`per_page`	`integer`	Elements per pàgina, d'1 a 100. Valor per defecte: 50.

Camps de cada element

uid string: Identificador de la llista de reproducció.
name string: Nom de la llista.
organization object: Organització de la llista: uid i name.
total_time integer: Durada total de la llista, en segons.
total_time_is_approximate boolean: true si la durada total és una estimació.

Errors possibles

400 invalid_parameter Un paràmetre té un valor no vàlid, com ara per_page per sobre del màxim.
404 organization_not_found El valor d'organization indicat no correspon a cap organització en què l'usuari pugui veure aquest tipus d'element.
Els errors de clau i de límit s'apliquen a tots els endpoints. Veure tots els errors

Sol·licitudcURLPHPJavaScript

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

Resposta200

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