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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /status HTTP/1.1 Host: prod-api-auth-mb-dhc.rapp-customers.co.uk Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <HealthResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.SS.Plugins.HealthCheck.ServiceModel"> <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.SS.Plugins.HealthCheck.ServiceModel.Types"> <d2p1:BuildDate>String</d2p1:BuildDate> <d2p1:Duration>PT0S</d2p1:Duration> <d2p1:Entries i:nil="true" /> <d2p1:Status>Unhealthy</d2p1:Status> <d2p1:Version>String</d2p1:Version> </Result> </HealthResponse>