Terminal - Register web terminal device

API Url

Registers a web terminal device by storing the generated device ID on the TermDevice record for the authenticated session user.

POST

http://localhost:16010/ProMarkRESTweb/Terminal/register

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

Request example:

{
  "request": {
     "data": {
        "register": [
           {
              "terminalId": 1301,
              "deviceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
           }
        ]
     }
  }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
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": {}
   }
}

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.