DX STF Client API

Ping

Ping Requests

Ping

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

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Ping
    */
    @Api(Description="Ping")
    @ApiResponse(Description="Ping response message", StatusCode=200)
    public static class Ping
    {
        @ApiMember(DataType="string", IsRequired=true, Name="Message", ParameterType="body")
        public String message = null;
        
        public String getMessage() { return message; }
        public Ping setMessage(String value) { this.message = value; return this; }
    }

    public static class PingResponse
    {
        public String message = null;
        public String glnNumber = null;
        
        public String getMessage() { return message; }
        public PingResponse setMessage(String value) { this.message = value; return this; }
        public String getGlnNumber() { return glnNumber; }
        public PingResponse setGlnNumber(String value) { this.glnNumber = value; return this; }
    }

}

Java 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
}