Tiptopweb.MojoPortal.Api

HealthCheck

The following routes are available for this service:
All Verbs	/health
All Verbs	/api/healthcheck

<?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 HealthCheckResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $Service=null,
        /** @var string|null */
        public ?string $Timestamp=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['Service'])) $this->Service = $o['Service'];
        if (isset($o['Timestamp'])) $this->Timestamp = $o['Timestamp'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->Service)) $o['Service'] = $this->Service;
        if (isset($this->Timestamp)) $o['Timestamp'] = $this->Timestamp;
        return empty($o) ? new class(){} : $o;
    }
}

class HealthCheck implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP HealthCheck DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /health HTTP/1.1 
Host: mds-api.mojomotorcycles.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HealthCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tiptopweb.MojoPortal.Api.ServiceModel" />

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HealthCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tiptopweb.MojoPortal.Api.ServiceModel">
  <Service>String</Service>
  <Status>String</Status>
  <Timestamp>String</Timestamp>
</HealthCheckResponse>