Trendsic Platform Service

<back to all web services

RecordAuditSliceRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/entry/{RecordKey}/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
    ) {
    }

    /** @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'];
    }
    
    /** @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;
        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
    ) {
    }

    /** @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']);
    }
    
    /** @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);
        return empty($o) ? new class(){} : $o;
    }
}

class RecordAuditSliceRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $RecordKey=null
    ) {
    }

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

PHP RecordAuditSliceRequest 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/entry/{RecordKey}/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>
      <Detail>String</Detail>
      <EventId>0</EventId>
      <RecordKey>String</RecordKey>
      <Verb>String</Verb>
      <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>
</RecordAuditResponse>