Viiteopas · TV:t

Hae TV

GET /v1/tvs/{uid}

Palauttaa yhden TV:n tunnisteen uid perusteella.

Polkuparametri

Nimi	Tyyppi	Kuvaus
`uid`	`string`	TV:n uid.

Vastauksen kentät

uid string: TV:n tunniste, sama kuin ohjauspaneelissa.
name string: TV:n nimi.
description string: TV:n kuvaus (voi olla tyhjä).
organization object: TV:n organisaatio: uid ja name.
playlist object | null: TV:n soittolista (uid ja name) tai null, jos soittolistaa ei ole.
status string: online, alert tai offline, kuten alla selitetään.
last_seen_at string | null: TV:n viimeisin yhteys alustaan tai null, jos TV ei ole koskaan muodostanut yhteyttä.
activated_at string | null: Milloin TV aktivoitiin.
app_version string: TV:hen asennetun sovelluksen versio.
os string: TV:n käyttöjärjestelmä, esimerkiksi android.
device object: Laitteen merkki (brand) ja malli (model), jos TV ilmoittaa ne.
timezone string | null: TV:n aikavyöhyke, esimerkiksi America/Sao_Paulo, tai null.

Miten tila lasketaan

online yhteys alle 3 minuuttia sitten, toisto käynnissä
alert yhteys 3–9 minuuttia sitten tai TV käynnistyy vielä
offline ei yhteyttä vähintään 10 minuuttiin tai ei yhteyttä koskaan

Sääntö on sama kuin ohjauspaneelin tilaväreissä.

Mahdolliset virheet

404 not_found Päätepistettä ei ole olemassa, tai kohdetta ei ole olemassa tai se kuuluu organisaatiolle, jota käyttäjä ei näe.
Avaimeen ja pyyntörajaan liittyvät virheet koskevat kaikkia päätepisteitä. Näytä kaikki virheet

PyyntöcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/tvs/c98cb8f9cc62887d1f6cf5693df9219c');
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/tvs/c98cb8f9cc62887d1f6cf5693df9219c', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

Vastaus200

{
  "data": {
    "uid": "c98cb8f9cc62887d1f6cf5693df9219c",
    "name": "Recepção",
    "description": "TV da entrada",
    "organization": {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro"
    },
    "playlist": {
      "uid": "e4da3b7fbbce2345d7772b0674a318d5",
      "name": "Lista principal"
    },
    "status": "online",
    "last_seen_at": "2026-11-03T14:32:10-03:00",
    "activated_at": "2025-03-12T09:41:05-03:00",
    "app_version": "3.12.84",
    "os": "android",
    "device": {
      "brand": "TCL",
      "model": "43P635"
    },
    "timezone": "America/Sao_Paulo"
  }
}

Kohdetta ei ole tai siihen ei ole oikeutta404

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