ConsumerApi

StatusRequest

ConsumerBusinessBackoffice

The following routes are available for this service:
GET	/status	Verify that the service runs correctly.	The reply itself is a verification of success, and causes a warmup, furthermore contact with database and other required services is checked.

<?php namespace ConsumerApi;

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 StatusResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $databaseConnectionOk=null,
        /** @var bool|null */
        public ?bool $searchConnectionOk=null,
        /** @var string */
        public string $deployedVersion='',
        /** @var DateTime|null */
        public ?DateTime $deployedAt=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['databaseConnectionOk'])) $this->databaseConnectionOk = $o['databaseConnectionOk'];
        if (isset($o['searchConnectionOk'])) $this->searchConnectionOk = $o['searchConnectionOk'];
        if (isset($o['deployedVersion'])) $this->deployedVersion = $o['deployedVersion'];
        if (isset($o['deployedAt'])) $this->deployedAt = JsonConverters::from('DateTimeOffset', $o['deployedAt']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->databaseConnectionOk)) $o['databaseConnectionOk'] = $this->databaseConnectionOk;
        if (isset($this->searchConnectionOk)) $o['searchConnectionOk'] = $this->searchConnectionOk;
        if (isset($this->deployedVersion)) $o['deployedVersion'] = $this->deployedVersion;
        if (isset($this->deployedAt)) $o['deployedAt'] = JsonConverters::to('DateTimeOffset', $this->deployedAt);
        return empty($o) ? new class(){} : $o;
    }
}

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

PHP StatusRequest 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.

GET /status HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/xml

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

<StatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <DatabaseConnectionOk>false</DatabaseConnectionOk>
  <DeployedAt xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DeployedAt>
  <DeployedVersion>String</DeployedVersion>
  <SearchConnectionOk>false</SearchConnectionOk>
</StatusResponse>