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 Foundation
import ServiceStack

/**
* Ping
*/
// @Api(Description="Ping")
// @ApiResponse(Description="Ping response message", StatusCode=200)
public class Ping : Codable
{
    // @ApiMember(DataType="string", IsRequired=true, Name="Message", ParameterType="body")
    public var message:String

    required public init(){}
}

public class PingResponse : Codable
{
    public var message:String
    public var glnNumber:String

    required public init(){}
}

Swift Ping 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 /api/ping HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"message":"String"}

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

{"message":"String","glnNumber":"String"}