Trendsic Platform Service

TaskRequest

**Requires Authentication**
Requires any of the roles:	Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator

The following routes are available for this service:
DELETE,OPTIONS	/v1/Task/{TaskId}
GET,POST,PUT,OPTIONS	/v1/Task

<?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 Task implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $TaskId='',
        /** @var string|null */
        public ?string $Description=null,
        /** @var DateTime */
        public DateTime $DueDate=new DateTime(),
        /** @var int */
        public int $AssignedToAgentId=0,
        /** @var int */
        public int $RelatedToContactId=0,
        /** @var int */
        public int $CreatedBy=0,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var DateTime */
        public DateTime $DateCompleted=new DateTime(),
        /** @var int */
        public int $CompletedBy=0,
        /** @var DateTime */
        public DateTime $DateDeleted=new DateTime(),
        /** @var int */
        public int $DeletedBy=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TaskId'])) $this->TaskId = $o['TaskId'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['DueDate'])) $this->DueDate = JsonConverters::from('DateTime', $o['DueDate']);
        if (isset($o['AssignedToAgentId'])) $this->AssignedToAgentId = $o['AssignedToAgentId'];
        if (isset($o['RelatedToContactId'])) $this->RelatedToContactId = $o['RelatedToContactId'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['DateCompleted'])) $this->DateCompleted = JsonConverters::from('DateTime', $o['DateCompleted']);
        if (isset($o['CompletedBy'])) $this->CompletedBy = $o['CompletedBy'];
        if (isset($o['DateDeleted'])) $this->DateDeleted = JsonConverters::from('DateTime', $o['DateDeleted']);
        if (isset($o['DeletedBy'])) $this->DeletedBy = $o['DeletedBy'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TaskId)) $o['TaskId'] = $this->TaskId;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->DueDate)) $o['DueDate'] = JsonConverters::to('DateTime', $this->DueDate);
        if (isset($this->AssignedToAgentId)) $o['AssignedToAgentId'] = $this->AssignedToAgentId;
        if (isset($this->RelatedToContactId)) $o['RelatedToContactId'] = $this->RelatedToContactId;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->DateCompleted)) $o['DateCompleted'] = JsonConverters::to('DateTime', $this->DateCompleted);
        if (isset($this->CompletedBy)) $o['CompletedBy'] = $this->CompletedBy;
        if (isset($this->DateDeleted)) $o['DateDeleted'] = JsonConverters::to('DateTime', $this->DateDeleted);
        if (isset($this->DeletedBy)) $o['DeletedBy'] = $this->DeletedBy;
        return empty($o) ? new class(){} : $o;
    }
}

class TaskExtended extends Task implements JsonSerializable
{
    /**
     * @param string $TaskId
     * @param string|null $Description
     * @param DateTime $DueDate
     * @param int $AssignedToAgentId
     * @param int $RelatedToContactId
     * @param int $CreatedBy
     * @param DateTime $DateCreated
     * @param DateTime $DateCompleted
     * @param int $CompletedBy
     * @param DateTime $DateDeleted
     * @param int $DeletedBy
     */
    public function __construct(
        string $TaskId='',
        ?string $Description=null,
        DateTime $DueDate=new DateTime(),
        int $AssignedToAgentId=0,
        int $RelatedToContactId=0,
        int $CreatedBy=0,
        DateTime $DateCreated=new DateTime(),
        DateTime $DateCompleted=new DateTime(),
        int $CompletedBy=0,
        DateTime $DateDeleted=new DateTime(),
        int $DeletedBy=0,
        /** @var string|null */
        public ?string $AssignedToName=null,
        /** @var string|null */
        public ?string $RelatedToName=null
    ) {
        parent::__construct($TaskId,$Description,$DueDate,$AssignedToAgentId,$RelatedToContactId,$CreatedBy,$DateCreated,$DateCompleted,$CompletedBy,$DateDeleted,$DeletedBy);
    }

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

class TaskResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<TaskExtended>|null */
        public ?array $Task=null
    ) {
    }

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

class TaskRequest implements JsonSerializable
{
    public function __construct(
        /** @var TaskExtended|null */
        public ?TaskExtended $Task=null,
        /** @var string */
        public string $TaskId=''
    ) {
    }

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

PHP TaskRequest 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/Task HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TaskRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Task>
    <AssignedToAgentId>0</AssignedToAgentId>
    <CompletedBy>0</CompletedBy>
    <CreatedBy>0</CreatedBy>
    <DateCompleted>0001-01-01T00:00:00</DateCompleted>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <DateDeleted>0001-01-01T00:00:00</DateDeleted>
    <DeletedBy>0</DeletedBy>
    <Description>String</Description>
    <DueDate>0001-01-01T00:00:00</DueDate>
    <RelatedToContactId>0</RelatedToContactId>
    <TaskId>00000000-0000-0000-0000-000000000000</TaskId>
    <AssignedToName>String</AssignedToName>
    <RelatedToName>String</RelatedToName>
  </Task>
  <TaskId>00000000-0000-0000-0000-000000000000</TaskId>
</TaskRequest>

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

<TaskResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Task>
    <TaskExtended>
      <AssignedToAgentId>0</AssignedToAgentId>
      <CompletedBy>0</CompletedBy>
      <CreatedBy>0</CreatedBy>
      <DateCompleted>0001-01-01T00:00:00</DateCompleted>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateDeleted>0001-01-01T00:00:00</DateDeleted>
      <DeletedBy>0</DeletedBy>
      <Description>String</Description>
      <DueDate>0001-01-01T00:00:00</DueDate>
      <RelatedToContactId>0</RelatedToContactId>
      <TaskId>00000000-0000-0000-0000-000000000000</TaskId>
      <AssignedToName>String</AssignedToName>
      <RelatedToName>String</RelatedToName>
    </TaskExtended>
  </Task>
</TaskResponse>