Trendsic Platform Service

<back to all web services

ProjectRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Project/GetSingle/{ProjectUID}
GET,POST,PUT,DELETE,OPTIONS/v1/Project
GET,POST,PUT,DELETE,OPTIONS/v1/Project/{ProjectID}
<?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 Location implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Id='',
        /** @var string */
        public string $ClientId='',
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Address1=null,
        /** @var string|null */
        public ?string $Address2=null,
        /** @var string|null */
        public ?string $City=null,
        /** @var string|null */
        public ?string $State=null,
        /** @var string|null */
        public ?string $Zip=null,
        /** @var string|null */
        public ?string $Phone=null,
        /** @var string|null */
        public ?string $Fax=null,
        /** @var string|null */
        public ?string $URL=null,
        /** @var string|null */
        public ?string $Email=null,
        /** @var string|null */
        public ?string $TimeZone=null,
        /** @var bool|null */
        public ?bool $Active=null,
        /** @var DateTime */
        public DateTime $EntDate=new DateTime(),
        /** @var DateTime */
        public DateTime $ModDate=new DateTime(),
        /** @var string|null */
        public ?string $LocationImage=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['ClientId'])) $this->ClientId = $o['ClientId'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Address1'])) $this->Address1 = $o['Address1'];
        if (isset($o['Address2'])) $this->Address2 = $o['Address2'];
        if (isset($o['City'])) $this->City = $o['City'];
        if (isset($o['State'])) $this->State = $o['State'];
        if (isset($o['Zip'])) $this->Zip = $o['Zip'];
        if (isset($o['Phone'])) $this->Phone = $o['Phone'];
        if (isset($o['Fax'])) $this->Fax = $o['Fax'];
        if (isset($o['URL'])) $this->URL = $o['URL'];
        if (isset($o['Email'])) $this->Email = $o['Email'];
        if (isset($o['TimeZone'])) $this->TimeZone = $o['TimeZone'];
        if (isset($o['Active'])) $this->Active = $o['Active'];
        if (isset($o['EntDate'])) $this->EntDate = JsonConverters::from('DateTime', $o['EntDate']);
        if (isset($o['ModDate'])) $this->ModDate = JsonConverters::from('DateTime', $o['ModDate']);
        if (isset($o['LocationImage'])) $this->LocationImage = $o['LocationImage'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->ClientId)) $o['ClientId'] = $this->ClientId;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Address1)) $o['Address1'] = $this->Address1;
        if (isset($this->Address2)) $o['Address2'] = $this->Address2;
        if (isset($this->City)) $o['City'] = $this->City;
        if (isset($this->State)) $o['State'] = $this->State;
        if (isset($this->Zip)) $o['Zip'] = $this->Zip;
        if (isset($this->Phone)) $o['Phone'] = $this->Phone;
        if (isset($this->Fax)) $o['Fax'] = $this->Fax;
        if (isset($this->URL)) $o['URL'] = $this->URL;
        if (isset($this->Email)) $o['Email'] = $this->Email;
        if (isset($this->TimeZone)) $o['TimeZone'] = $this->TimeZone;
        if (isset($this->Active)) $o['Active'] = $this->Active;
        if (isset($this->EntDate)) $o['EntDate'] = JsonConverters::to('DateTime', $this->EntDate);
        if (isset($this->ModDate)) $o['ModDate'] = JsonConverters::to('DateTime', $this->ModDate);
        if (isset($this->LocationImage)) $o['LocationImage'] = $this->LocationImage;
        return empty($o) ? new class(){} : $o;
    }
}

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 bool|null */
        public ?bool $NotifyCustomerOnVisitCompletion=null,
        /** @var int|null */
        public ?int $ClientContactID=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 string|null */
        public ?string $CrewAvatarsJson=null,
        /** @var string|null */
        public ?string $CrewNamesSearch=null,
        /** @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,
        /** @var string */
        public string $BranchId='',
        /** @var string|null */
        public ?string $BranchName=null,
        /** @var Location|null */
        public ?Location $Location=null
    ) {
    }

    /** @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['NotifyCustomerOnVisitCompletion'])) $this->NotifyCustomerOnVisitCompletion = $o['NotifyCustomerOnVisitCompletion'];
        if (isset($o['ClientContactID'])) $this->ClientContactID = $o['ClientContactID'];
        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['CrewAvatarsJson'])) $this->CrewAvatarsJson = $o['CrewAvatarsJson'];
        if (isset($o['CrewNamesSearch'])) $this->CrewNamesSearch = $o['CrewNamesSearch'];
        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'];
        if (isset($o['BranchId'])) $this->BranchId = $o['BranchId'];
        if (isset($o['BranchName'])) $this->BranchName = $o['BranchName'];
        if (isset($o['Location'])) $this->Location = JsonConverters::from('Location', $o['Location']);
    }
    
    /** @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->NotifyCustomerOnVisitCompletion)) $o['NotifyCustomerOnVisitCompletion'] = $this->NotifyCustomerOnVisitCompletion;
        if (isset($this->ClientContactID)) $o['ClientContactID'] = $this->ClientContactID;
        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->CrewAvatarsJson)) $o['CrewAvatarsJson'] = $this->CrewAvatarsJson;
        if (isset($this->CrewNamesSearch)) $o['CrewNamesSearch'] = $this->CrewNamesSearch;
        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;
        if (isset($this->BranchId)) $o['BranchId'] = $this->BranchId;
        if (isset($this->BranchName)) $o['BranchName'] = $this->BranchName;
        if (isset($this->Location)) $o['Location'] = JsonConverters::to('Location', $this->Location);
        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 ProjectRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ProjectUID='',
        /** @var int */
        public int $ProjectID=0,
        /** @var array<Project>|null */
        public ?array $Project=null
    ) {
    }

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

