Mercedes.VehicleManagement.API

<back to all web services

HealthRequest

The following routes are available for this service:
GET/status
const std = @import("std");

pub const HealthStatus = enum {
    Unhealthy,
    Degraded,
    Healthy,
};

pub const HealthCheckReportEntry = struct {
    key: ?[]const u8 = null,
    description: ?[]const u8 = null,
    duration: ?[]const u8 = null,
    status: ?HealthStatus = null,
    @"error": ?[]const u8 = null,
};

pub const HealthCheckReport = struct {
    status: ?HealthStatus = null,
    duration: ?[]const u8 = null,
    version: ?[]const u8 = null,
    buildDate: ?[]const u8 = null,
    entries: ?[]HealthCheckReportEntry = null,
};

pub const HealthResponse = struct {
    result: ?HealthCheckReport = null,
};

pub const HealthRequest = struct {};

Zig 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>