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
    ) {
    }

    /** @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 OrgAuditTrailRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Q=null,
        /** @var string|null */
        public ?string $Verb=null,
        /** @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['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->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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Events: 
	[
		{
			EventId: 0,
			RecordKey: String,
			Verb: String,
			WhoLabel: String,
			Detail: String,
			WhenLabel: String
		}
	]
}