Տեղեկատու · Փլեյլիստներ
Փլեյլիստների ցանկ
GET
/v1/playlists
Ցուցակագրում է այն կազմակերպությունների փլեյլիստները, որտեղ օգտատերը կարող է տեսնել փլեյլիստներ, այբբենական կարգով։
Էջավորված պատասխան. տարրերը գալիս են data դաշտում, իսկ էջի տվյալները՝ meta դաշտում։ Էջավորում և ֆիլտրեր
Պարամետրեր
| Անուն | Տեսակ | Նկարագրություն |
|---|---|---|
organization | string | Կազմակերպության uid-ը՝ միայն դրա տարրերը ստանալու համար (տե՛ս /organizations)։ |
q | string | Անվան մի մասը, մինչև 100 նիշ։ |
page | integer | Էջը՝ սկսած 1-ից։ Լռելյայն՝ 1։ |
per_page | integer | Տարրերի քանակը մեկ էջում՝ 1-ից մինչև 100։ Լռելյայն՝ 50։ |
Յուրաքանչյուր տարրի դաշտերը
uidstring- Փլեյլիստի նույնացուցիչը։
namestring- Փլեյլիստի անունը։
organizationobject- Փլեյլիստի կազմակերպությունը՝
uidևname։ total_timeinteger- Փլեյլիստի ընդհանուր տևողությունը՝ վայրկյաններով։
total_time_is_approximatebooleantrue, եթե ընդհանուր տևողությունը մոտավոր է։
Հնարավոր սխալներ
- 400
invalid_parameterՊարամետրերից մեկն ունի անվավեր արժեք, օրինակ՝per_pageպարամետրը գերազանցում է առավելագույնը։ - 404
organization_not_foundorganizationպարամետրում նշված կազմակերպությունը չկա այն կազմակերպությունների մեջ, որտեղ օգտատերը կարող է տեսնել այս տեսակի տարրեր։ - Բանալու և սահմանաչափի սխալները վերաբերում են բոլոր վերջնակետերին։ Տեսնել բոլոր սխալները
Հարցում
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
}
}