Api.Wrapi

<back to all web services

Heartbeat

The following routes are available for this service:
GET/heartbeat
HeartbeatResponse Parameters:
NameParameterData TypeRequiredDescription
AliveformboolNo
TimestampformstringNo
VersionformstringNo
MessageformstringNo
AbstractResponseBase Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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.

GET /heartbeat HTTP/1.1 
Host: wrapi-api.dev.hotelplan.co.uk 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"alive":false,"timestamp":"String","version":"String","message":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}