Mercedes.VehicleManagement.API

<back to all web services

HealthRequest

The following routes are available for this service:
GET/status
namespace Mercedes.SS.Plugins.HealthCheck.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type HealthStatus =
        | Unhealthy = 0
        | Degraded = 1
        | Healthy = 2

    [<AllowNullLiteral>]
    type HealthCheckReportEntry() = 
        member val Key:String = null with get,set
        member val Description:String = null with get,set
        member val Duration:TimeSpan = new TimeSpan() with get,set
        member val Status:HealthStatus = new HealthStatus() with get,set
        member val Error:String = null with get,set

    [<AllowNullLiteral>]
    type HealthCheckReport() = 
        member val Status:HealthStatus = new HealthStatus() with get,set
        member val Duration:TimeSpan = new TimeSpan() with get,set
        member val Version:String = null with get,set
        member val BuildDate:String = null with get,set
        member val Entries:ICollection<HealthCheckReportEntry> = null with get,set

    [<AllowNullLiteral>]
    type HealthResponse() = 
        member val Result:HealthCheckReport = null with get,set

    [<AllowNullLiteral>]
    type HealthRequest() = 
        interface IGet

F# HealthRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
	}
}