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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/Ping HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/csv
Content-Length: length

{"name":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"message":"String","serviceVersion":"String","messageVersion":"String"}