| POST | /api/ping | Test authentication and connectivity to API |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class PingResponse implements JsonSerializable
{
public function __construct(
/** @var string */
public string $message='',
/** @var string */
public string $glnNumber=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['message'])) $this->message = $o['message'];
if (isset($o['glnNumber'])) $this->glnNumber = $o['glnNumber'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->message)) $o['message'] = $this->message;
if (isset($this->glnNumber)) $o['glnNumber'] = $this->glnNumber;
return empty($o) ? new class(){} : $o;
}
}
/** @description Ping */
// @Api(Description="Ping")
// @ApiResponse(Description="Ping response message", StatusCode=200)
class Ping implements JsonSerializable
{
public function __construct(
// @ApiMember(DataType="string", IsRequired=true, Name="Message", ParameterType="body")
/** @var string */
public string $message=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['message'])) $this->message = $o['message'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->message)) $o['message'] = $this->message;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}