| POST | /ping | Use this for testing whether the service is up and for getting the service's version #. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | body | string | No | Optional parameter; use this to make sure the service is actually doing something. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | No | Should return 'Pong' + Name, if specified |
| ServiceVersion | form | string | No | The version of the service implementations |
| MessageVersion | form | string | No | The version of the message DTOs |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ping HTTP/1.1
Host: api.paylock.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"name":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"message":"String","serviceVersion":"String","messageVersion":"String"}