tvpl.api

HealthCheckRequest

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

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

import 'package:servicestack/servicestack.dart';

class ServiceHealthResult implements IConvertible
{
    String? name;
    String? status;
    int? responseTimeMs;
    String? message;
    String? host;

    ServiceHealthResult({this.name,this.status,this.responseTimeMs,this.message,this.host});
    ServiceHealthResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        name = json['name'];
        status = json['status'];
        responseTimeMs = json['responseTimeMs'];
        message = json['message'];
        host = json['host'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'name': name,
        'status': status,
        'responseTimeMs': responseTimeMs,
        'message': message,
        'host': host
    };

    getTypeName() => "ServiceHealthResult";
    TypeContext? context = _ctx;
}

class HealthCheckResponse implements IConvertible
{
    List<ServiceHealthResult>? services;
    DateTime? checkedAt;
    HealthCheckResponse? backgroundServices;

    HealthCheckResponse({this.services,this.checkedAt,this.backgroundServices});
    HealthCheckResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        services = JsonConverters.fromJson(json['services'],'List<ServiceHealthResult>',context!);
        checkedAt = JsonConverters.fromJson(json['checkedAt'],'DateTime',context!);
        backgroundServices = JsonConverters.fromJson(json['backgroundServices'],'HealthCheckResponse',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'services': JsonConverters.toJson(services,'List<ServiceHealthResult>',context!),
        'checkedAt': JsonConverters.toJson(checkedAt,'DateTime',context!),
        'backgroundServices': JsonConverters.toJson(backgroundServices,'HealthCheckResponse',context!)
    };

    getTypeName() => "HealthCheckResponse";
    TypeContext? context = _ctx;
}

class HealthCheckRequest implements IConvertible
{
    HealthCheckRequest();
    HealthCheckRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "HealthCheckRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'qlcn_api.vsmlab.vn', types: <String, TypeInfo> {
    'ServiceHealthResult': TypeInfo(TypeOf.Class, create:() => ServiceHealthResult()),
    'HealthCheckResponse': TypeInfo(TypeOf.Class, create:() => HealthCheckResponse()),
    'List<ServiceHealthResult>': TypeInfo(TypeOf.Class, create:() => <ServiceHealthResult>[]),
    'HealthCheckRequest': TypeInfo(TypeOf.Class, create:() => HealthCheckRequest()),
});

Dart 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: 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>