CMS Web Services - v4.0.6550.31684 [cms-a]

<back to all web services

PingHealth

Tests telnet, web services, and web application interfaces. Returns HTTP 200 if all pass, otherwise 4xx indicating an error.

The following routes are available for this service:
POST,GET/ping/health
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
WebServiceResponse 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.

POST /ping/health HTTP/1.1 
Host: perth.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}