PHP ProjectRequest DTOs

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

HTTP + CSV

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

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

{"ProjectUID":"00000000000000000000000000000000","ProjectID":0,"Project":[{"ProjectID":0,"ProjectUID":"00000000000000000000000000000000","ProjectName":"String","ImageURL":"String","ImageKey":"String","ClientName":"String","ClientPhone":"String","ClientEmail":"String","NotifyCustomerOnVisitCompletion":false,"ClientContactID":0,"ProjectManagerID":0,"ProjectManagerName":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","ActualStartDate":"0001-01-01T00:00:00.0000000","ActualEndDate":"0001-01-01T00:00:00.0000000","JobCount":0,"CrewMemberCount":0,"CrewAvatarsJson":"String","CrewNamesSearch":"String","EquipmentCount":0,"MaterialCount":0,"ProjectStatusID":0,"ProjectStatusDescription":"String","Budget":0,"CostToDate":0,"ProjectLocation":"String","ProjectType":"String","ProjectSponsor":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","ProjectDescription":"String","Scope":"String","StatusId":0,"BranchId":"00000000000000000000000000000000","BranchName":"String","Location":{"Id":"00000000000000000000000000000000","ClientId":"00000000000000000000000000000000","Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Phone":"String","Fax":"String","URL":"String","Email":"String","TimeZone":"String","Active":false,"EntDate":"0001-01-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000","LocationImage":"String"}}]}
HTTP/1.1 200 OK
Content-Type: text/csv
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","NotifyCustomerOnVisitCompletion":false,"ClientContactID":0,"ProjectManagerID":0,"ProjectManagerName":"String","StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","ActualStartDate":"0001-01-01T00:00:00.0000000","ActualEndDate":"0001-01-01T00:00:00.0000000","JobCount":0,"CrewMemberCount":0,"CrewAvatarsJson":"String","CrewNamesSearch":"String","EquipmentCount":0,"MaterialCount":0,"ProjectStatusID":0,"ProjectStatusDescription":"String","Budget":0,"CostToDate":0,"ProjectLocation":"String","ProjectType":"String","ProjectSponsor":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","ProjectDescription":"String","Scope":"String","StatusId":0,"BranchId":"00000000000000000000000000000000","BranchName":"String","Location":{"Id":"00000000000000000000000000000000","ClientId":"00000000000000000000000000000000","Name":"String","Address1":"String","Address2":"String","City":"String","State":"String","Zip":"String","Phone":"String","Fax":"String","URL":"String","Email":"String","TimeZone":"String","Active":false,"EntDate":"0001-01-01T00:00:00.0000000","ModDate":"0001-01-01T00:00:00.0000000","LocationImage":"String"}}]}