Referans · Playlist yo

Lis playlist yo

GET /v1/playlists

Bay lis playlist yo nan òganizasyon kote itilizatè a ka wè playlist, nan lòd alfabetik.

Repons divize an paj: eleman yo vini nan data, epi enfòmasyon sou paj la vini nan meta. Paginasyon ak filtè

Paramèt

Non	Tip	Deskripsyon
`organization`	`string`	uid yon òganizasyon, pou jwenn sèlman eleman pa l yo (gade `/organizations`).
`q`	`string`	Yon pati nan non an, jiska 100 karaktè.
`page`	`integer`	Paj, apati 1. Pa defo: 1.
`per_page`	`integer`	Kantite eleman pa paj, soti 1 rive 100. Pa defo: 50.

Chan chak eleman

uid string: Idantifyan playlist la.
name string: Non playlist la.
organization object: Òganizasyon playlist la: uid ak name.
total_time integer: Tan total playlist la, an segonn.
total_time_is_approximate boolean: true si tan total la se yon estimasyon.

Erè ki posib

400 invalid_parameter Yon paramèt gen yon valè ki pa valab, tankou per_page ki depase maksimòm nan.
404 organization_not_found organization yo bay la pa koresponn ak yon òganizasyon kote itilizatè a ka wè kalite eleman sa a.
Erè kle ak erè limit yo aplike pou tout endpoint yo. Wè tout erè yo

DemanncURLPHPJavaScript

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

Repons200

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