GET | /api/v1/configuration/server | Retrieve server settings. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ListeningPort | body | string | No | Listening port information of server 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/GetServerConfigurationRequest 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 {"listeningPort":"String","_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[{"href":"/api/v1/configuration/server","method":"GET","rel":"serverConfiguration"},{"href":"/api/v1/configuration/server","method":"PUT","rel":"serverConfiguration"}],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}