ASH.ResourceLibrary.WebApi

HealthCheckRequest

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

**HealthReport** Parameters:
Name	Parameter	Data Type	Required
Entries	form	IReadOnlyDictionary<string, HealthReportEntry>	No
ApplicationStatus	form	HealthStatus	No
Duration	form	TimeSpan	No

**HealthReportEntry** Parameters:
Name	Parameter	Data Type	Required
Status	form	HealthStatus	No
Description	form	string	No
Duration	form	TimeSpan	No
Exception	form	Exception	No
Data	form	IReadOnlyDictionary<string, Object>	No

**HealthStatus** Enum:
Name	Value
Healthy	0
Degraded	4
Unhealthy	8

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>