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 .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/projects/{ProjectID}/hold-points HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	Description: String,
	ResponsibleParty: String,
	CostCode: String,
	ScheduledDate: 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
		}
	},
	HoldPoint: 
	{
		QcHoldPointID: 0,
		QcHoldPointUID: 00000000000000000000000000000000,
		ProjectID: 0,
		Description: String,
		ResponsibleParty: String,
		CostCode: String,
		ScheduledDate: 0001-01-01,
		Status: String,
		ReleasedBy: String,
		ReleasedAt: 0001-01-01,
		Notes: String,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01
	}
}