Referens · Spellistor

Lista spellistor

GET /v1/playlists

Listar spellistorna i de organisationer där användaren kan se spellistor, i alfabetisk ordning.

Sidindelat svar: objekten kommer i data och sidinformationen i meta. Sidindelning och filter

Parametrar

Namn	Typ	Beskrivning
`organization`	`string`	uid för en organisation, för att bara få dess objekt (se `/organizations`).
`q`	`string`	Del av namnet, högst 100 tecken.
`page`	`integer`	Sida, från 1. Standard: 1.
`per_page`	`integer`	Objekt per sida, från 1 till 100. Standard: 50.

Fält för varje objekt

uid string: Spellistans id.
name string: Spellistans namn.
organization object: Spellistans organisation: uid och name.
total_time integer: Spellistans totala tid i sekunder.
total_time_is_approximate boolean: true om den totala tiden är en uppskattning.

Möjliga fel

400 invalid_parameter En parameter har ett ogiltigt värde, till exempel per_page över maxvärdet.
404 organization_not_found Angiven organization är inte en organisation där användaren kan se den här typen av objekt.
Fel som rör nyckeln och anropsgränsen gäller för alla endpoints. Visa alla fel

AnropcURLPHPJavaScript

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