Referenca · Listat e luajtjes

Listo listat e luajtjes

GET /v1/playlists

Liston listat e luajtjes të organizatave ku përdoruesi mund të shohë lista luajtjeje, sipas rendit alfabetik.

Përgjigje e ndarë në faqe: elementet vijnë te data dhe informacioni i faqes te meta. Ndarja në faqe dhe filtrat

Parametrat

Emri	Lloji	Përshkrimi
`organization`	`string`	uid i një organizate, për të marrë vetëm elementet e saj (shihni `/organizations`).
`q`	`string`	Pjesë e emrit, deri në 100 karaktere.
`page`	`integer`	Faqja, duke filluar nga 1. Parazgjedhja: 1.
`per_page`	`integer`	Elemente për faqe, nga 1 deri në 100. Parazgjedhja: 50.

Fushat e çdo elementi

uid string: Identifikuesi i listës së luajtjes.
name string: Emri i listës.
organization object: Organizata e listës: uid dhe name.
total_time integer: Koha totale e listës, në sekonda.
total_time_is_approximate boolean: true nëse koha totale është një vlerësim.

Gabimet e mundshme

400 invalid_parameter Një parametër ka vlerë të pavlefshme, si p.sh. per_page mbi maksimumin.
404 organization_not_found organization i dhënë nuk është një organizatë ku përdoruesi mund ta shohë këtë lloj elementi.
Gabimet e çelësit dhe të kufirit vlejnë për të gjitha pikat fundore. Shiko të gjitha gabimet

KërkesacURLPHPJavaScript

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

Përgjigjja200

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