Trendsic Platform Service

<back to all web services

NewAgentRequest

Requires Authentication
Required roles:Administrator, Administrator, Administrator
The following routes are available for this service:
GET,PUT,OPTIONS/v1/NewAgent/{AgentId}
GET,POST,OPTIONS/v1/NewAgent
<?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 NewAgent implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $FirstName=null,
        /** @var string|null */
        public ?string $LastName=null,
        /** @var string|null */
        public ?string $UserName=null,
        /** @var string|null */
        public ?string $Email=null,
        /** @var bool|null */
        public ?bool $IsAdmin=null
    ) {
    }

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

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

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

class NewAgentRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var array<NewAgent>|null */
        public ?array $NewAgent=null
    ) {
    }

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

PHP NewAgentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/NewAgent HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"AgentId":0,"NewAgent":[{"AgentId":0,"FirstName":"String","LastName":"String","UserName":"String","Email":"String","IsAdmin":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"NewAgent":[{"AgentId":0,"FirstName":"String","LastName":"String","UserName":"String","Email":"String","IsAdmin":false}]}