ASH.ResourceLibrary.WebApi

HealthCheckRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Flags()
class HealthStatus(IntEnum):
    HEALTHY = 0
    DEGRADED = 4
    UNHEALTHY = 8


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HealthReportEntry:
    status: Optional[HealthStatus] = None
    description: Optional[str] = None
    duration: Optional[datetime.timedelta] = None
    exception: Optional[Exception] = None
    data: Optional[IReadOnlyDictionary[str, Object]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HealthReport:
    entries: Optional[IReadOnlyDictionary[str, HealthReportEntry]] = None
    application_status: Optional[HealthStatus] = None
    duration: Optional[datetime.timedelta] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HealthCheckRequest:
    pass

Python HealthCheckRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{}

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

{"entries":null,"applicationStatus":"Healthy","duration":"PT0S"}