Trendsic Platform Service

ShareLandingRequest

The following routes are available for this service:
GET,OPTIONS	/share/{Token}

<?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 ShareLandingResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var bool|null */
        public ?bool $RequireOtp=null,
        /** @var string|null */
        public ?string $OtpChannel=null,
        /** @var bool|null */
        public ?bool $OtpSent=null,
        /** @var string|null */
        public ?string $DocumentName=null,
        /** @var bool|null */
        public ?bool $CanView=null,
        /** @var string|null */
        public ?string $Message=null
    ) {
    }

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

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

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

PHP ShareLandingRequest 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 /share/{Token} 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
		}
	},
	Status: String,
	RequireOtp: False,
	OtpChannel: String,
	OtpSent: False,
	DocumentName: String,
	CanView: False,
	Message: String
}