| GET | /test | Simple test method to confirm the services are working |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Smtp | query | string | No | An email address a test email will be sent to |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Environment | form | string | No | |
| Tests | form | Dictionary<string, TestResult> | No | |
| WasSuccessful | form | bool | No | |
| DB | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WasSuccessful | form | bool | No | |
| Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /test HTTP/1.1 Host: cochraneplus-api-dev.happen.zone Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
environment: String,
tests:
{
String:
{
wasSuccessful: False,
description: String
}
},
wasSuccessful: False,
db: String
}