GET | /status |
---|
<?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};
enum HealthStatus : string
{
case Unhealthy = 'Unhealthy';
case Degraded = 'Degraded';
case Healthy = 'Healthy';
}
class HealthCheckReportEntry implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $key=null,
/** @var string|null */
public ?string $description=null,
/** @var DateInterval|null */
public ?DateInterval $duration=null,
/** @var HealthStatus|null */
public ?HealthStatus $status=null,
/** @var string|null */
public ?string $error=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['key'])) $this->key = $o['key'];
if (isset($o['description'])) $this->description = $o['description'];
if (isset($o['duration'])) $this->duration = JsonConverters::from('DateInterval', $o['duration']);
if (isset($o['status'])) $this->status = JsonConverters::from('HealthStatus', $o['status']);
if (isset($o['error'])) $this->error = $o['error'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->key)) $o['key'] = $this->key;
if (isset($this->description)) $o['description'] = $this->description;
if (isset($this->duration)) $o['duration'] = JsonConverters::to('DateInterval', $this->duration);
if (isset($this->status)) $o['status'] = JsonConverters::to('HealthStatus', $this->status);
if (isset($this->error)) $o['error'] = $this->error;
return empty($o) ? new class(){} : $o;
}
}
class HealthCheckReport implements JsonSerializable
{
public function __construct(
/** @var HealthStatus|null */
public ?HealthStatus $status=null,
/** @var DateInterval|null */
public ?DateInterval $duration=null,
/** @var string */
public string $version='',
/** @var string|null */
public ?string $buildDate=null,
/** @var array<HealthCheckReportEntry>|null */
public ?array $entries=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['status'])) $this->status = JsonConverters::from('HealthStatus', $o['status']);
if (isset($o['duration'])) $this->duration = JsonConverters::from('DateInterval', $o['duration']);
if (isset($o['version'])) $this->version = $o['version'];
if (isset($o['buildDate'])) $this->buildDate = $o['buildDate'];
if (isset($o['entries'])) $this->entries = JsonConverters::fromArray('HealthCheckReportEntry', $o['entries']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->status)) $o['status'] = JsonConverters::to('HealthStatus', $this->status);
if (isset($this->duration)) $o['duration'] = JsonConverters::to('DateInterval', $this->duration);
if (isset($this->version)) $o['version'] = $this->version;
if (isset($this->buildDate)) $o['buildDate'] = $this->buildDate;
if (isset($this->entries)) $o['entries'] = JsonConverters::toArray('HealthCheckReportEntry', $this->entries);
return empty($o) ? new class(){} : $o;
}
}
class HealthResponse implements JsonSerializable
{
public function __construct(
/** @var HealthCheckReport|null */
public ?HealthCheckReport $result=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['result'])) $this->result = JsonConverters::from('HealthCheckReport', $o['result']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->result)) $o['result'] = JsonConverters::to('HealthCheckReport', $this->result);
return empty($o) ? new class(){} : $o;
}
}
class HealthRequest implements IGet, JsonSerializable
{
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /status HTTP/1.1 Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <HealthResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.SS.Plugins.HealthCheck.ServiceModel"> <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.SS.Plugins.HealthCheck.ServiceModel.Types"> <d2p1:BuildDate>String</d2p1:BuildDate> <d2p1:Duration>PT0S</d2p1:Duration> <d2p1:Entries i:nil="true" /> <d2p1:Status>Unhealthy</d2p1:Status> <d2p1:Version>String</d2p1:Version> </Result> </HealthResponse>