Trendsic Platform Service

<back to all web services

EngineExpirySweepRequest

Requires Authentication
The following routes are available for this service:
GET,POST,OPTIONS/v1/engine/sweeps/before-a-date
<?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 EngineExpirySweepResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $Swept=null,
        /** @var string|null */
        public ?string $Why=null,
        /** @var string|null */
        public ?string $LocalDate=null,
        /** @var array<int>|null */
        public ?array $CertMilestones=null,
        /** @var array<int>|null */
        public ?array $DocMilestones=null,
        /** @var array<int>|null */
        public ?array $ListeningWorkflowIds=null,
        /** @var int */
        public int $Steps=0,
        /** @var int */
        public int $Claimed=0,
        /** @var int */
        public int $Written=0,
        /** @var int */
        public int $Released=0,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Swept'])) $this->Swept = $o['Swept'];
        if (isset($o['Why'])) $this->Why = $o['Why'];
        if (isset($o['LocalDate'])) $this->LocalDate = $o['LocalDate'];
        if (isset($o['CertMilestones'])) $this->CertMilestones = JsonConverters::fromArray('int', $o['CertMilestones']);
        if (isset($o['DocMilestones'])) $this->DocMilestones = JsonConverters::fromArray('int', $o['DocMilestones']);
        if (isset($o['ListeningWorkflowIds'])) $this->ListeningWorkflowIds = JsonConverters::fromArray('int', $o['ListeningWorkflowIds']);
        if (isset($o['Steps'])) $this->Steps = $o['Steps'];
        if (isset($o['Claimed'])) $this->Claimed = $o['Claimed'];
        if (isset($o['Written'])) $this->Written = $o['Written'];
        if (isset($o['Released'])) $this->Released = $o['Released'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Swept)) $o['Swept'] = $this->Swept;
        if (isset($this->Why)) $o['Why'] = $this->Why;
        if (isset($this->LocalDate)) $o['LocalDate'] = $this->LocalDate;
        if (isset($this->CertMilestones)) $o['CertMilestones'] = JsonConverters::toArray('int', $this->CertMilestones);
        if (isset($this->DocMilestones)) $o['DocMilestones'] = JsonConverters::toArray('int', $this->DocMilestones);
        if (isset($this->ListeningWorkflowIds)) $o['ListeningWorkflowIds'] = JsonConverters::toArray('int', $this->ListeningWorkflowIds);
        if (isset($this->Steps)) $o['Steps'] = $this->Steps;
        if (isset($this->Claimed)) $o['Claimed'] = $this->Claimed;
        if (isset($this->Written)) $o['Written'] = $this->Written;
        if (isset($this->Released)) $o['Released'] = $this->Released;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class EngineExpirySweepRequest implements JsonSerializable
{
    public function __construct(
        /** @var int|null */
        public ?int $WorkflowId=null
    ) {
    }

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

PHP EngineExpirySweepRequest 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/engine/sweeps/before-a-date HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EngineExpirySweepRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <WorkflowId>0</WorkflowId>
</EngineExpirySweepRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineExpirySweepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CertMilestones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </CertMilestones>
  <Claimed>0</Claimed>
  <DocMilestones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DocMilestones>
  <ListeningWorkflowIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ListeningWorkflowIds>
  <LocalDate>String</LocalDate>
  <Released>0</Released>
  <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>
  <Steps>0</Steps>
  <Swept>false</Swept>
  <Why>String</Why>
  <Written>0</Written>
</EngineExpirySweepResponse>