BootView WebApi

<back to all web services

Ping

The following routes are available for this service:
POST/pingUse this for testing whether the service is up and for getting the service's version #.
Ping Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNoOptional parameter; use this to make sure the service is actually doing something.
PingResponse Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNoShould return 'Pong' + Name, if specified
ServiceVersionformstringNoThe version of the service implementations
MessageVersionformstringNoThe version of the message DTOs

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/Ping HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<Ping xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Name>String</Name>
</Ping>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <Message>String</Message>
  <MessageVersion>String</MessageVersion>
  <ServiceVersion>String</ServiceVersion>
</PingResponse>