Trendsic Platform Service

<back to all web services

DocumentShareLogRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/documentshare/{DocumentShareId}/log
<?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 DocumentShareAccessLog implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $DocumentShareAccessLogId=0,
        /** @var int */
        public int $DocumentShareId=0,
        /** @var string|null */
        public ?string $EventType=null,
        /** @var string|null */
        public ?string $Outcome=null,
        /** @var string|null */
        public ?string $DetailMessage=null,
        /** @var string|null */
        public ?string $IpAddress=null,
        /** @var string|null */
        public ?string $UserAgent=null,
        /** @var string|null */
        public ?string $ActorUserId=null,
        /** @var DateTime */
        public DateTime $CreatedAtUtc=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['DocumentShareAccessLogId'])) $this->DocumentShareAccessLogId = $o['DocumentShareAccessLogId'];
        if (isset($o['DocumentShareId'])) $this->DocumentShareId = $o['DocumentShareId'];
        if (isset($o['EventType'])) $this->EventType = $o['EventType'];
        if (isset($o['Outcome'])) $this->Outcome = $o['Outcome'];
        if (isset($o['DetailMessage'])) $this->DetailMessage = $o['DetailMessage'];
        if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
        if (isset($o['UserAgent'])) $this->UserAgent = $o['UserAgent'];
        if (isset($o['ActorUserId'])) $this->ActorUserId = $o['ActorUserId'];
        if (isset($o['CreatedAtUtc'])) $this->CreatedAtUtc = JsonConverters::from('DateTime', $o['CreatedAtUtc']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->DocumentShareAccessLogId)) $o['DocumentShareAccessLogId'] = $this->DocumentShareAccessLogId;
        if (isset($this->DocumentShareId)) $o['DocumentShareId'] = $this->DocumentShareId;
        if (isset($this->EventType)) $o['EventType'] = $this->EventType;
        if (isset($this->Outcome)) $o['Outcome'] = $this->Outcome;
        if (isset($this->DetailMessage)) $o['DetailMessage'] = $this->DetailMessage;
        if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
        if (isset($this->UserAgent)) $o['UserAgent'] = $this->UserAgent;
        if (isset($this->ActorUserId)) $o['ActorUserId'] = $this->ActorUserId;
        if (isset($this->CreatedAtUtc)) $o['CreatedAtUtc'] = JsonConverters::to('DateTime', $this->CreatedAtUtc);
        return empty($o) ? new class(){} : $o;
    }
}

class DocumentShareLogResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<DocumentShareAccessLog>|null */
        public ?array $AccessLog=null
    ) {
    }

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

class DocumentShareLogRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $DocumentShareId=0
    ) {
    }

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

PHP DocumentShareLogRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/documentshare/{DocumentShareId}/log HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"AccessLog":[{"DocumentShareAccessLogId":0,"DocumentShareId":0,"EventType":"String","Outcome":"String","DetailMessage":"String","IpAddress":"String","UserAgent":"String","ActorUserId":"00000000000000000000000000000000","CreatedAtUtc":"0001-01-01T00:00:00.0000000"}]}