Health Check

Service Url: GET /promotions/healthcheck

Parameters:

None

Request Body:

None

Response Body:

IHealthCheckResponse:

serviceStatus – READY or ERROR

databaseStatus – OK or FAIL

deploymentStatus – OK or FAIL

Remarks:

Tests to see if the service is ready to use. The response body is simply a summary of the checks performed, the HTTP status code is the important part.

Scenarios #

 Scenario Outcome Expected behaviour Status Code Response
1Service is deployed  200 
2Service is only partially deployed  500 
3Service is not deployed  404 

Example Request:

GET: http://localhost:8080/WebRestApi/rest/promotions/healthcheck
Content-Type: application/json

Example Response

{
    "serviceStatus": "READY",
    "databaseStatus": "OK",
    "deploymentStatus": "OK"
}

Contents
Go to Top