ASH.ResourceLibrary.WebApi

<back to all web services

HealthCheckRequest

The following routes are available for this service:
All Verbs/health

// @Flags()
// @DataContract
export enum HealthStatus
{
    Healthy = 0,
    Degraded = 4,
    Unhealthy = 8,
}

// @DataContract
export class HealthReportEntry
{
    // @DataMember
    public status?: HealthStatus;

    // @DataMember
    public description?: string;

    // @DataMember
    public duration?: string;

    // @DataMember
    public exception?: Exception;

    // @DataMember
    public data?: IReadOnlyDictionary<string, Object>;

    public constructor(init?: Partial<HealthReportEntry>) { (Object as any).assign(this, init); }
}

// @DataContract
export class HealthReport
{
    // @DataMember
    public entries?: IReadOnlyDictionary<string, HealthReportEntry>;

    // @DataMember
    public applicationStatus?: HealthStatus;

    // @DataMember
    public duration?: string;

    public constructor(init?: Partial<HealthReport>) { (Object as any).assign(this, init); }
}

export class HealthCheckRequest
{

    public constructor(init?: Partial<HealthCheckRequest>) { (Object as any).assign(this, init); }
}

TypeScript HealthCheckRequest 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.

POST /health HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HealthCheckRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.Services.HealthChecks.ServiceStack" />

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

<HealthReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ASH.Services.HealthChecks.DTO">
  <ApplicationStatus />
  <Duration>PT0S</Duration>
  <Entries i:nil="true" />
</HealthReport>