Terminal - Web terminal heartbeat

API Url

Heartbeat ping for web terminals. Validates the device ID against the TermDevice record for the authenticated session user. Stores the ping timestamp and returns current terminal settings.

PUT

http://localhost:16010/ProMarkRESTweb/Terminal/heartbeat

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.

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
deviceId	String	Device identifier
terminalId	String	Terminal identifier
type`optional`	String	Terminal type (e.g. "Web Terminal")

Request example:

{
  "request": {
     "data": {
        "heartbeat": [
           {
              "terminalId": 1301,
              "deviceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
              "type": "Web Terminal"
           }
        ]
     }
  }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
terminalSettings	Object[]	Collection of terminal settings.
description	String	Terminal Settings description
disableEmpNo	Boolean	Disable employee no.
logLevel	Number	Terminal Settings log level
oneClickSelection	Boolean	One click selection
sendAsReader	Boolean	Send as reader
terminalId	String	Terminal identifier
terminalReaders	Object[]	Reader configurations
conversion	Number	Conversion (0=None, 1=DecToHex, 2=HexToDec)
length	Number	Length to read
paddedLength	Number	Target length after padding
startPosition	Number	Start position in input
transformation	Number	Transformation (0=None, 1=PadStart, 2=UnpadStart, 3=PadEnd, 4=UnpadEnd)
terminalSettingsId	String	Terminal Settings identifier
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": {
         "terminalSettings": [
            {
               "terminalId": "1301",
               "terminalSettingsId": "WEB01",
               "description": "Web Terminal Settings",
               "logLevel": 0,
               "disableEmpNo": false,
               "sendAsReader": false,
               "oneClickSelection": false,
               "terminalReaders": [
                  {
                     "startPosition": 0,
                     "length": 8,
                     "conversion": 0,
                     "transformation": 0,
                     "paddedLength": 0
                  }
               ]
            }
         ]
      }
   }
}

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.