| GET | /test | Simple test method to confirm the services are working |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Smtp | query | string | Yes | An email address a test email will be sent to |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Environment | form | string | Yes | |
| Tests | form | Dictionary<string, TestResult> | Yes | |
| WasSuccessful | form | bool | No | |
| DB | form | string | Yes | |
| DebugMode | form | bool | No | |
| ServerGC | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WasSuccessful | form | bool | No | |
| Description | 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.
GET /test HTTP/1.1 Host: returnit-api-dev.happen.zone Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Environment":"String","Tests":{"String":{"WasSuccessful":false,"Description":"String"}},"WasSuccessful":false,"DB":"String","DebugMode":false,"ServerGC":false}