Mercedes.VehicleManagement.API

<back to all web services

HealthRequest

The following routes are available for this service:
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) }
}

JavaScript HealthRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":{"status":"Unhealthy","duration":"PT0S","version":"String","buildDate":"String"}}