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

import Foundation
import ServiceStack

/**
* Test authentication and connectivity
*/
// @Api(Description="Test authentication and connectivity")
// @ApiResponse(Description="Ping response message", StatusCode=200)
public class Ping : Codable
{
    /**
    * Ping message text
    */
    // @ApiMember(Description="Ping message text", IsRequired=true)
    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 .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"message":"String"}

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

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