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 .xml suffix or ?format=xml

HTTP + 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: uat-api-vehicle-mgt-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>