Terminal - Get terminal controller jobs

API Url

Use it to return all terminal controller jobs

GET
http://localhost:16010/ProMarkRESTweb/Terminal/controllers

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    terminalControllersObject[]
      lastUpdatedNumber

Last updated time

      lastUpdatedStrString

Last updated string date

      nameString

The name of the terminal controller job

      statusNumber

The status of the terminal. 1 Inactive 2 Active

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"terminalControllers": [
{
"name": "Kaba Android",
"status": 1,
"lastUpdated": 842952602,
"lastUpdatedStr": "17/09/2020 09:30:02"
}
]
}
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.