Trendsic Platform Service

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

<NewAgentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentId>0</AgentId>
  <NewAgent>
    <NewAgent>
      <AgentId>0</AgentId>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <IsAdmin>false</IsAdmin>
      <LastName>String</LastName>
      <UserName>String</UserName>
    </NewAgent>
  </NewAgent>
</NewAgentRequest>

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

<NewAgentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <NewAgent>
    <NewAgent>
      <AgentId>0</AgentId>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <IsAdmin>false</IsAdmin>
      <LastName>String</LastName>
      <UserName>String</UserName>
    </NewAgent>
  </NewAgent>
  <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>
</NewAgentResponse>