TVs
GET /tv/code

Create a pairing code for a TV.

Request

      curl https://api.qminder.com/v1/tv/code
      

Response

{
  "statusCode": 200,
  "code": "PW3R",
  "secret": "75aa16d7923ac707cc302e1ce7c81e8a"
}
Response field Type Description
code String 4-character code for enduser to enter to the Dashboard
secret String Secret to use for checking the status of the pairing process
GET /tv/code/ value

Provides API key for the TV when it's paired.

Request

      curl https://api.qminder.com/v1/tv/code/PW3R?secret=75aa16d7923ac707c
      
Request parameter Description
secret Secret retrieved by creating the pairing code

Response

{
  "statusCode": 200,
  "status": "PAIRED",
  "id": 41078,
  "apiKey": "804ef75ba9b6b5264c96150b457f8f30"
}
Response field Type Description
status String "NOT_PAIRED" or "PAIRED"
id Number TV ID. Omitted when status is "NOT_PAIRED"
apiKey String API key. Omitted when status is "NOT_PAIRED"
location Number Location ID. Omitted when status is "NOT_PAIRED"
GET /tv/ id

Get a details of a TV.

Request

      curl https://api.qminder.com/v1/tv/41078
      -H "X-Qminder-REST-API-Key: KEY"
      

Response

{
  "statusCode": 200,
  "id": 41078,
  "name": "52 inch TV in Lobby",
  "theme": "standard"
}
Response field Type Description
id Number TV ID
name String Name of a TV
theme String Name of TV theme
layout String Name of TV layout
settings Object Settings of the TV, only included when applicable
settings.selectedLine Number The id of the line selected to be shown on this TV
GET /tv/ id /emptystate

Get empty state for the TV.

Request

	curl https://api.qminder.com/v1/tv/41078/emptystate
	-H "X-Qminder-REST-API-Key: KEY"
		
Request parameter Type Description
language String, Optional Chosen language for the empty state following the ISO 639-1 alpha-2 standard format. Defaults to "en" for English if not provided or an unsupported language is passed.

Response

{
  "statusCode": 200,
  "layout": "goodMorning",
  "message": "Good morning!"
}
Response field Type Description
layout String Name of the layout
message String Message to show in the chosen language.