triPOS REST API

<back to all web services

CreateSerialLaneRequest

The following routes are available for this service:
POST/api/v1/configuration/lanes/serialCreates lane settings with options for serial device.
BaseSerialLaneRequest Parameters:
NameParameterData TypeRequiredDescription
SerialbodySerialNoCollection of Serial device properties
CreateSerialLaneResponse Parameters:
NameParameterData TypeRequiredDescription
LaneCreatedbodyboolNoTrue if lane was created successfully and false otherwise.
SerialLane Parameters:
NameParameterData TypeRequiredDescription
SerialbodySerialNoSerial device properties.

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/CreateSerialLaneRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/json
Content-Length: length

{"serial":{"comPort":"String","dataBits":"String","parity":"String","stopBits":"None","handshake":"None","baudRate":"String"},"description":"String","driver":"Null","initializeOnStartup":"String","isContactlessMsdEntryAllowed":"String","isManualEntryAllowed":"String","laneId":0,"terminalId":"String","terminalType":"Unknown"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"laneCreated":false,"serial":{"comPort":"String","dataBits":"String","parity":"String","stopBits":"None","handshake":"None","baudRate":"String"},"laneId":0,"description":"String","initializeOnStartup":"String","terminalType":"Unknown","driver":"Null","isManualEntryAllowed":"String","isContactlessMsdEntryAllowed":"String","terminalId":"String","_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[{"href":"/api/v1/configuration/lanes/serial/0","method":"GET","rel":"serialLane"},{"href":"/api/v1/configuration/lanes/serial/0","method":"PUT","rel":"serialLane"},{"href":"/api/v1/configuration/lanes/serial/0","method":"DELETE","rel":"serialLane"}],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}