Trendsic Platform Service

<back to all web services

ASAPReportDetailRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/ASAPReport/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID}/{ApptAgentID}
<?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 ASAPReport implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $AdjustmentDate=new DateTime(),
        /** @var string|null */
        public ?string $ApptAgent=null,
        /** @var string|null */
        public ?string $Reason=null,
        /** @var float */
        public float $Amount=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AdjustmentDate'])) $this->AdjustmentDate = JsonConverters::from('DateTime', $o['AdjustmentDate']);
        if (isset($o['ApptAgent'])) $this->ApptAgent = $o['ApptAgent'];
        if (isset($o['Reason'])) $this->Reason = $o['Reason'];
        if (isset($o['Amount'])) $this->Amount = $o['Amount'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AdjustmentDate)) $o['AdjustmentDate'] = JsonConverters::to('DateTime', $this->AdjustmentDate);
        if (isset($this->ApptAgent)) $o['ApptAgent'] = $this->ApptAgent;
        if (isset($this->Reason)) $o['Reason'] = $this->Reason;
        if (isset($this->Amount)) $o['Amount'] = $this->Amount;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class ASAPReportDetailRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<ASAPReport>|null */
        public ?array $ASAPReport=null,
        /** @var int */
        public int $AgentID=0,
        /** @var int */
        public int $ApptAgentID=0,
        /** @var DateTime */
        public DateTime $ParamStartDate=new DateTime(),
        /** @var DateTime */
        public DateTime $ParamEndDate=new DateTime()
    ) {
    }

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

PHP ASAPReportDetailRequest 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/ASAPReport/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID}/{ApptAgentID} 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
		}
	},
	ASAPReport: 
	[
		{
			AdjustmentDate: 0001-01-01,
			ApptAgent: String,
			Reason: String,
			Amount: 0
		}
	]
}