Get list of terminal types

28 Oct 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of terminal types

Updated on 28 Oct 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/terminal-types/

Operation is used to get a list of Terminal types. Available from product version 3.4.

Terminal types can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Query parameters

offset

integer

Offset to start returning results.

Minimum0

limit

integer

Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.

Minimum1

__any of the object fields__

string

Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
For numerics: gt, lt, gte, lte, isnull
For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++

orderby

string

Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

Responses

200

A result response object.

{
  "Next": "https://example.keypro.fi/api/v2/terminal-types/?limit=10&offset=10",
  "Previous": null,
  "Results": [
    {
      "availabilityEnd": null,
      "availabilityStart": null,
      "clazz": null,
      "connectors": 80,
      "fcode": "16782",
      "id": 10,
      "technology": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TERMINAL_TECH",
        "id": 210,
        "list_url": "https://example.keypro.fi/api/v2/txt_constants/groupname/TERMINAL_TECH/",
        "logical_txt": "Kupari",
        "num_value": 0.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Copper"
      },
      "type": "Pääte 80"
    },
    {
      "availabilityEnd": null,
      "availabilityStart": null,
      "clazz": null,
      "connectors": 50,
      "fcode": "16782",
      "id": 30,
      "technology": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "TERMINAL_TECH",
        "id": 210,
        "list_url": "https://example.keypro.fi/api/v2/txt_constants/groupname/TERMINAL_TECH/",
        "logical_txt": "Kupari",
        "num_value": 0.0,
        "num_value2": null,
        "num_value3": null,
        "num_value4": null,
        "txt": "Copper"
      },
      "type": "Pääte 50"
    }
  ],
  "Total": 2
}

Expand All

object

string (url)

Url to next page of Terminal types. Null if No next page exist

string (url)

Url to previous page of Terminal types. Null if No previous page exist

Results

Array of object (TerminalType)

List of fetched Terminal types

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

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

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

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

Total

integer

Total number of Terminal types

401

Authentication credentials are missing or invalid

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

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Get terminal type details