| POST | /api/ping | Test authentication and connectivity to API |
|---|
export class PingResponse
{
public message: string;
public glnNumber: string;
public constructor(init?: Partial<PingResponse>) { (Object as any).assign(this, init); }
}
/** @description Ping */
// @Api(Description="Ping")
// @ApiResponse(Description="Ping response message", StatusCode=200)
export class Ping
{
// @ApiMember(DataType="string", IsRequired=true, Name="Message", ParameterType="body")
public message: string;
public constructor(init?: Partial<Ping>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"message":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"message":"String","glnNumber":"String"}