Terminal - Get terminal status

API Url

Use it to return every terminal status

GET

http://localhost:16010/ProMarkRESTweb/Terminal/terminals

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Query parameters

Field	Type	Description
name`optional`	String	Name of terminal controller job. Records are filtered using this field.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
terminals	Object[]
bios	String	Terminal bios version
controller	String	The name of the terminal controller job
description	String	Terminal description
firmware	String	Terminal firmware
id	Number	The id of the terminal
ip	String	Terminal ip
mac	String	Terminal mac
pendingBoot	Boolean	Terminal requires restarting
serial	String	Terminal serial no.
status	Number	The status of the terminal. `0` Inactive `1` Loadfile missing `2` Loading `3` Active `5` Stopped by MNC2 due to an error in Hook In `8` Conflict `9` No connection to MNC2
type	Number	The type of the terminal
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
 "response": {
     "data": {
         "terminals": [
             {
                 "id": 2,
                 "type": 7,
                 "controller": "Kaba",
                 "status": 0,
                 "pendingBoot": true,
                 "description": "Mark Terminal",
                 "ip": "192.168.18.5",
                 "firmware": "4.00",
                 "bios": "1",
                 "mac": "02-CD-08-08-00-16",
                 "serial": "31415-02-0808-0022"
             },
             {
                 "id": 11,
                 "type": 7,
                 "controller": "Kaba",
                 "status": 0,
                 "pendingBoot": true,
                 "description": "LAN Test JAO",
                 "ip": "192.168.18.143",
                 "firmware": "4.11",
                 "bios": "1",
                 "mac": "02-CD-08-0A-01-17",
                 "serial": "31415-02-0810-0123"
             }
         ]
     }
 }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.