triPOS REST API

<back to all web services

CreateIpLaneRequest

The following routes are available for this service:
POST/api/v1/configuration/lanes/ipCreates lane settings with options for IP Address and IP Port
BaseIpLaneRequest Parameters:
NameParameterData TypeRequiredDescription
IpbodyIpNoCollection of IP device properties.
CreateIpLaneResponse Parameters:
NameParameterData TypeRequiredDescription
LaneCreatedbodyboolNoTrue if lane was created successfully and false otherwise.
IpLane Parameters:
NameParameterData TypeRequiredDescription
IpbodyIpNoIP 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/CreateIpLaneRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/json
Content-Length: length

{"ip":{"address":"String","port":"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,"ip":{"address":"String","port":"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/ip/0","method":"GET","rel":"ipLane"},{"href":"/api/v1/configuration/lanes/ip/0","method":"PUT","rel":"ipLane"},{"href":"/api/v1/configuration/lanes/ip/0","method":"DELETE","rel":"ipLane"}],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}