Tham chiếu · Danh sách phát
Liệt kê danh sách phát
GET
/v1/playlists
Liệt kê các danh sách phát của những tổ chức mà người dùng được xem danh sách phát, theo thứ tự bảng chữ cái.
Phản hồi được phân trang: các mục nằm trong data và thông tin trang nằm trong meta. Phân trang và bộ lọc
Tham số
| Tên | Loại | Mô tả |
|---|---|---|
organization | string | uid của một tổ chức, để chỉ lấy các mục của tổ chức đó (xem /organizations). |
q | string | Một phần của tên, tối đa 100 ký tự. |
page | integer | Trang, bắt đầu từ 1. Mặc định: 1. |
per_page | integer | Số mục mỗi trang, từ 1 đến 100. Mặc định: 50. |
Các trường của mỗi mục
uidstring- Mã định danh của danh sách phát.
namestring- Tên danh sách phát.
organizationobject- Tổ chức của danh sách phát:
uidvàname. total_timeinteger- Tổng thời gian của danh sách phát, tính bằng giây.
total_time_is_approximatebooleantruenếu tổng thời gian là giá trị ước tính.
Các lỗi có thể gặp
- 400
invalid_parameterMột tham số có giá trị không hợp lệ, ví dụper_pagevượt quá mức tối đa. - 404
organization_not_foundGiá trịorganizationđược truyền không phải là tổ chức mà người dùng được xem loại mục này. - Lỗi về khóa và giới hạn yêu cầu áp dụng cho mọi endpoint. Xem tất cả lỗi
Yêu cầu
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();Phản hồi200
{
"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
}
}