DX STF Client API

Ping

/ping

Test authentication and connectivity

The following routes are available for this service:
POST	/ping	Test authentication and connectivity to API

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DX.STF.Application.ClientApi.Messages.Ping

Namespace Global

    Namespace DX.STF.Application.ClientApi.Messages.Ping

        '''<Summary>
        '''Test authentication and connectivity
        '''</Summary>
        <Api(Description:="Test authentication and connectivity")>
        <ApiResponse(Description:="Ping response message", StatusCode:=200)>
        Public Partial Class Ping
            '''<Summary>
            '''Ping message text
            '''</Summary>
            <ApiMember(Description:="Ping message text", IsRequired:=true)>
            Public Overridable Property Message As String
        End Class

        Public Partial Class PingResponse
            Public Overridable Property Message As String
            Public Overridable Property GlnNumber As String
        End Class
    End Namespace
End Namespace

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

POST /ping HTTP/1.1 
Host: stf-api-uat.data-xchange.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	message: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	message: String,
	glnNumber: String
}