Trendsic Platform Service

<back to all web services

AgentNumberRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/AgentNumber
<?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 AgentNumber implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentNumberId=0,
        /** @var string|null */
        public ?string $Carrier=null,
        /** @var string|null */
        public ?string $AgentNumber=null,
        /** @var string|null */
        public ?string $AgentName=null,
        /** @var int */
        public int $AgentId=0
    ) {
    }

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

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

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

class AgentNumberRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<AgentNumber>|null */
        public ?array $AgentNumber=null
    ) {
    }

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

PHP AgentNumberRequest 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/AgentNumber HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"AgentNumber":[{"AgentNumberId":0,"Carrier":"String","AgentNumber":"String","AgentName":"String","AgentId":0}]}
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"}},"AgentNumber":[{"AgentNumberId":0,"Carrier":"String","AgentNumber":"String","AgentName":"String","AgentId":0}]}