Terminal - Create/Update registrations

API Url

Used for each user action and might return a new dialogue/transition if the registration selected has multiple "steps" required.

PUT
http://localhost:16010/ProMarkREST/web/Terminal/lan/registrations

Permissions: user

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    terminalObject
      dataString

Data from lan terminal.

      ipString

Terminal ip.

      stateString

Terminal state.

      statusGroupString

The grouping of terminals in the terminal status overview.

Request example:

{
"request": {
"data": {
"terminal":{
"data": "19\u00019",
"ip": "192.168.12.2",
"statusGroup": "ProMark on-premise Gateway",
"state": "{\"ttpiState\":[{\"Seq\":1,\"TermId\":\"9\",\"StateId\":1,\"StateDataOffset\":3, ..."
}
}
}
}

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    terminalObject
    terminalDataString[]

Data to terminal.

    terminalStateString

Terminal state.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Response example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"terminal": {
"data":[
"18\u000120240222\u000115:02:33"
]
"state": ""terminalState": "{\"response\":{\"data\":{\"terminalData\":[\"18\\u000120240222\\u000115:02..."
}
}
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.