GET | /status |
---|
import Foundation
import ServiceStack
public class HealthRequest : IGet, Codable
{
required public init(){}
}
public class HealthResponse : Codable
{
public var result:HealthCheckReport
required public init(){}
}
public class HealthCheckReport : Codable
{
public var status:HealthStatus
@TimeSpan public var duration:TimeInterval
public var version:String
public var buildDate:String
public var entries:[HealthCheckReportEntry]
required public init(){}
}
public enum HealthStatus : String, Codable
{
case Unhealthy
case Degraded
case Healthy
}
public class HealthCheckReportEntry : Codable
{
public var key:String
public var Description:String
@TimeSpan public var duration:TimeInterval
public var status:HealthStatus
public var error:String
required public init(){}
}
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 /status HTTP/1.1 Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { result: { status: Unhealthy, duration: PT0S, version: String, buildDate: String } }