Get terminal type details
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Get terminal type details

  • Dark
    Light
  • PDF

Article summary

Get
/terminal-types/{id}

Operation is used to retrieve full details of given terminal type id. Available from product version 3.4.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of terminal type

Responses
200

Terminal type

Expand All
object

Terminal type

availabilityEnd
string (date-time)

Availability end date and time

availabilityStart
string (date-time)

Availability start date and time

clazz
object (TerminalTypeClass)

Terminal type class

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "DEVICE, CTV_DEVICE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all contants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

connectors
integer

Connectors

fcode
integer

Feature code

id
integer

Primary key

listUrl
string (url)

Url to fetch all contants from terminal types

technology
object (TerminalTech)

Terminal type technology

availability_end_ts
string (date-time)

Ending date time for availability

availability_start_ts
string (date-time)

Beginning date time for availability

available
boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "TERMINAL_TECH" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all contants from this group

logical_txt
string

Logical textual value

num_value
number (float)

Numeric value

num_value2
number (float)

Numeric value 2

num_value3
number (float)

Numeric value 3

num_value4
number (float)

Numeric value 4

txt
string

Human readable textual representation

type
string

Type

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error


Was this article helpful?