Terminal - Create terminal session

API Url

Used when initiating the terminal session; will return the first dialogue.

POST

http://localhost:16010/ProMarkREST/rest/Terminal/sessions

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.
empNo`optional`	String	Employee number. If not sent, the employee defined on the portal account will be used.
terminal`optional`	Number	The terminal ID. If not sent, the terminal id defined on the webpart attribute will be used. Size range: `2-9999`

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
info	Object	Object containing terminal informations.
display	Number	Info display controller (0: Keep current messages, 1: Show new messages, 0: Clear messages). Size range: `0-2`
messages`optional`	Object[]	Collection of terminal messages.
order	Number	Message order.
text	String	Message body.
prompt	Object	Object containing the user prompt setup for the dialogue/transition.
defaultValue	String	The default value of the selection (autoselected value).
enableReader	Boolean	Specifies if the card reader is to be enabled
keys`optional`	Object[]	Object containing the keyboard setup. Only if prompt.type = 7.
backColor	String	Background color of the key in HEX.
enabled	Boolean	true = key is enabled.
foreColor	String	Color of label that is displayed on the key in HEX.
iconId	String	Icon id for the key.
id	String	Key ID. Only used together with keys.number.
label	String	Label to be displayed on the key.
number	Number	Key number. Only used together with keys.id.
order	Number	Key order/sequence. Used for rendering keys in the right order. Size range: `1-16`
mandatory	Boolean	If a value is mandatory or not.
message	String	A message text to be displayed above the user input.
options`optional`	Object[]	Object containing selectable values. Only if prompt.type = 2/3/5.
description	String	Item description.
order	Number	Item order.
tempMessage	String	A temporary messate to be displayed above the user input.
timeout	Number	Timeout in seconds of the transition, where 0 = no timeout.
title	String	The header title to be displayed.
type	Number	Prompt type (1: Standard input, 2: Select value from selection list, 3: Select value from selection list or enter id, 4: Select a date, 5: Input Yes/No, 6: Confirm (OK/Cancel), 7: Display keyboard, 8: Prompt for time (HHMM), 9: Password input, 10: Multi-line info-display without input, 11: Editor field, 12: Shift to JobDialog, 13: Download a file to display). Size range: `1-13`
state	Object[]	Object containing the session state. Must not be changed by the client and will not be further described.
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 for creating a new session that returns the first transition/dialogue:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "info": {
            "display": 1,
            "messages": [
               {
                  "order": 1,
                  "text": "John Doe"
               },
               {
                  "order": 2,
                  "text": "Working on ORDER_1"
               }
            ]
         },
         "prompt": {
            "type": 7,
            "title": "Select function",
            "message": "",
            "tempMessage": "",
            "defaultValue": "",
            "mandatory" : true,
            "timeout": 0,
            "keys": [
               {
                  "order": 1,
                  "id": "CI",
                  "number": 0,
                  "label": "Clock-&in",
                  "enabled": true,
                  "foreColor": "000000",
                  "backColor": "C0C0C0",
                  "iconId":"bell"
               },
               {
                  "order": 2,
                  "id": "CO",
                  "number": 0,
                  "label": "Clock-out",
                  "enabled": false,
                  "foreColor": "000000",
                  "backColor": "C0C0C0",
                  "iconId":"clock-in"
               },
               ...
            ]
         },
         "state": [...]
      },
      "errorCode": 0
      "errorMessage": ""
   }
}

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.