ASH.ResourceLibrary.WebApi

HealthCheckRequest

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

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class HealthCheckRequest
{
}

@DataContract
open class HealthReport
{
    @DataMember
    var entries:IReadOnlyDictionary<String, HealthReportEntry>? = null

    @DataMember
    var applicationStatus:HealthStatus? = null

    @DataMember
    var duration:TimeSpan? = null
}

@DataContract
open class HealthReportEntry
{
    @DataMember
    var status:HealthStatus? = null

    @DataMember
    var description:String? = null

    @DataMember
    var duration:TimeSpan? = null

    @DataMember
    var exception:Exception? = null

    @DataMember
    @SerializedName("data") var Data:IReadOnlyDictionary<String, Object>? = null
}

@Flags()
@DataContract
enum class HealthStatus(val value:Int)
{
    @SerializedName("0") Healthy(0),
    @SerializedName("4") Degraded(4),
    @SerializedName("8") Unhealthy(8),
}

Kotlin 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>