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

// @ts-nocheck

export class PingResponse
{
    public message: string;
    public glnNumber: string;

    public constructor(init?: Partial<PingResponse>) { (Object as any).assign(this, init); }
}

/** @description Test authentication and connectivity */
// @Api(Description="Test authentication and connectivity")
// @ApiResponse(Description="Ping response message", StatusCode=200)
export class Ping
{
    /** @description Ping message text */
    // @ApiMember(Description="Ping message text", IsRequired=true)
    public message: string;

    public constructor(init?: Partial<Ping>) { (Object as any).assign(this, init); }
}

TypeScript 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 /ping HTTP/1.1 
Host: stf-api-uat.data-xchange.com 
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
}