Trendsic Platform Service

<back to all web services

OrgAuditTrailRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/audit
<?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 RecordAuditDto implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $EventId=0,
        /** @var string|null */
        public ?string $RecordKey=null,
        /** @var string|null */
        public ?string $Verb=null,
        /** @var string|null */
        public ?string $WhoLabel=null,
        /** @var string|null */
        public ?string $Detail=null,
        /** @var string|null */
        public ?string $WhenLabel=null,
        /** @var string|null */
        public ?string $EventRef=null,
        /** @var string|null */
        public ?string $ActorKind=null,
        /** @var string|null */
        public ?string $AuthContext=null,
        /** @var string|null */
        public ?string $Ip=null,
        /** @var string|null */
        public ?string $Device=null,
        /** @var string|null */
        public ?string $RelKind=null,
        /** @var string|null */
        public ?string $RelKey=null,
        /** @var string|null */
        public ?string $WhenFull=null,
        /** @var int */
        public int $AgeDays=0,
        /** @var string|null */
        public ?string $RecordName=null,
        /** @var string|null */
        public ?string $SeriesName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['EventId'])) $this->EventId = $o['EventId'];
        if (isset($o['RecordKey'])) $this->RecordKey = $o['RecordKey'];
        if (isset($o['Verb'])) $this->Verb = $o['Verb'];
        if (isset($o['WhoLabel'])) $this->WhoLabel = $o['WhoLabel'];
        if (isset($o['Detail'])) $this->Detail = $o['Detail'];
        if (isset($o['WhenLabel'])) $this->WhenLabel = $o['WhenLabel'];
        if (isset($o['EventRef'])) $this->EventRef = $o['EventRef'];
        if (isset($o['ActorKind'])) $this->ActorKind = $o['ActorKind'];
        if (isset($o['AuthContext'])) $this->AuthContext = $o['AuthContext'];
        if (isset($o['Ip'])) $this->Ip = $o['Ip'];
        if (isset($o['Device'])) $this->Device = $o['Device'];
        if (isset($o['RelKind'])) $this->RelKind = $o['RelKind'];
        if (isset($o['RelKey'])) $this->RelKey = $o['RelKey'];
        if (isset($o['WhenFull'])) $this->WhenFull = $o['WhenFull'];
        if (isset($o['AgeDays'])) $this->AgeDays = $o['AgeDays'];
        if (isset($o['RecordName'])) $this->RecordName = $o['RecordName'];
        if (isset($o['SeriesName'])) $this->SeriesName = $o['SeriesName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->EventId)) $o['EventId'] = $this->EventId;
        if (isset($this->RecordKey)) $o['RecordKey'] = $this->RecordKey;
        if (isset($this->Verb)) $o['Verb'] = $this->Verb;
        if (isset($this->WhoLabel)) $o['WhoLabel'] = $this->WhoLabel;
        if (isset($this->Detail)) $o['Detail'] = $this->Detail;
        if (isset($this->WhenLabel)) $o['WhenLabel'] = $this->WhenLabel;
        if (isset($this->EventRef)) $o['EventRef'] = $this->EventRef;
        if (isset($this->ActorKind)) $o['ActorKind'] = $this->ActorKind;
        if (isset($this->AuthContext)) $o['AuthContext'] = $this->AuthContext;
        if (isset($this->Ip)) $o['Ip'] = $this->Ip;
        if (isset($this->Device)) $o['Device'] = $this->Device;
        if (isset($this->RelKind)) $o['RelKind'] = $this->RelKind;
        if (isset($this->RelKey)) $o['RelKey'] = $this->RelKey;
        if (isset($this->WhenFull)) $o['WhenFull'] = $this->WhenFull;
        if (isset($this->AgeDays)) $o['AgeDays'] = $this->AgeDays;
        if (isset($this->RecordName)) $o['RecordName'] = $this->RecordName;
        if (isset($this->SeriesName)) $o['SeriesName'] = $this->SeriesName;
        return empty($o) ? new class(){} : $o;
    }
}

class RecordAuditResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<RecordAuditDto>|null */
        public ?array $Events=null,
        /** @var int */
        public int $Total=0
    ) {
    }

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

class OrgAuditTrailRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Q=null,
        /** @var string|null */
        public ?string $Verb=null,
        /** @var int */
        public int $Range=0,
        /** @var int */
        public int $Page=0,
        /** @var int */
        public int $PageSize=0,
        /** @var int */
        public int $Top=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Q'])) $this->Q = $o['Q'];
        if (isset($o['Verb'])) $this->Verb = $o['Verb'];
        if (isset($o['Range'])) $this->Range = $o['Range'];
        if (isset($o['Page'])) $this->Page = $o['Page'];
        if (isset($o['PageSize'])) $this->PageSize = $o['PageSize'];
        if (isset($o['Top'])) $this->Top = $o['Top'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Q)) $o['Q'] = $this->Q;
        if (isset($this->Verb)) $o['Verb'] = $this->Verb;
        if (isset($this->Range)) $o['Range'] = $this->Range;
        if (isset($this->Page)) $o['Page'] = $this->Page;
        if (isset($this->PageSize)) $o['PageSize'] = $this->PageSize;
        if (isset($this->Top)) $o['Top'] = $this->Top;
        return empty($o) ? new class(){} : $o;
    }
}

PHP OrgAuditTrailRequest 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 /v1/records/audit HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecordAuditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Events>
    <RecordAuditDto>
      <ActorKind>String</ActorKind>
      <AgeDays>0</AgeDays>
      <AuthContext>String</AuthContext>
      <Detail>String</Detail>
      <Device>String</Device>
      <EventId>0</EventId>
      <EventRef>String</EventRef>
      <Ip>String</Ip>
      <RecordKey>String</RecordKey>
      <RecordName>String</RecordName>
      <RelKey>String</RelKey>
      <RelKind>String</RelKind>
      <SeriesName>String</SeriesName>
      <Verb>String</Verb>
      <WhenFull>String</WhenFull>
      <WhenLabel>String</WhenLabel>
      <WhoLabel>String</WhoLabel>
    </RecordAuditDto>
  </Events>
  <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>
  <Total>0</Total>
</RecordAuditResponse>