| GET | /api/v1 | Returns an array of links for accessing version 1.0 of the triPOS API. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Errors | body | List<ApiError> | No | A list of errors that occurred. |
| HasErrors | body | bool | No | Indicates if there are errors. |
| Links | body | IEnumerable<ApiLink> | No | A list of resource links |
| Logs | body | List<string> | No | A list of log entries detailing what happened during the request. Ideally only used during development or troubleshooting as this can be quite verbose. |
| Type | body | string | No | The type of object held in the result. |
| Warnings | body | List<ApiWarning> | No | A list of warnings that occurred. |
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/GetServicesRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/json
Content-Length: length
{}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[{"href":"/api/v1/authorization","method":"POST","rel":"authorization"},{"href":"/api/v1/balance","method":"POST","rel":"balance"},{"href":"/api/v1/configuration","method":"GET","rel":"configuration"},{"href":"/api/v1/force","method":"GET","rel":"force"},{"href":"/api/v1/gift","method":"GET","rel":"gift"},{"href":"/api/v1/paymentAccount","method":"POST","rel":"paymentAccountCredit"},{"href":"/api/v1/passthrough","method":"POST","rel":"passthrough"},{"href":"/api/v1/refund","method":"POST","rel":"refund"},{"href":"/api/v1/refund/{paymentAccountId}","method":"POST","rel":"paymentAccountRefund"},{"href":"/api/v1/sale","method":"POST","rel":"sale"},{"href":"/api/v1/signature","method":"GET","rel":"signature"},{"href":"/api/v1/status","method":"GET","rel":"status"},{"href":"/api/v1/pinPadSelectionPrompt","method":"GET","rel":"pinPadSelectionPrompt"}],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}