Trendsic Platform Service

<back to all web services

ProjectProfitLossRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Project/ProfitLoss/{ProjectID}/{ProfitLossStartDate}/{ProfitLossEndDate}
<?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 ProjectCost implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ProjectID=0,
        /** @var float */
        public float $Budget=0.0,
        /** @var float */
        public float $CrewCost=0.0,
        /** @var float */
        public float $EquipmentCost=0.0,
        /** @var float */
        public float $MaterialCost=0.0,
        /** @var float */
        public float $TotalCost=0.0,
        /** @var float */
        public float $BilledCrewCost=0.0,
        /** @var float */
        public float $BilledEquipmentCost=0.0,
        /** @var float */
        public float $BilledMaterialCost=0.0,
        /** @var float */
        public float $BilledTotalCost=0.0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
        if (isset($o['Budget'])) $this->Budget = $o['Budget'];
        if (isset($o['CrewCost'])) $this->CrewCost = $o['CrewCost'];
        if (isset($o['EquipmentCost'])) $this->EquipmentCost = $o['EquipmentCost'];
        if (isset($o['MaterialCost'])) $this->MaterialCost = $o['MaterialCost'];
        if (isset($o['TotalCost'])) $this->TotalCost = $o['TotalCost'];
        if (isset($o['BilledCrewCost'])) $this->BilledCrewCost = $o['BilledCrewCost'];
        if (isset($o['BilledEquipmentCost'])) $this->BilledEquipmentCost = $o['BilledEquipmentCost'];
        if (isset($o['BilledMaterialCost'])) $this->BilledMaterialCost = $o['BilledMaterialCost'];
        if (isset($o['BilledTotalCost'])) $this->BilledTotalCost = $o['BilledTotalCost'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
        if (isset($this->Budget)) $o['Budget'] = $this->Budget;
        if (isset($this->CrewCost)) $o['CrewCost'] = $this->CrewCost;
        if (isset($this->EquipmentCost)) $o['EquipmentCost'] = $this->EquipmentCost;
        if (isset($this->MaterialCost)) $o['MaterialCost'] = $this->MaterialCost;
        if (isset($this->TotalCost)) $o['TotalCost'] = $this->TotalCost;
        if (isset($this->BilledCrewCost)) $o['BilledCrewCost'] = $this->BilledCrewCost;
        if (isset($this->BilledEquipmentCost)) $o['BilledEquipmentCost'] = $this->BilledEquipmentCost;
        if (isset($this->BilledMaterialCost)) $o['BilledMaterialCost'] = $this->BilledMaterialCost;
        if (isset($this->BilledTotalCost)) $o['BilledTotalCost'] = $this->BilledTotalCost;
        return empty($o) ? new class(){} : $o;
    }
}

class ProjectProfitLossResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var ProjectCost|null */
        public ?ProjectCost $ProjectProfitLoss=null
    ) {
    }

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

class ProjectProfitLossRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ProjectID=0,
        /** @var DateTime */
        public DateTime $ProfitLossStartDate=new DateTime(),
        /** @var DateTime */
        public DateTime $ProfitLossEndDate=new DateTime()
    ) {
    }

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

PHP ProjectProfitLossRequest DTOs

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

HTTP + XML

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

GET /v1/Project/ProfitLoss/{ProjectID}/{ProfitLossStartDate}/{ProfitLossEndDate} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectProfitLossResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ProjectProfitLoss>
    <BilledCrewCost>0</BilledCrewCost>
    <BilledEquipmentCost>0</BilledEquipmentCost>
    <BilledMaterialCost>0</BilledMaterialCost>
    <BilledTotalCost>0</BilledTotalCost>
    <Budget>0</Budget>
    <CrewCost>0</CrewCost>
    <EquipmentCost>0</EquipmentCost>
    <MaterialCost>0</MaterialCost>
    <ProjectID>0</ProjectID>
    <TotalCost>0</TotalCost>
  </ProjectProfitLoss>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ProjectProfitLossResponse>