Cyfeirnod · Rhestrau chwarae

Rhestru rhestrau chwarae

GET /v1/playlists

Yn rhestru rhestrau chwarae'r sefydliadau lle gall y defnyddiwr weld rhestrau chwarae, yn nhrefn yr wyddor.

Ymateb wedi'i dudalennu: daw'r eitemau yn data a gwybodaeth y dudalen yn meta. Tudaleniad a hidlwyr

Paramedrau

Enw	Math	Disgrifiad
`organization`	`string`	uid sefydliad, i ddychwelyd ei eitemau ef yn unig (gweler `/organizations`).
`q`	`string`	Rhan o'r enw, hyd at 100 nod.
`page`	`integer`	Tudalen, gan ddechrau ar 1. Rhagosodiad: 1.
`per_page`	`integer`	Eitemau fesul tudalen, o 1 i 100. Rhagosodiad: 50.

Meysydd pob eitem

uid string: Dynodydd y rhestr chwarae.
name string: Enw'r rhestr chwarae.
organization object: Sefydliad y rhestr chwarae: uid a name.
total_time integer: Cyfanswm amser y rhestr chwarae, mewn eiliadau.
total_time_is_approximate boolean: true os amcangyfrif yw'r cyfanswm amser.

Gwallau posibl

400 invalid_parameter Mae gan baramedr werth annilys, fel per_page uwchlaw'r uchafswm.
404 organization_not_found Nid yw'r organization a roddwyd yn sefydliad lle gall y defnyddiwr weld y math hwn o eitem.
Mae gwallau allwedd a therfyn ceisiadau yn berthnasol i bob pwynt terfyn. Gweld pob gwall

CaiscURLPHPJavaScript

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

Ymateb200

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