Marejeleo · Orodha za kucheza

Orodhesha orodha za kucheza

GET /v1/playlists

Huorodhesha orodha za kucheza za mashirika ambamo mtumiaji anaweza kuona orodha za kucheza, kwa mpangilio wa alfabeti.

Jibu lenye kurasa: vipengee huja ndani ya data na maelezo ya ukurasa ndani ya meta. Kurasa na vichujio

Vigezo

Jina	Aina	Maelezo
`organization`	`string`	uid ya shirika, ili kuleta vipengee vyake pekee (tazama `/organizations`).
`q`	`string`	Sehemu ya jina, hadi herufi 100.
`page`	`integer`	Ukurasa, kuanzia 1. Chaguomsingi: 1.
`per_page`	`integer`	Vipengee kwa kila ukurasa, kuanzia 1 hadi 100. Chaguomsingi: 50.

Sehemu za kila kipengee

uid string: Kitambulisho cha orodha ya kucheza.
name string: Jina la orodha.
organization object: Shirika la orodha: uid na name.
total_time integer: Muda wote wa orodha, kwa sekunde.
total_time_is_approximate boolean: true ikiwa muda wote ni makadirio.

Hitilafu zinazowezekana

400 invalid_parameter Kigezo kina thamani batili, kama per_page inayozidi kiwango cha juu.
404 organization_not_found organization uliyotoa si shirika ambamo mtumiaji anaweza kuona aina hii ya kipengee.
Hitilafu za ufunguo na za kikomo zinahusu endpoint zote. Tazama hitilafu zote

OmbicURLPHPJavaScript

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

Jibu200

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