Trendsic Platform Service

<back to all web services

PmTodosRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pm/todos/{Uid}
<?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 PmTodo implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $TaskId='',
        /** @var string|null */
        public ?string $Description=null,
        /** @var DateTime|null */
        public ?DateTime $DueDate=null,
        /** @var int|null */
        public ?int $AssignedToAgentId=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $Color=null,
        /** @var DateTime|null */
        public ?DateTime $DateCompleted=null
    ) {
    }

    /** @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['Status'])) $this->Status = $o['Status'];
        if (isset($o['Color'])) $this->Color = $o['Color'];
        if (isset($o['DateCompleted'])) $this->DateCompleted = JsonConverters::from('DateTime', $o['DateCompleted']);
    }
    
    /** @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->Status)) $o['Status'] = $this->Status;
        if (isset($this->Color)) $o['Color'] = $this->Color;
        if (isset($this->DateCompleted)) $o['DateCompleted'] = JsonConverters::to('DateTime', $this->DateCompleted);
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class PmTodosRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Uid=null
    ) {
    }

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

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

GET /v1/pm/todos/{Uid} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Todos: 
	[
		{
			TaskId: 00000000000000000000000000000000,
			Description: String,
			DueDate: 0001-01-01,
			AssignedToAgentId: 0,
			Status: String,
			Color: String,
			DateCompleted: 0001-01-01
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}