Billiecart API

<back to all web services

GetHealthCheckRequest

The following routes are available for this service:
GET/health
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Health;
using Infrastructure.Api.Interfaces.ServiceOperations;

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class GetOperationUnTenanted<TResponse>
        : IHasGetOptions, IGet
    {
        public virtual string Embed { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Health
{
    public partial class GetHealthCheckRequest
        : GetOperationUnTenanted<GetHealthCheckResponse>
    {
    }

    public partial class GetHealthCheckResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string Name { get; set; }
        public virtual string Version { get; set; }
        public virtual string Status { get; set; }
    }

}

C# GetHealthCheckRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}