Mercedes.Agency.Orchestration.API

<back to all web services

HealthRequest

The following routes are available for this service:
GET/status
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class HealthRequest implements IGet
    {
        
    }

    public static class HealthResponse
    {
        public HealthCheckReport Result = null;
        
        public HealthCheckReport getResult() { return Result; }
        public HealthResponse setResult(HealthCheckReport value) { this.Result = value; return this; }
    }

    public static class HealthCheckReport
    {
        public HealthStatus Status = null;
        public TimeSpan Duration = null;
        public String Version = null;
        public String BuildDate = null;
        public ArrayList<HealthCheckReportEntry> Entries = null;
        
        public HealthStatus getStatus() { return Status; }
        public HealthCheckReport setStatus(HealthStatus value) { this.Status = value; return this; }
        public TimeSpan getDuration() { return Duration; }
        public HealthCheckReport setDuration(TimeSpan value) { this.Duration = value; return this; }
        public String getVersion() { return Version; }
        public HealthCheckReport setVersion(String value) { this.Version = value; return this; }
        public String getBuildDate() { return BuildDate; }
        public HealthCheckReport setBuildDate(String value) { this.BuildDate = value; return this; }
        public ArrayList<HealthCheckReportEntry> getEntries() { return Entries; }
        public HealthCheckReport setEntries(ArrayList<HealthCheckReportEntry> value) { this.Entries = value; return this; }
    }

    public static enum HealthStatus
    {
        Unhealthy,
        Degraded,
        Healthy;
    }

    public static class HealthCheckReportEntry
    {
        public String Key = null;
        public String Description = null;
        public TimeSpan Duration = null;
        public HealthStatus Status = null;
        public String Error = null;
        
        public String getKey() { return Key; }
        public HealthCheckReportEntry setKey(String value) { this.Key = value; return this; }
        public String getDescription() { return Description; }
        public HealthCheckReportEntry setDescription(String value) { this.Description = value; return this; }
        public TimeSpan getDuration() { return Duration; }
        public HealthCheckReportEntry setDuration(TimeSpan value) { this.Duration = value; return this; }
        public HealthStatus getStatus() { return Status; }
        public HealthCheckReportEntry setStatus(HealthStatus value) { this.Status = value; return this; }
        public String getError() { return Error; }
        public HealthCheckReportEntry setError(String value) { this.Error = value; return this; }
    }

}

Java 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: prod-api-agency-orch-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>