Starlite API

<back to all web services

SystemHealth

The following routes are available for this service:
POST/Services/SystemHealth
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Babel.Framework.ApiPlugins.SystemHealth
Imports Babel.Framework.ApiContext

Namespace Global

    Namespace Babel.Framework.ApiContext

        <DataContract>
        Public Partial Class ServiceRequestBase
            Implements IHasVersion
        End Class

        <DataContract>
        Public Partial Class ServiceResponseBase
            Public Sub New()
                ServiceDebugFields = New Dictionary(Of String, String)
            End Sub

            '''<Summary>
            '''Identifies whether the request executed successfully, however does not indicated requested data was found
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Identifies whether the request executed successfully, however does not indicated requested data was found")>
            Public Overridable Property IsSuccessful As Boolean

            '''<Summary>
            '''The status code returned by the service
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The status code returned by the service")>
            Public Overridable Property StatusCode As Integer

            '''<Summary>
            '''The status message returned by the service
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="The status message returned by the service")>
            Public Overridable Property StatusMessage As String

            <DataMember>
            <ApiMember(ExcludeInSchema:=true)>
            Public Overridable Property ServiceDebugFields As Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace Babel.Framework.ApiPlugins.SystemHealth

        Public Partial Class SystemHealth
            Inherits ServiceRequestBase
        End Class
    End Namespace
End Namespace

VB.NET SystemHealth 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.

POST /Services/SystemHealth HTTP/1.1 
Host: services.allianceassociationbank.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsSuccessful":false,"StatusCode":0,"StatusMessage":"String","ServiceDebugFields":{"ApiServiceHost":"AZW-AABWPW03","ApiServiceHostVersion":"2016.1.18.3"}}