ConsumerApi

<back to all web services

LogFrontEndEventRequest

ConsumerBusinessBackoffice
The following routes are available for this service:
POST/log/event
<?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 LogFrontEndEventResponse implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $loggedAt=new DateTime()
    ) {
    }

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

class LogFrontEndEventRequest implements IPost, JsonSerializable
{
    public function __construct(
        // @Validate(Validator="NotEmpty")
        // @Validate(Validator="MaximumLength(256)")
        /** @var string */
        public string $location='',

        // @Validate(Validator="NotEmpty")
        // @Validate(Validator="MaximumLength(128)")
        /** @var string */
        public string $tag='',

        // @Validate(Validator="NotEmpty")
        // @Validate(Validator="MaximumLength(512)")
        /** @var string */
        public string $message=''
    ) {
    }

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

PHP LogFrontEndEventRequest 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 /log/event HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<LogFrontEndEventRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <Location>String</Location>
  <Message>String</Message>
  <Tag>String</Tag>
</LogFrontEndEventRequest>

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

<LogFrontEndEventResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <LoggedAt xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </LoggedAt>
</LogFrontEndEventResponse>