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

"use strict";
export class PingResponse {
    /** @param {{message?:string,glnNumber?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    message;
    /** @type {string} */
    glnNumber;
}
export class Ping {
    /** @param {{message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    message;
}

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