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

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

namespace DX.STF.Application.ClientApi.Messages.Ping
{
    ///<summary>
    ///Ping
    ///</summary>
    [Api(Description="Ping")]
    [ApiResponse(Description="Ping response message", StatusCode=200)]
    public partial class Ping
    {
        [ApiMember(DataType="string", IsRequired=true, Name="Message", ParameterType="body")]
        public virtual string Message { get; set; }
    }

    public partial class PingResponse
    {
        public virtual string Message { get; set; }
        public virtual string GlnNumber { get; set; }
    }

}

C# 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
}