Референца · Плејлисте

Списак плејлиста

GET /v1/playlists

Приказује по азбучном реду плејлисте организација у којима корисник може да види плејлисте.

Одговор подељен на странице: ставке стижу у data, а подаци о страници у meta. Пагинација и филтери

Параметри

Назив	Тип	Опис
`organization`	`string`	uid организације, да бисте добили само њене ставке (погледајте `/organizations`).
`q`	`string`	Део назива, до 100 знакова.
`page`	`integer`	Страница, почев од 1. Подразумевано: 1.
`per_page`	`integer`	Број ставки по страници, од 1 до 100. Подразумевано: 50.

Поља сваке ставке

uid string: Идентификатор плејлисте.
name string: Назив плејлисте.
organization object: Организација плејлисте: uid и name.
total_time integer: Укупно трајање плејлисте у секундама.
total_time_is_approximate boolean: true ако је укупно трајање процена.

Могуће грешке

400 invalid_parameter Неки параметар има неважећу вредност, нпр. per_page изнад максимума.
404 organization_not_found Наведени organization није организација у којој корисник може да види ову врсту ставки.
Грешке у вези са кључем и ограничењем захтева важе за све ендпоинте. Погледај све грешке

ЗахтевcURLPHPJavaScript

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

Одговор200

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