Billiecart API

<back to all web services

GetHealthCheckRequest

The following routes are available for this service:
GET/health
import 'package:servicestack/servicestack.dart';

abstract class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    String? embed;

    GetOperationUnTenanted({this.embed});
    GetOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        embed = json['embed'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'embed': embed
    };

    getTypeName() => "GetOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class GetHealthCheckResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? name;
    String? version;
    String? status;

    GetHealthCheckResponse({this.responseStatus,this.name,this.version,this.status});
    GetHealthCheckResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        name = json['name'];
        version = json['version'];
        status = json['status'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'name': name,
        'version': version,
        'status': status
    };

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

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

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "GetHealthCheckRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'GetHealthCheckResponse': TypeInfo(TypeOf.Class, create:() => GetHealthCheckResponse()),
    'GetHealthCheckRequest': TypeInfo(TypeOf.Class, create:() => GetHealthCheckRequest()),
});

Dart GetHealthCheckRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /health HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	name: String,
	version: String,
	status: String
}