Billiecart API

<back to all web services

GetHealthCheckRequest

The following routes are available for this service:
GET/health
namespace Infrastructure.Api.Interfaces.ServiceOperations

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GetHealthCheckResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Name:String = null with get,set
        member val Version:String = null with get,set
        member val Status:String = null with get,set

    [<AllowNullLiteral>]
    type GetHealthCheckRequest() = 
        inherit GetOperationUnTenanted<GetHealthCheckResponse>()

    [<AllowNullLiteral>]
    type GetOperationUnTenanted<'TResponse>() = 
        interface IGet
        member val Embed:String = null with get,set

F# 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"}