| PUT | /api/v1/configuration/host | Update host settings. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AutoReversalRetryLimit | body | int | No | The number of times to automatically retry a reversal after a failed interaction with the host. This must be a value between 1-4 (Default=1) |
| Driver | body | HostDriverTypes? | No | Set to either 'Express' or 'Null'. Use Null to test without any connection to express.Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AutoReversalRetryLimit | body | int | No | The number of times to automatically retry a reversal after a failure |
| Driver | body | HostDriverTypes? | No | Set to either 'Express' or 'Null'. Use Null to test without any connection to express.Allowable Values
|
| HostUpdated | body | bool | No | Success value for updating host settings. |
| 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/UpdateHostConfigurationRequest HTTP/1.1
Host: booking.pufferdayspa.com
Content-Type: application/json
Content-Length: length
{"autoReversalRetryLimit":0,"driver":"Null"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"autoReversalRetryLimit":0,"driver":"Null","hostUpdated":false,"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[{"href":"/api/v1/configuration/host","method":"GET","rel":"hostConfiguration"},{"href":"/api/v1/configuration/host","method":"PUT","rel":"hostConfiguration"}],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}