Sanggunian · Mga Playlist

Ilista ang mga playlist

GET /v1/playlists

Inililista ang mga playlist ng mga organisasyon kung saan nakikita ng user ang mga playlist, ayon sa alpabeto.

Response na may pagination: nasa data ang mga item at nasa meta ang impormasyon ng pahina. Pagination at mga filter

Mga parameter

Pangalan	Uri	Paglalarawan
`organization`	`string`	uid ng isang organisasyon, para ang mga item lang nito ang makuha (tingnan ang `/organizations`).
`q`	`string`	Bahagi ng pangalan, hanggang 100 character.
`page`	`integer`	Pahina, simula sa 1. Default: 1.
`per_page`	`integer`	Mga item bawat pahina, mula 1 hanggang 100. Default: 50.

Mga field ng bawat item

uid string: Identifier ng playlist.
name string: Pangalan ng playlist.
organization object: Organisasyon ng playlist: uid at name.
total_time integer: Kabuuang oras ng playlist, sa segundo.
total_time_is_approximate boolean: true kung tantiya lang ang kabuuang oras.

Mga posibleng error

400 invalid_parameter May invalid na value ang isang parameter, gaya ng per_page na lampas sa maximum.
404 organization_not_found Ang ibinigay na organization ay hindi isang organisasyon kung saan nakikita ng user ang ganitong uri ng item.
Umiiral sa lahat ng endpoint ang mga error sa key at sa limitasyon. Tingnan ang lahat ng error

RequestcURLPHPJavaScript

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

Response200

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