Référence · Playlists

Consulter une playlist

GET /v1/playlists/{uid}

Renvoie une playlist à partir de son uid, avec ses éléments dans l'ordre de diffusion et les TVs qui l'utilisent.

Paramètre de chemin

Nom	Type	Description
`uid`	`string`	uid de la playlist.

Champs de la réponse

uid string: Identifiant de la playlist.
name string: Nom de la playlist.
organization object: Organisation de la playlist : uid et name.
total_time integer: Durée totale de la playlist, en secondes.
total_time_is_approximate boolean: true si la durée totale est une estimation.
items array: Éléments de la playlist, dans l'ordre de diffusion.
items[].position integer: Position de l'élément dans la playlist.
items[].type string: file pour un fichier ou entertainment pour un contenu de divertissement. D'autres types peuvent apparaître.
items[].uid string: Identifiant du fichier ou du contenu de divertissement.
items[].display_time integer | null: Durée d'affichage définie pour l'élément, en secondes, ou null si aucune n'est définie.
items[].file object | null: Informations du fichier, avec les mêmes champs que dans « Lister les fichiers », ou null si l'élément n'est pas un fichier ou si l'utilisateur ne peut pas voir les fichiers de son organisation.
tvs array: TVs qui utilisent la playlist (uid, name et organization). Seules les TVs que l'utilisateur peut voir sont listées.

Erreurs possibles

404 not_found L'endpoint n'existe pas, ou l'élément n'existe pas ou appartient à une organisation que l'utilisateur ne peut pas voir.
Les erreurs de clé et de limite s'appliquent à tous les endpoints. Voir toutes les erreurs

RequêtecURLPHPJavaScript

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

Réponse200

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

Élément inexistant ou inaccessible404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}