ASH.ResourceLibrary.WebApi

<back to all web services

HealthCheckRequest

The following routes are available for this service:
All Verbs/health
HealthReport Parameters:
NameParameterData TypeRequiredDescription
EntriesformIReadOnlyDictionary<string, HealthReportEntry>No
ApplicationStatusformHealthStatusNo
DurationformTimeSpanNo
HealthReportEntry Parameters:
NameParameterData TypeRequiredDescription
StatusformHealthStatusNo
DescriptionformstringNo
DurationformTimeSpanNo
ExceptionformExceptionNo
DataformIReadOnlyDictionary<string, Object>No
HealthStatus Enum:
NameValue
Healthy0
Degraded4
Unhealthy8

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'HealthReport' using the custom 'csv' filter}No parameterless constructor defined for this object.