ASH.ResourceLibrary.WebApi

<back to all web services

HealthCheckRequest

The following routes are available for this service:
All Verbs/health
namespace ASH.Services.HealthChecks

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<Flags>]
    [<DataContract>]
    type HealthStatus =
        | Healthy = 0
        | Degraded = 4
        | Unhealthy = 8

    [<DataContract>]
    [<AllowNullLiteral>]
    type HealthReportEntry() = 
        [<DataMember>]
        member val Status:HealthStatus = new HealthStatus() with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Duration:TimeSpan = new TimeSpan() with get,set

        [<DataMember>]
        member val Exception:Exception = null with get,set

        [<DataMember>]
        member val Data:IReadOnlyDictionary<String, Object> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type HealthReport() = 
        [<DataMember>]
        member val Entries:IReadOnlyDictionary<String, HealthReportEntry> = null with get,set

        [<DataMember>]
        member val ApplicationStatus:HealthStatus = new HealthStatus() with get,set

        [<DataMember>]
        member val Duration:TimeSpan = new TimeSpan() with get,set

    [<AllowNullLiteral>]
    type HealthCheckRequest() = 
        class end

F# HealthCheckRequest DTOs

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.