Mercedes.Auth.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 .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: prod-api-auth-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>