Referência · Listas de reprodução

Ver uma lista

GET /v1/playlists/{uid}

Mostra uma lista de reprodução pelo uid, com os itens pela ordem de exibição e as TVs que utilizam a lista.

Parâmetro no endereço

Nome	Tipo	Descrição
`uid`	`string`	uid da lista de reprodução.

Campos da resposta

uid string: Identificador da lista de reprodução.
name string: Nome da lista.
organization object: Empresa da lista: uid e name.
total_time integer: Tempo total da lista, em segundos.
total_time_is_approximate boolean: true se o tempo total for uma estimativa.
items array: Itens da lista, pela ordem de exibição.
items[].position integer: Posição do item na lista.
items[].type string: file para ficheiro ou entertainment para conteúdo de entretenimento. Podem aparecer outros tipos.
items[].uid string: Identificador do ficheiro ou do conteúdo de entretenimento.
items[].display_time integer | null: Tempo de exibição definido no item, em segundos, ou null se não estiver definido.
items[].file object | null: Dados do ficheiro, com os mesmos campos de “Listar ficheiros”, ou null se o item não for um ficheiro ou se o utilizador não puder ver os ficheiros da empresa a que pertence.
tvs array: TVs que utilizam a lista (uid, name e organization). Só aparecem as TVs que o utilizador pode ver.

Erros possíveis

404 not_found O endpoint não existe, ou o item não existe ou pertence a uma empresa que o utilizador não pode ver.
Os erros de chave e de limite aplicam-se a todos os endpoints. Ver todos os erros

PedidocURLPHPJavaScript

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

Resposta200

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

Item inexistente ou sem acesso404

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