Terminal - Log terminal ping information

API Url

Used to log terminal ping information

PUT
http://localhost:16010/ProMarkREST/rest/Terminal/pings

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.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    pingsObject[]

Collection of terminal ping information.

      biosoptionalString

Terminal BIOS version

      firmwareoptionalString

Terminal firmware

      idNumber

Terminal identifier

      ipoptionalString

Terminal IP address

      macoptionalString

Terminal MAC address

      typeoptionalString

Terminal Type

      descriptionoptionalString

Terminal Settings description

      disableEmpNooptionalBoolean

Terminal Settings disable employee no.

      logLeveloptionalNumber

Terminal Settings log level

      oneClickSelectionoptionalBoolean

Terminal Settings one click selection

      sendAsReaderoptionalBoolean

Terminal Settings send as reader

      terminalIdoptionalNumber

Terminal identifier

      terminalSettingsIdoptionalString

Terminal Settings Identifier

Request example for terminal ping information log put:

{
"request":{
"data": {
"pings": [
{
"id": "1301",
"type": "KABA Android"
}
]
}}}

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    terminalSettingsObject[]

Collection of terminal settings.

  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": {
"terminalSettings": []
},
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.