Trendsic Platform Service

<back to all web services

QcHoldPointCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/hold-points
<?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 QcHoldPoint implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $QcHoldPointID=0,
        /** @var string */
        public string $QcHoldPointUID='',
        /** @var int */
        public int $ProjectID=0,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $ResponsibleParty=null,
        /** @var string|null */
        public ?string $CostCode=null,
        /** @var DateTime|null */
        public ?DateTime $ScheduledDate=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $ReleasedBy=null,
        /** @var DateTime|null */
        public ?DateTime $ReleasedAt=null,
        /** @var string|null */
        public ?string $Notes=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $UpdatedAt=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['QcHoldPointID'])) $this->QcHoldPointID = $o['QcHoldPointID'];
        if (isset($o['QcHoldPointUID'])) $this->QcHoldPointUID = $o['QcHoldPointUID'];
        if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['ResponsibleParty'])) $this->ResponsibleParty = $o['ResponsibleParty'];
        if (isset($o['CostCode'])) $this->CostCode = $o['CostCode'];
        if (isset($o['ScheduledDate'])) $this->ScheduledDate = JsonConverters::from('DateTime', $o['ScheduledDate']);
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['ReleasedBy'])) $this->ReleasedBy = $o['ReleasedBy'];
        if (isset($o['ReleasedAt'])) $this->ReleasedAt = JsonConverters::from('DateTime', $o['ReleasedAt']);
        if (isset($o['Notes'])) $this->Notes = $o['Notes'];
        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']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->QcHoldPointID)) $o['QcHoldPointID'] = $this->QcHoldPointID;
        if (isset($this->QcHoldPointUID)) $o['QcHoldPointUID'] = $this->QcHoldPointUID;
        if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->ResponsibleParty)) $o['ResponsibleParty'] = $this->ResponsibleParty;
        if (isset($this->CostCode)) $o['CostCode'] = $this->CostCode;
        if (isset($this->ScheduledDate)) $o['ScheduledDate'] = JsonConverters::to('DateTime', $this->ScheduledDate);
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->ReleasedBy)) $o['ReleasedBy'] = $this->ReleasedBy;
        if (isset($this->ReleasedAt)) $o['ReleasedAt'] = JsonConverters::to('DateTime', $this->ReleasedAt);
        if (isset($this->Notes)) $o['Notes'] = $this->Notes;
        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);
        return empty($o) ? new class(){} : $o;
    }
}

class QcHoldPointResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var QcHoldPoint|null */
        public ?QcHoldPoint $HoldPoint=null
    ) {
    }

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

class QcHoldPointCreateRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ProjectID=0,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $ResponsibleParty=null,
        /** @var string|null */
        public ?string $CostCode=null,
        /** @var DateTime|null */
        public ?DateTime $ScheduledDate=null
    ) {
    }

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

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

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

<QcHoldPointCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CostCode>String</CostCode>
  <Description>String</Description>
  <ProjectID>0</ProjectID>
  <ResponsibleParty>String</ResponsibleParty>
  <ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
</QcHoldPointCreateRequest>

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

<QcHoldPointResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <HoldPoint>
    <CostCode>String</CostCode>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <Description>String</Description>
    <Notes>String</Notes>
    <ProjectID>0</ProjectID>
    <QcHoldPointID>0</QcHoldPointID>
    <QcHoldPointUID>00000000-0000-0000-0000-000000000000</QcHoldPointUID>
    <ReleasedAt>0001-01-01T00:00:00</ReleasedAt>
    <ReleasedBy>String</ReleasedBy>
    <ResponsibleParty>String</ResponsibleParty>
    <ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
    <Status>String</Status>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
  </HoldPoint>
  <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>
</QcHoldPointResponse>