Trendsic Platform Service

FactFinderCodeStartRequest

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

The following routes are available for this service:
GET	/v1/FactFinderCodeStart

<?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 FactFinderCode implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var int */
        public int $AgentId=0,
        /** @var int */
        public int $SerialNumber=0,
        /** @var DateTime */
        public DateTime $ShipDate=new DateTime(),
        /** @var string|null */
        public ?string $TrackingNumber=null,
        /** @var DateTime */
        public DateTime $CreatedDate=new DateTime(),
        /** @var int */
        public int $ContactId=0,
        /** @var DateTime */
        public DateTime $AssignedDate=new DateTime(),
        /** @var string|null */
        public ?string $AgentName=null,
        /** @var string|null */
        public ?string $ContactName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['SerialNumber'])) $this->SerialNumber = $o['SerialNumber'];
        if (isset($o['ShipDate'])) $this->ShipDate = JsonConverters::from('DateTime', $o['ShipDate']);
        if (isset($o['TrackingNumber'])) $this->TrackingNumber = $o['TrackingNumber'];
        if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTime', $o['CreatedDate']);
        if (isset($o['ContactId'])) $this->ContactId = $o['ContactId'];
        if (isset($o['AssignedDate'])) $this->AssignedDate = JsonConverters::from('DateTime', $o['AssignedDate']);
        if (isset($o['AgentName'])) $this->AgentName = $o['AgentName'];
        if (isset($o['ContactName'])) $this->ContactName = $o['ContactName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->SerialNumber)) $o['SerialNumber'] = $this->SerialNumber;
        if (isset($this->ShipDate)) $o['ShipDate'] = JsonConverters::to('DateTime', $this->ShipDate);
        if (isset($this->TrackingNumber)) $o['TrackingNumber'] = $this->TrackingNumber;
        if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTime', $this->CreatedDate);
        if (isset($this->ContactId)) $o['ContactId'] = $this->ContactId;
        if (isset($this->AssignedDate)) $o['AssignedDate'] = JsonConverters::to('DateTime', $this->AssignedDate);
        if (isset($this->AgentName)) $o['AgentName'] = $this->AgentName;
        if (isset($this->ContactName)) $o['ContactName'] = $this->ContactName;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class FactFinderCodeStartRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

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

GET /v1/FactFinderCodeStart HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<FactFinderCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FactFinderCode>
    <FactFinderCode>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <AssignedDate>0001-01-01T00:00:00</AssignedDate>
      <ContactId>0</ContactId>
      <ContactName>String</ContactName>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Id>0</Id>
      <SerialNumber>0</SerialNumber>
      <ShipDate>0001-01-01T00:00:00</ShipDate>
      <TrackingNumber>String</TrackingNumber>
    </FactFinderCode>
  </FactFinderCode>
  <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>
</FactFinderCodeResponse>