Tixraac · Liisaska Ciyaareed

Eeg liisaska ciyaareed

GET /v1/playlists

Wuxuu liis gareeyaa liisaska ciyaareed ee ururada uu isticmaaluhu ku arki karo liisaska ciyaareed, sida alifbeetada.

Jawaab bogaysan: walxaha waxay ku yimaadaan data, macluumaadka bogguna wuxuu ku yimaadaa meta. Bogaynta iyo shaandhaynta

Halbeegyada

Magac	Nooc	Sharaxaad
`organization`	`string`	uid-ka urur, si loo soo celiyo walxihiisa oo keliya (eeg `/organizations`).
`q`	`string`	Qayb ka mid ah magaca, ilaa 100 xaraf.
`page`	`integer`	Bogga, laga bilaabo 1. Caadi ahaan: 1.
`per_page`	`integer`	Walxaha bog kasta, 1 ilaa 100. Caadi ahaan: 50.

Goobaha walax kasta

uid string: Aqoonsiga liiska ciyaareed.
name string: Magaca liiska.
organization object: Ururka liiska: uid iyo name.
total_time integer: Wadarta waqtiga liiska, ilbiriqsiyo ahaan.
total_time_is_approximate boolean: true haddii wadarta waqtigu tahay qiyaas.

Khaladaadka suurtagalka ah

400 invalid_parameter Halbeeg ayaa leh qiime khaldan, sida per_page oo ka badan inta ugu badan.
404 organization_not_found organization-ka la bixiyay ma aha urur uu isticmaaluhu ku arki karo noocan walxaha ah.
Khaladaadka furaha iyo xadka waxay khuseeyaan dhammaan endpoint-yada. Eeg dhammaan khaladaadka

CodsicURLPHPJavaScript

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

Jawaab200

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