Billiecart API

<back to all web services

GetHealthCheckRequest

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

Namespace Global

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class GetOperationUnTenanted(Of TResponse)
            Implements IHasGetOptions
            Implements IGet
            Public Overridable Property Embed As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Health

        Public Partial Class GetHealthCheckRequest
            Inherits GetOperationUnTenanted(Of GetHealthCheckResponse)
        End Class

        Public Partial Class GetHealthCheckResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Name As String
            Public Overridable Property Version As String
            Public Overridable Property Status As String
        End Class
    End Namespace
End Namespace

VB.NET 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"}