triPOS REST API

CreateSerialLaneRequest

The following routes are available for this service:
POST	/api/v1/configuration/lanes/serial	Creates lane settings with options for serial device.

**BaseSerialLaneRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Serial	body	Serial	No	Collection of Serial device properties

**CreateSerialLaneResponse** Parameters:
Name	Parameter	Data Type	Required	Description
LaneCreated	body	bool	No	True if lane was created successfully and false otherwise.

**SerialLane** Parameters:
Name	Parameter	Data Type	Required	Description
Serial	body	Serial	No	Serial device properties.

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

HTTP + XML

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

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

<createSerialLaneRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <description>String</description>
  <driver>Null</driver>
  <initializeOnStartup>String</initializeOnStartup>
  <isContactlessMsdEntryAllowed>String</isContactlessMsdEntryAllowed>
  <isManualEntryAllowed>String</isManualEntryAllowed>
  <laneId>0</laneId>
  <terminalId>String</terminalId>
  <terminalType>Unknown</terminalType>
  <serial>
    <baudRate>String</baudRate>
    <comPort>String</comPort>
    <dataBits>String</dataBits>
    <handshake>None</handshake>
    <parity>String</parity>
    <stopBits>None</stopBits>
  </serial>
</createSerialLaneRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<createSerialLaneResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api">
  <_errors>
    <error>
      <developerMessage>String</developerMessage>
      <errorType>String</errorType>
      <exceptionMessage>String</exceptionMessage>
      <exceptionTypeFullName>String</exceptionTypeFullName>
      <exceptionTypeShortName>String</exceptionTypeShortName>
      <userMessage>String</userMessage>
    </error>
  </_errors>
  <_hasErrors>true</_hasErrors>
  <_links>
    <link>
      <href>/api/v1/configuration/lanes/serial/0</href>
      <method>GET</method>
      <rel>serialLane</rel>
    </link>
    <link>
      <href>/api/v1/configuration/lanes/serial/0</href>
      <method>PUT</method>
      <rel>serialLane</rel>
    </link>
    <link>
      <href>/api/v1/configuration/lanes/serial/0</href>
      <method>DELETE</method>
      <rel>serialLane</rel>
    </link>
  </_links>
  <_logs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </_logs>
  <_type>String</_type>
  <_warnings>
    <warning>
      <developerMessage>String</developerMessage>
      <userMessage>String</userMessage>
    </warning>
  </_warnings>
  <description>String</description>
  <driver>Null</driver>
  <initializeOnStartup>String</initializeOnStartup>
  <isContactlessMsdEntryAllowed>String</isContactlessMsdEntryAllowed>
  <isManualEntryAllowed>String</isManualEntryAllowed>
  <laneId>0</laneId>
  <terminalId>String</terminalId>
  <terminalType>Unknown</terminalType>
  <serial>
    <baudRate>String</baudRate>
    <comPort>String</comPort>
    <dataBits>String</dataBits>
    <handshake>None</handshake>
    <parity>String</parity>
    <stopBits>None</stopBits>
  </serial>
  <laneCreated>false</laneCreated>
</createSerialLaneResponse>