Auth.Api

<back to all web services

HealthCheckDTOGet

The following routes are available for this service:
GET/healthchecks/hcReaquest API's helth check.
HealthCheckDTOGet Parameters:
NameParameterData TypeRequiredDescription
DBTimeoutqueryint?No
CacheTimeoutqueryint?No
HealthCheckDTOResponse Parameters:
NameParameterData TypeRequiredDescription
HealthChecksformList<HealthCheckResult>No
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusformApiResponseStatusNo
CodeformintNo
apiVersionformstringNo
appVersionformstringNo
ApiResponseStatus Enum:
OK
FAIL
Default
HealthCheckResult Parameters:
NameParameterData TypeRequiredDescription
CheckStatusformCheckStatusNo
CheckStatusCodeformstringNo
DescriptionformstringNo
ElapsedMsformlongNo
CheckStatus Enum:
Unknown
Unhealthy
Healthy
Warning

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.

GET /healthchecks/hc HTTP/1.1 
Host: auth.mepis.si 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HealthCheckDTOResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Common.Models.HealthChecks">
  <Code xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Common.Contracts.Api.Responses">0</Code>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Common.Contracts.Api.Responses">OK</Status>
  <apiVersion xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Common.Contracts.Api.Responses">String</apiVersion>
  <appVersion xmlns="http://schemas.datacontract.org/2004/07/Metronik.Core.Common.Contracts.Api.Responses">String</appVersion>
  <HealthChecks xmlns:d2p1="http://schemas.datacontract.org/2004/07/Metronik.Core.Common.Contracts.HealthChecks">
    <d2p1:HealthCheckResult>
      <d2p1:CheckStatus>Unknown</d2p1:CheckStatus>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:ElapsedMs>0</d2p1:ElapsedMs>
    </d2p1:HealthCheckResult>
  </HealthChecks>
</HealthCheckDTOResponse>