GET | /status |
---|
"use strict";
/** @typedef {'Unhealthy'|'Degraded'|'Healthy'} */
export var HealthStatus;
(function (HealthStatus) {
HealthStatus["Unhealthy"] = "Unhealthy"
HealthStatus["Degraded"] = "Degraded"
HealthStatus["Healthy"] = "Healthy"
})(HealthStatus || (HealthStatus = {}));
export class HealthCheckReportEntry {
/** @param {{key?:string,description?:string,duration?:string,status?:HealthStatus,error?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
key;
/** @type {?string} */
description;
/** @type {string} */
duration;
/** @type {HealthStatus} */
status;
/** @type {?string} */
error;
}
export class HealthCheckReport {
/** @param {{status?:HealthStatus,duration?:string,version?:string,buildDate?:string,entries?:HealthCheckReportEntry[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {HealthStatus} */
status;
/** @type {string} */
duration;
/** @type {string} */
version;
/** @type {?string} */
buildDate;
/** @type {?HealthCheckReportEntry[]} */
entries;
}
export class HealthResponse {
/** @param {{result?:HealthCheckReport}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?HealthCheckReport} */
result;
}
export class HealthRequest {
constructor(init) { Object.assign(this, init) }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>