triPOS REST API

<back to all web services

GetServerConfigurationRequest

The following routes are available for this service:
GET/api/v1/configuration/serverRetrieve server settings.
GetServerConfigurationResponse Parameters:
NameParameterData TypeRequiredDescription
ListeningPortbodystringNoListening port information of server settings.
ApiResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorsbodyList<ApiError>NoA list of errors that occurred.
HasErrorsbodyboolNoIndicates if there are errors.
LinksbodyIEnumerable<ApiLink>NoA list of resource links
LogsbodyList<string>NoA list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose.
TypebodystringNoThe type of object held in the result.
WarningsbodyList<ApiWarning>NoA list of warnings that occurred.

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/GetServerConfigurationRequest HTTP/1.1 
Host: booking.pufferdayspa.com 
Content-Type: application/xml
Content-Length: length

<getServerConfigurationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tripos.vantiv.com/2014/09/TriPos.Api" />

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

<getServerConfigurationResponse 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/server</href>
      <method>GET</method>
      <rel>serverConfiguration</rel>
    </link>
    <link>
      <href>/api/v1/configuration/server</href>
      <method>PUT</method>
      <rel>serverConfiguration</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>
  <listeningPort>String</listeningPort>
</getServerConfigurationResponse>