Αναφορά · Λίστες αναπαραγωγής

Ανάκτηση λιστών αναπαραγωγής

GET /v1/playlists

Παραθέτει με αλφαβητική σειρά τις λίστες αναπαραγωγής των οργανισμών όπου ο χρήστης μπορεί να βλέπει λίστες αναπαραγωγής.

Σελιδοποιημένη απόκριση: τα στοιχεία επιστρέφονται στο data και οι πληροφορίες της σελίδας στο meta. Σελιδοποίηση και φίλτρα

Παράμετροι

Όνομα	Τύπος	Περιγραφή
`organization`	`string`	uid ενός οργανισμού, για να επιστραφούν μόνο τα δικά του στοιχεία (βλ. `/organizations`).
`q`	`string`	Μέρος του ονόματος, έως 100 χαρακτήρες.
`page`	`integer`	Σελίδα, ξεκινώντας από το 1. Προεπιλογή: 1.
`per_page`	`integer`	Στοιχεία ανά σελίδα, από 1 έως 100. Προεπιλογή: 50.

Πεδία κάθε στοιχείου

uid string: Αναγνωριστικό της λίστας αναπαραγωγής.
name string: Όνομα της λίστας.
organization object: Οργανισμός της λίστας: uid και name.
total_time integer: Συνολική διάρκεια της λίστας, σε δευτερόλεπτα.
total_time_is_approximate boolean: true αν η συνολική διάρκεια είναι κατά προσέγγιση.

Πιθανά σφάλματα

400 invalid_parameter Μια παράμετρος έχει μη έγκυρη τιμή, π.χ. per_page πάνω από το μέγιστο.
404 organization_not_found Το organization που δόθηκε δεν αντιστοιχεί σε οργανισμό όπου ο χρήστης μπορεί να δει αυτόν τον τύπο στοιχείων.
Τα σφάλματα κλειδιού και ορίου ισχύουν για όλα τα τελικά σημεία. Δείτε όλα τα σφάλματα

ΑίτημαcURLPHPJavaScript

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

Απόκριση200

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