Trendsic Platform Service

<back to all web services

ProjectSearchRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/ProjectSearch
<?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 Project implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ProjectID=0,
        /** @var string */
        public string $ProjectUID='',
        /** @var string|null */
        public ?string $ProjectName=null,
        /** @var string|null */
        public ?string $ImageURL=null,
        /** @var string|null */
        public ?string $ImageKey=null,
        /** @var string|null */
        public ?string $ClientName=null,
        /** @var string|null */
        public ?string $ClientPhone=null,
        /** @var string|null */
        public ?string $ClientEmail=null,
        /** @var int */
        public int $ProjectManagerID=0,
        /** @var string|null */
        public ?string $ProjectManagerName=null,
        /** @var DateTime|null */
        public ?DateTime $StartDate=null,
        /** @var DateTime|null */
        public ?DateTime $EndDate=null,
        /** @var DateTime|null */
        public ?DateTime $ActualStartDate=null,
        /** @var DateTime|null */
        public ?DateTime $ActualEndDate=null,
        /** @var int */
        public int $JobCount=0,
        /** @var int */
        public int $CrewMemberCount=0,
        /** @var int */
        public int $EquipmentCount=0,
        /** @var int */
        public int $MaterialCount=0,
        /** @var int */
        public int $ProjectStatusID=0,
        /** @var string|null */
        public ?string $ProjectStatusDescription=null,
        /** @var float */
        public float $Budget=0.0,
        /** @var float */
        public float $CostToDate=0.0,
        /** @var string|null */
        public ?string $ProjectLocation=null,
        /** @var string|null */
        public ?string $ProjectType=null,
        /** @var string|null */
        public ?string $ProjectSponsor=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null,
        /** @var string|null */
        public ?string $ProjectDescription=null,
        /** @var string|null */
        public ?string $Scope=null,
        /** @var int */
        public int $StatusId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
        if (isset($o['ProjectUID'])) $this->ProjectUID = $o['ProjectUID'];
        if (isset($o['ProjectName'])) $this->ProjectName = $o['ProjectName'];
        if (isset($o['ImageURL'])) $this->ImageURL = $o['ImageURL'];
        if (isset($o['ImageKey'])) $this->ImageKey = $o['ImageKey'];
        if (isset($o['ClientName'])) $this->ClientName = $o['ClientName'];
        if (isset($o['ClientPhone'])) $this->ClientPhone = $o['ClientPhone'];
        if (isset($o['ClientEmail'])) $this->ClientEmail = $o['ClientEmail'];
        if (isset($o['ProjectManagerID'])) $this->ProjectManagerID = $o['ProjectManagerID'];
        if (isset($o['ProjectManagerName'])) $this->ProjectManagerName = $o['ProjectManagerName'];
        if (isset($o['StartDate'])) $this->StartDate = JsonConverters::from('DateTime', $o['StartDate']);
        if (isset($o['EndDate'])) $this->EndDate = JsonConverters::from('DateTime', $o['EndDate']);
        if (isset($o['ActualStartDate'])) $this->ActualStartDate = JsonConverters::from('DateTime', $o['ActualStartDate']);
        if (isset($o['ActualEndDate'])) $this->ActualEndDate = JsonConverters::from('DateTime', $o['ActualEndDate']);
        if (isset($o['JobCount'])) $this->JobCount = $o['JobCount'];
        if (isset($o['CrewMemberCount'])) $this->CrewMemberCount = $o['CrewMemberCount'];
        if (isset($o['EquipmentCount'])) $this->EquipmentCount = $o['EquipmentCount'];
        if (isset($o['MaterialCount'])) $this->MaterialCount = $o['MaterialCount'];
        if (isset($o['ProjectStatusID'])) $this->ProjectStatusID = $o['ProjectStatusID'];
        if (isset($o['ProjectStatusDescription'])) $this->ProjectStatusDescription = $o['ProjectStatusDescription'];
        if (isset($o['Budget'])) $this->Budget = $o['Budget'];
        if (isset($o['CostToDate'])) $this->CostToDate = $o['CostToDate'];
        if (isset($o['ProjectLocation'])) $this->ProjectLocation = $o['ProjectLocation'];
        if (isset($o['ProjectType'])) $this->ProjectType = $o['ProjectType'];
        if (isset($o['ProjectSponsor'])) $this->ProjectSponsor = $o['ProjectSponsor'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['UpdatedAt'])) $this->UpdatedAt = JsonConverters::from('DateTime', $o['UpdatedAt']);
        if (isset($o['ProjectDescription'])) $this->ProjectDescription = $o['ProjectDescription'];
        if (isset($o['Scope'])) $this->Scope = $o['Scope'];
        if (isset($o['StatusId'])) $this->StatusId = $o['StatusId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
        if (isset($this->ProjectUID)) $o['ProjectUID'] = $this->ProjectUID;
        if (isset($this->ProjectName)) $o['ProjectName'] = $this->ProjectName;
        if (isset($this->ImageURL)) $o['ImageURL'] = $this->ImageURL;
        if (isset($this->ImageKey)) $o['ImageKey'] = $this->ImageKey;
        if (isset($this->ClientName)) $o['ClientName'] = $this->ClientName;
        if (isset($this->ClientPhone)) $o['ClientPhone'] = $this->ClientPhone;
        if (isset($this->ClientEmail)) $o['ClientEmail'] = $this->ClientEmail;
        if (isset($this->ProjectManagerID)) $o['ProjectManagerID'] = $this->ProjectManagerID;
        if (isset($this->ProjectManagerName)) $o['ProjectManagerName'] = $this->ProjectManagerName;
        if (isset($this->StartDate)) $o['StartDate'] = JsonConverters::to('DateTime', $this->StartDate);
        if (isset($this->EndDate)) $o['EndDate'] = JsonConverters::to('DateTime', $this->EndDate);
        if (isset($this->ActualStartDate)) $o['ActualStartDate'] = JsonConverters::to('DateTime', $this->ActualStartDate);
        if (isset($this->ActualEndDate)) $o['ActualEndDate'] = JsonConverters::to('DateTime', $this->ActualEndDate);
        if (isset($this->JobCount)) $o['JobCount'] = $this->JobCount;
        if (isset($this->CrewMemberCount)) $o['CrewMemberCount'] = $this->CrewMemberCount;
        if (isset($this->EquipmentCount)) $o['EquipmentCount'] = $this->EquipmentCount;
        if (isset($this->MaterialCount)) $o['MaterialCount'] = $this->MaterialCount;
        if (isset($this->ProjectStatusID)) $o['ProjectStatusID'] = $this->ProjectStatusID;
        if (isset($this->ProjectStatusDescription)) $o['ProjectStatusDescription'] = $this->ProjectStatusDescription;
        if (isset($this->Budget)) $o['Budget'] = $this->Budget;
        if (isset($this->CostToDate)) $o['CostToDate'] = $this->CostToDate;
        if (isset($this->ProjectLocation)) $o['ProjectLocation'] = $this->ProjectLocation;
        if (isset($this->ProjectType)) $o['ProjectType'] = $this->ProjectType;
        if (isset($this->ProjectSponsor)) $o['ProjectSponsor'] = $this->ProjectSponsor;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->UpdatedAt)) $o['UpdatedAt'] = JsonConverters::to('DateTime', $this->UpdatedAt);
        if (isset($this->ProjectDescription)) $o['ProjectDescription'] = $this->ProjectDescription;
        if (isset($this->Scope)) $o['Scope'] = $this->Scope;
        if (isset($this->StatusId)) $o['StatusId'] = $this->StatusId;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class ProjectSearchRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $filterStatus=0,
        /** @var int */
        public int $filterManager=0,
        /** @var string|null */
        public ?string $filterClientName=null,
        /** @var DateTime */
        public DateTime $filterStartBefore=new DateTime(),
        /** @var DateTime */
        public DateTime $filterStartAfter=new DateTime(),
        /** @var DateTime */
        public DateTime $filterEndBefore=new DateTime(),
        /** @var DateTime */
        public DateTime $filterEndAfter=new DateTime()
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['filterStatus'])) $this->filterStatus = $o['filterStatus'];
        if (isset($o['filterManager'])) $this->filterManager = $o['filterManager'];
        if (isset($o['filterClientName'])) $this->filterClientName = $o['filterClientName'];
        if (isset($o['filterStartBefore'])) $this->filterStartBefore = JsonConverters::from('DateTime', $o['filterStartBefore']);
        if (isset($o['filterStartAfter'])) $this->filterStartAfter = JsonConverters::from('DateTime', $o['filterStartAfter']);
        if (isset($o['filterEndBefore'])) $this->filterEndBefore = JsonConverters::from('DateTime', $o['filterEndBefore']);
        if (isset($o['filterEndAfter'])) $this->filterEndAfter = JsonConverters::from('DateTime', $o['filterEndAfter']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->filterStatus)) $o['filterStatus'] = $this->filterStatus;
        if (isset($this->filterManager)) $o['filterManager'] = $this->filterManager;
        if (isset($this->filterClientName)) $o['filterClientName'] = $this->filterClientName;
        if (isset($this->filterStartBefore)) $o['filterStartBefore'] = JsonConverters::to('DateTime', $this->filterStartBefore);
        if (isset($this->filterStartAfter)) $o['filterStartAfter'] = JsonConverters::to('DateTime', $this->filterStartAfter);
        if (isset($this->filterEndBefore)) $o['filterEndBefore'] = JsonConverters::to('DateTime', $this->filterEndBefore);
        if (isset($this->filterEndAfter)) $o['filterEndAfter'] = JsonConverters::to('DateTime', $this->filterEndAfter);
        return empty($o) ? new class(){} : $o;
    }
}

PHP ProjectSearchRequest 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.

POST /v1/ProjectSearch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	filterStatus: 0,
	filterManager: 0,
	filterClientName: String,
	filterStartBefore: 0001-01-01,
	filterStartAfter: 0001-01-01,
	filterEndBefore: 0001-01-01,
	filterEndAfter: 0001-01-01
}
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
		}
	},
	Project: 
	[
		{
			ProjectID: 0,
			ProjectUID: 00000000000000000000000000000000,
			ProjectName: String,
			ImageURL: String,
			ImageKey: String,
			ClientName: String,
			ClientPhone: String,
			ClientEmail: String,
			ProjectManagerID: 0,
			ProjectManagerName: String,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			ActualStartDate: 0001-01-01,
			ActualEndDate: 0001-01-01,
			JobCount: 0,
			CrewMemberCount: 0,
			EquipmentCount: 0,
			MaterialCount: 0,
			ProjectStatusID: 0,
			ProjectStatusDescription: String,
			Budget: 0,
			CostToDate: 0,
			ProjectLocation: String,
			ProjectType: String,
			ProjectSponsor: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			ProjectDescription: String,
			Scope: String,
			StatusId: 0
		}
	]
}