Platform API

AddLog

Add a log entry to the logging database

The following routes are available for this service:
POST	/api/logs

<?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};


// @ApiResponse(Description="Returns the log reference id and response status")
class AddLogResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $LogId='',
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

/** @description Add a log entry to the logging database */
// @Api(Description="Add a log entry to the logging database")
class AddLog implements JsonSerializable
{
    public function __construct(
        /** @description Log Category - Information = 1, Warning = 2, AppError = 3 */
        // @ApiMember(Description="Log Category - Information = 1, Warning = 2, AppError = 3")
        /** @var int */
        public int $Category=0,

        /** @var string|null */
        public ?string $LogEntry=null,
        /** @var string|null */
        public ?string $Browser=null,
        /** @var string */
        public string $PerspectiveSessionId=''
    ) {
    }

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

PHP AddLog 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 /api/logs HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Browser>String</Browser>
  <Category>0</Category>
  <LogEntry>String</LogEntry>
  <PerspectiveSessionId>00000000-0000-0000-0000-000000000000</PerspectiveSessionId>
</AddLog>

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

<AddLogResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <LogId>00000000-0000-0000-0000-000000000000</LogId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AddLogResponse>