Billiecart API

<back to all web services

GetHealthCheckRequest

The following routes are available for this service:
GET/health
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetHealthCheckRequest extends GetOperationUnTenanted<GetHealthCheckResponse>
    {
        
    }

    public static class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
    {
        public String embed = null;
        
        public String getEmbed() { return embed; }
        public GetOperationUnTenanted<TResponse> setEmbed(String value) { this.embed = value; return this; }
    }

    public static class GetHealthCheckResponse
    {
        public ResponseStatus responseStatus = null;
        public String name = null;
        public String version = null;
        public String status = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetHealthCheckResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getName() { return name; }
        public GetHealthCheckResponse setName(String value) { this.name = value; return this; }
        public String getVersion() { return version; }
        public GetHealthCheckResponse setVersion(String value) { this.version = value; return this; }
        public String getStatus() { return status; }
        public GetHealthCheckResponse setStatus(String value) { this.status = value; return this; }
    }

}

Java 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
}