Mercedes.VehicleManagement.API

<back to all web services

HealthRequest

The following routes are available for this service:
GET/status

export enum HealthStatus
{
    Unhealthy = 'Unhealthy',
    Degraded = 'Degraded',
    Healthy = 'Healthy',
}

export class HealthCheckReportEntry
{
    public key?: string;
    public description?: string;
    public duration: string;
    public status: HealthStatus;
    public error?: string;

    public constructor(init?: Partial<HealthCheckReportEntry>) { (Object as any).assign(this, init); }
}

export class HealthCheckReport
{
    public status: HealthStatus;
    public duration: string;
    public version: string;
    public buildDate?: string;
    public entries?: HealthCheckReportEntry[];

    public constructor(init?: Partial<HealthCheckReport>) { (Object as any).assign(this, init); }
}

export class HealthResponse
{
    public result?: HealthCheckReport;

    public constructor(init?: Partial<HealthResponse>) { (Object as any).assign(this, init); }
}

export class HealthRequest implements IGet
{

    public constructor(init?: Partial<HealthRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
	}
}