tvpl.api

HealthCheckRequest

**Requires Authentication**
Required role:	super-admin

The following routes are available for this service:
GET	/system/health-check

namespace tvpl.api.ServiceModel

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

    [<AllowNullLiteral>]
    type ServiceHealthResult() = 
        member val Name:String = null with get,set
        member val Status:String = null with get,set
        member val ResponseTimeMs:Int64 = new Int64() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type HealthCheckResponse() = 
        member val Services:ResizeArray<ServiceHealthResult> = new ResizeArray<ServiceHealthResult>() with get,set
        member val CheckedAt:DateTime = new DateTime() 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 .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 /system/health-check HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: application/xml

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

<HealthCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/tvpl.api.ServiceModel">
  <CheckedAt>0001-01-01T00:00:00</CheckedAt>
  <Services>
    <ServiceHealthResult>
      <Message>String</Message>
      <Name>String</Name>
      <ResponseTimeMs>0</ResponseTimeMs>
      <Status>String</Status>
    </ServiceHealthResult>
  </Services>
</HealthCheckResponse>