Trendsic Platform Service

<back to all web services

ReleaseRetainageRequest

<?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 CloseoutStatus implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ProjectID=0,
        /** @var int */
        public int $TotalItems=0,
        /** @var int */
        public int $DoneCount=0,
        /** @var int */
        public int $OutstandingCount=0,
        /** @var bool|null */
        public ?bool $AllClear=null,
        /** @var float */
        public float $RetainageAmount=0.0,
        /** @var bool|null */
        public ?bool $RetainageReleased=null,
        /** @var int|null */
        public ?int $ReleasedPayApplicationID=null,
        /** @var int|null */
        public ?int $ReleasedInvoiceID=null,
        /** @var DateTime|null */
        public ?DateTime $ReleasedAt=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
        if (isset($o['TotalItems'])) $this->TotalItems = $o['TotalItems'];
        if (isset($o['DoneCount'])) $this->DoneCount = $o['DoneCount'];
        if (isset($o['OutstandingCount'])) $this->OutstandingCount = $o['OutstandingCount'];
        if (isset($o['AllClear'])) $this->AllClear = $o['AllClear'];
        if (isset($o['RetainageAmount'])) $this->RetainageAmount = $o['RetainageAmount'];
        if (isset($o['RetainageReleased'])) $this->RetainageReleased = $o['RetainageReleased'];
        if (isset($o['ReleasedPayApplicationID'])) $this->ReleasedPayApplicationID = $o['ReleasedPayApplicationID'];
        if (isset($o['ReleasedInvoiceID'])) $this->ReleasedInvoiceID = $o['ReleasedInvoiceID'];
        if (isset($o['ReleasedAt'])) $this->ReleasedAt = JsonConverters::from('DateTime', $o['ReleasedAt']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
        if (isset($this->TotalItems)) $o['TotalItems'] = $this->TotalItems;
        if (isset($this->DoneCount)) $o['DoneCount'] = $this->DoneCount;
        if (isset($this->OutstandingCount)) $o['OutstandingCount'] = $this->OutstandingCount;
        if (isset($this->AllClear)) $o['AllClear'] = $this->AllClear;
        if (isset($this->RetainageAmount)) $o['RetainageAmount'] = $this->RetainageAmount;
        if (isset($this->RetainageReleased)) $o['RetainageReleased'] = $this->RetainageReleased;
        if (isset($this->ReleasedPayApplicationID)) $o['ReleasedPayApplicationID'] = $this->ReleasedPayApplicationID;
        if (isset($this->ReleasedInvoiceID)) $o['ReleasedInvoiceID'] = $this->ReleasedInvoiceID;
        if (isset($this->ReleasedAt)) $o['ReleasedAt'] = JsonConverters::to('DateTime', $this->ReleasedAt);
        return empty($o) ? new class(){} : $o;
    }
}

class ReleaseRetainageResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var int */
        public int $ProjectID=0,
        /** @var CloseoutStatus|null */
        public ?CloseoutStatus $Status=null,
        /** @var int|null */
        public ?int $PayApplicationID=null,
        /** @var int|null */
        public ?int $InvoiceID=null,
        /** @var float */
        public float $RetainageReleased=0.0
    ) {
    }

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

class ReleaseRetainageRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ProjectID=0
    ) {
    }

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

PHP ReleaseRetainageRequest DTOs

POST /v1/projects/{ProjectID}/closeout/release-retainage HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReleaseRetainageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ProjectID>0</ProjectID>
</ReleaseRetainageRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReleaseRetainageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <InvoiceID>0</InvoiceID>
  <PayApplicationID>0</PayApplicationID>
  <ProjectID>0</ProjectID>
  <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>
  <RetainageReleased>0</RetainageReleased>
  <Status>
    <AllClear>false</AllClear>
    <DoneCount>0</DoneCount>
    <OutstandingCount>0</OutstandingCount>
    <ProjectID>0</ProjectID>
    <ReleasedAt>0001-01-01T00:00:00</ReleasedAt>
    <ReleasedInvoiceID>0</ReleasedInvoiceID>
    <ReleasedPayApplicationID>0</ReleasedPayApplicationID>
    <RetainageAmount>0</RetainageAmount>
    <RetainageReleased>false</RetainageReleased>
    <TotalItems>0</TotalItems>
  </Status>
</ReleaseRetainageResponse>