DX STF Client API

<back to all web services

Ping

Ping Requests

Ping

Requires Authentication
The following routes are available for this service:
POST/api/pingTest authentication and connectivity to API
namespace DX.STF.Application.ClientApi.Messages.Ping

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

    [<AllowNullLiteral>]
    type PingResponse() = 
        member val Message:String = null with get,set
        member val GlnNumber:String = null with get,set

    ///<summary>
    ///Ping
    ///</summary>
    [<Api(Description="Ping")>]
    [<ApiResponse(Description="Ping response message", StatusCode=200)>]
    [<AllowNullLiteral>]
    type Ping() = 
        [<ApiMember(DataType="string", IsRequired=true, Name="Message", ParameterType="body")>]
        member val Message:String = null with get,set

F# 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 /api/ping HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
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
}