tvpl.api

HealthCheckRequest

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

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


export class ServiceHealthResult
{
    public name: string;
    public status: string;
    public responseTimeMs: number;
    public message: string;

    public constructor(init?: Partial<ServiceHealthResult>) { (Object as any).assign(this, init); }
}

export class HealthCheckResponse
{
    public services: ServiceHealthResult[];
    public checkedAt: string;

    public constructor(init?: Partial<HealthCheckResponse>) { (Object as any).assign(this, init); }
}

export class HealthCheckRequest
{

    public constructor(init?: Partial<HealthCheckRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>