tvpl.api

HealthCheckRequest

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

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

**HealthCheckResponse** Parameters:
Name	Parameter	Data Type	Required
Services	form	List<ServiceHealthResult>	Yes
CheckedAt	form	DateTime	No
BackgroundServices	form	HealthCheckResponse	Yes

**ServiceHealthResult** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
Status	form	string	Yes
ResponseTimeMs	form	long	No
Message	form	string	Yes
Host	form	string	Yes

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: qlcn-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">
  <BackgroundServices>
    <BackgroundServices>
      <BackgroundServices>
        <BackgroundServices i:nil="true" />
        <CheckedAt>0001-01-01T00:00:00</CheckedAt>
        <Services>
          <ServiceHealthResult>
            <Host>String</Host>
            <Message>String</Message>
            <Name>String</Name>
            <ResponseTimeMs>0</ResponseTimeMs>
            <Status>String</Status>
          </ServiceHealthResult>
        </Services>
      </BackgroundServices>
      <CheckedAt>0001-01-01T00:00:00</CheckedAt>
      <Services>
        <ServiceHealthResult>
          <Host>String</Host>
          <Message>String</Message>
          <Name>String</Name>
          <ResponseTimeMs>0</ResponseTimeMs>
          <Status>String</Status>
        </ServiceHealthResult>
      </Services>
    </BackgroundServices>
    <CheckedAt>0001-01-01T00:00:00</CheckedAt>
    <Services>
      <ServiceHealthResult>
        <Host>String</Host>
        <Message>String</Message>
        <Name>String</Name>
        <ResponseTimeMs>0</ResponseTimeMs>
        <Status>String</Status>
      </ServiceHealthResult>
    </Services>
  </BackgroundServices>
  <CheckedAt>0001-01-01T00:00:00</CheckedAt>
  <Services>
    <ServiceHealthResult>
      <Host>String</Host>
      <Message>String</Message>
      <Name>String</Name>
      <ResponseTimeMs>0</ResponseTimeMs>
      <Status>String</Status>
    </ServiceHealthResult>
  </Services>
</HealthCheckResponse>