| POST | /api/ping | Test authentication and connectivity to API |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | body | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Message | form | string | Yes | |
| GlnNumber | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/ping HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"message":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"message":"String","glnNumber":"String"}