Mercedes.VehicleManagement.API

<back to all web services

HealthRequest

The following routes are available for this service:
GET/status
HealthResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformHealthCheckReportNo
HealthCheckReport Parameters:
NameParameterData TypeRequiredDescription
StatusformHealthStatusNo
DurationformTimeSpanNo
VersionformstringYes
BuildDateformstringNo
EntriesformICollection<HealthCheckReportEntry>No
HealthStatus Enum:
Unhealthy
Degraded
Healthy
HealthCheckReportEntry Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
DescriptionformstringNo
DurationformTimeSpanNo
StatusformHealthStatusNo
ErrorformstringNo

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>