ConsumerApi

<back to all web services

StatusRequest

ConsumerBusinessBackoffice
The following routes are available for this service:
GET/statusVerify that the service runs correctly.The reply itself is a verification of success, and causes a warmup, furthermore contact with database and other required services is checked.
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ConsumerApi

Namespace Global

    Namespace ConsumerApi

        Public Partial Class StatusRequest
            Implements IGet
        End Class

        Public Partial Class StatusResponse
            Public Property DatabaseConnectionOk As Boolean
            Public Property SearchConnectionOk As Boolean
            Public Property DeployedVersion As String
            Public Property DeployedAt As DateTimeOffset?
        End Class
    End Namespace
End Namespace

VB.NET StatusRequest 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 /status HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	databaseConnectionOk: False,
	searchConnectionOk: False,
	deployedVersion: String,
	deployedAt: 0001-01-01T00:00:00.0000000+00:00
}