| GET | /api/v1/status/triPOS/{echo} | Echos the text passed to triPOS. A successful echo indicates that triPOS is running and responding to requests | May be used as a regular-interval health status check. Max Interval: Every 2 minutes. If used with another API endpoint that is suitable for a regular-interval health check, max frequency should reflect all such calls as a group. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Echo | path | int | Yes | Text value that will be echoed back in the response. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Echo | form | string | No | Provided text to be echoed back in the response. |
| Type | form | string | No | The type of object held in the result. |
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 /json/reply/TriPosStatusRequest HTTP/1.1
Host: triposqa.vantiv.com
Content-Type: application/json
Content-Length: length
{"echo":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"echo":"String","_type":"String"}