Mercedes.VehicleManagement.API

<back to all web services

HealthRequest

The following routes are available for this service:
GET/status
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Mercedes.SS.Plugins.HealthCheck.ServiceModel;
using Mercedes.SS.Plugins.HealthCheck.ServiceModel.Types;
using Microsoft.Extensions.Diagnostics.HealthChecks;

namespace Mercedes.SS.Plugins.HealthCheck.ServiceModel
{
    public partial class HealthRequest
        : IGet
    {
    }

    public partial class HealthResponse
    {
        public virtual HealthCheckReport Result { get; set; }
    }

}

namespace Mercedes.SS.Plugins.HealthCheck.ServiceModel.Types
{
    public partial class HealthCheckReport
    {
        public virtual HealthStatus Status { get; set; }
        public virtual TimeSpan Duration { get; set; }
        public virtual string Version { get; set; }
        public virtual string BuildDate { get; set; }
        public virtual ICollection<HealthCheckReportEntry> Entries { get; set; }
    }

    public partial class HealthCheckReportEntry
    {
        public virtual string Key { get; set; }
        public virtual string Description { get; set; }
        public virtual TimeSpan Duration { get; set; }
        public virtual HealthStatus Status { get; set; }
        public virtual string Error { get; set; }
    }

}

namespace Microsoft.Extensions.Diagnostics.HealthChecks
{
    public enum HealthStatus
    {
        Unhealthy,
        Degraded,
        Healthy,
    }

}

C# 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>