Tixraac · Liisaska Ciyaareed

Eeg hal liis ciyaareed

GET /v1/playlists/{uid}

Wuxuu muujiyaa hal liis ciyaareed iyadoo la adeegsanayo uid-kiisa, oo ay la socdaan walxaha sida ay u kala horreeyaan marka la soo bandhigayo iyo TV-yada isticmaala liiska.

Halbeegga dariiqa

MagacNoocSharaxaad
uidstringuid-ka liiska ciyaareed.

Goobaha jawaabta

uid string
Aqoonsiga liiska ciyaareed.
name string
Magaca liiska.
organization object
Ururka liiska: uid iyo name.
total_time integer
Wadarta waqtiga liiska, ilbiriqsiyo ahaan.
total_time_is_approximate boolean
true haddii wadarta waqtigu tahay qiyaas.
items array
Walxaha liiska, sida ay u kala horreeyaan marka la soo bandhigayo.
items[].position integer
Booska walaxda ee liiska.
items[].type string
file haddii uu yahay fayl ama entertainment haddii uu yahay nuxur madadaalo. Noocyo kale ayaa soo muuqan kara.
items[].uid string
Aqoonsiga faylka ama nuxurka madadaalada.
items[].display_time integer | null
Waqtiga soo bandhigidda ee walaxda loo dejiyay, ilbiriqsiyo ahaan, ama null haddii aan la dejin.
items[].file object | null
Xogta faylka, oo leh isla goobaha “Eeg faylalka”, ama null haddii walaxdu aanay ahayn fayl ama haddii isticmaaluhu arki karin faylalka ururkiisa.
tvs array
TV-yada isticmaala liiska (uid, name iyo organization). Waxaa muuqda oo keliya TV-yada uu isticmaaluhu arki karo.

Khaladaadka suurtagalka ah

  • 404 not_found Endpoint-ku ma jiro, ama walaxdu ma jirto ama waxay ka tirsan tahay urur uusan isticmaaluhu arki karin.
  • Khaladaadka furaha iyo xadka waxay khuseeyaan dhammaan endpoint-yada. Eeg dhammaan khaladaadka
Codsi
curl "https://api.on-cloud.live/v1/playlists/e4da3b7fbbce2345d7772b0674a318d5" \
  -H "X-API-Key: $API_KEY"
<?php
$ch = curl_init('https://api.on-cloud.live/v1/playlists/e4da3b7fbbce2345d7772b0674a318d5');
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/e4da3b7fbbce2345d7772b0674a318d5', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();
Jawaab200
{
  "data": {
    "uid": "e4da3b7fbbce2345d7772b0674a318d5",
    "name": "Lista principal",
    "organization": {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro"
    },
    "total_time": 85,
    "total_time_is_approximate": true,
    "items": [
      {
        "position": 1,
        "type": "file",
        "uid": "a87ff679a2f3e71d9181a67b7542122c",
        "display_time": null,
        "file": {
          "uid": "a87ff679a2f3e71d9181a67b7542122c",
          "name": "Promoção de verão",
          "type": "video",
          "duration": 30,
          "archived": false,
          "organization": {
            "uid": "8f14e45fceea167a5a36dedd4bea2543",
            "name": "Loja Centro"
          }
        }
      },
      {
        "position": 2,
        "type": "entertainment",
        "uid": "noticias",
        "display_time": 15,
        "file": null
      },
      {
        "position": 3,
        "type": "file",
        "uid": "6512bd43d9caa6e02c990b0a82652dca",
        "display_time": 10,
        "file": {
          "uid": "6512bd43d9caa6e02c990b0a82652dca",
          "name": "Cardápio do dia",
          "type": "image",
          "duration": 10,
          "archived": false,
          "organization": {
            "uid": "8f14e45fceea167a5a36dedd4bea2543",
            "name": "Loja Centro"
          }
        }
      }
    ],
    "tvs": [
      {
        "uid": "c98cb8f9cc62887d1f6cf5693df9219c",
        "name": "Recepção",
        "organization": {
          "uid": "8f14e45fceea167a5a36dedd4bea2543",
          "name": "Loja Centro"
        }
      },
      {
        "uid": "45c48cce2e2d7fbdea1afc51c7c6ad26",
        "name": "Vitrine",
        "organization": {
          "uid": "8f14e45fceea167a5a36dedd4bea2543",
          "name": "Loja Centro"
        }
      }
    ]
  }
}
Walax aan jirin ama aan gelitaan loo lahayn404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}