Referanse · TV-er

Hent én TV

GET /v1/tvs/{uid}

Viser en TV ut fra uid.

Stiparameter

Navn	Type	Beskrivelse
`uid`	`string`	uid for TV-en.

Felter i svaret

uid string: TV-ens ID, den samme som brukes i kontrollpanelet.
name string: TV-ens navn.
description string: TV-ens beskrivelse (kan være tom).
organization object: TV-ens organisasjon: uid og name.
playlist object | null: TV-ens spilleliste (uid og name), eller null hvis den ikke har noen.
status string: online, alert eller offline, som forklart nedenfor.
last_seen_at string | null: TV-ens siste kontakt med plattformen, eller null hvis den aldri har koblet til.
activated_at string | null: Når TV-en ble aktivert.
app_version string: Versjonen av appen som er installert på TV-en.
os string: TV-ens operativsystem, for eksempel android.
device object: Enhetens merke (brand) og modell (model), når TV-en oppgir dem.
timezone string | null: TV-ens tidssone, for eksempel America/Sao_Paulo, eller null.

Slik beregnes statusen

online kontakt for under 3 minutter siden, spiller av
alert kontakt for mellom 3 og 9 minutter siden, eller TV-en starter fortsatt opp
offline ingen kontakt på 10 minutter eller mer, eller aldri tilkoblet

Det er den samme regelen som for statusfargene i kontrollpanelet.

Mulige feil

404 not_found Endepunktet finnes ikke, eller elementet finnes ikke eller tilhører en organisasjon som brukeren ikke kan se.
Feil knyttet til nøkkel og grenser gjelder for alle endepunkter. Se alle feil

ForespørselcURLPHPJavaScript

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

Svar200

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

Element som ikke finnes eller ikke er tilgjengelig404

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