Trendsic Platform Service

<back to all web services

FactFillerQueueRequest

Requires Authentication
The following routes are available for this service:
GET/v1/FactFillerQueue/{Id}
GET/v1/FactFillerQueue
<?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 FactFillerQueue implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Id='',
        /** @var string */
        public string $AttachmentId='',
        /** @var int */
        public int $AgentId=0,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var bool|null */
        public ?bool $Locked=null,
        /** @var DateTime */
        public DateTime $DateLocked=new DateTime(),
        /** @var bool|null */
        public ?bool $Completed=null,
        /** @var DateTime */
        public DateTime $DateCompleted=new DateTime(),
        /** @var string|null */
        public ?string $CompletedBy=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['AttachmentId'])) $this->AttachmentId = $o['AttachmentId'];
        if (isset($o['AgentId'])) $this->AgentId = $o['AgentId'];
        if (isset($o['DateCreated'])) $this->DateCreated = JsonConverters::from('DateTime', $o['DateCreated']);
        if (isset($o['Locked'])) $this->Locked = $o['Locked'];
        if (isset($o['DateLocked'])) $this->DateLocked = JsonConverters::from('DateTime', $o['DateLocked']);
        if (isset($o['Completed'])) $this->Completed = $o['Completed'];
        if (isset($o['DateCompleted'])) $this->DateCompleted = JsonConverters::from('DateTime', $o['DateCompleted']);
        if (isset($o['CompletedBy'])) $this->CompletedBy = $o['CompletedBy'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->AttachmentId)) $o['AttachmentId'] = $this->AttachmentId;
        if (isset($this->AgentId)) $o['AgentId'] = $this->AgentId;
        if (isset($this->DateCreated)) $o['DateCreated'] = JsonConverters::to('DateTime', $this->DateCreated);
        if (isset($this->Locked)) $o['Locked'] = $this->Locked;
        if (isset($this->DateLocked)) $o['DateLocked'] = JsonConverters::to('DateTime', $this->DateLocked);
        if (isset($this->Completed)) $o['Completed'] = $this->Completed;
        if (isset($this->DateCompleted)) $o['DateCompleted'] = JsonConverters::to('DateTime', $this->DateCompleted);
        if (isset($this->CompletedBy)) $o['CompletedBy'] = $this->CompletedBy;
        return empty($o) ? new class(){} : $o;
    }
}

class FactFillerQueueResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var FactFillerQueue|null */
        public ?FactFillerQueue $FactFillerQueue=null,
        /** @var bool|null */
        public ?bool $Success=null
    ) {
    }

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

class FactFillerQueueRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $Id=''
    ) {
    }

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

PHP FactFillerQueueRequest 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/FactFillerQueue/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FactFillerQueueResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FactFillerQueue>
    <AgentId>0</AgentId>
    <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
    <Completed>false</Completed>
    <CompletedBy>String</CompletedBy>
    <DateCompleted>0001-01-01T00:00:00</DateCompleted>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <DateLocked>0001-01-01T00:00:00</DateLocked>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Locked>false</Locked>
  </FactFillerQueue>
  <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>
  <Success>false</Success>
</FactFillerQueueResponse>