DigiOffice API Services Services

GetWorkflowTasks

<?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};


// @DataContract
class GetWorkflowTasks implements IPageOptions, ISearchCriteria, JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $ViewID=null,

        // @DataMember
        /** @var int */
        public int $PageSize=0,

        // @DataMember
        /** @var int */
        public int $PageNumber=0,

        // @DataMember
        /** @var string|null */
        public ?string $SearchCriteria=null
    ) {
    }

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

PHP GetWorkflowTasks 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 /xml/reply/GetWorkflowTasks HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetWorkflowTasks xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow.Operations">
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <SearchCriteria>String</SearchCriteria>
  <ViewID>00000000-0000-0000-0000-000000000000</ViewID>
</GetWorkflowTasks>

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

<ArrayOfWorkflowTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow">
  <WorkflowTask>
    <Actions>
      <WorkflowTaskAction>
        <ConnectionID>00000000-0000-0000-0000-000000000000</ConnectionID>
        <ID>0</ID>
        <Title>String</Title>
        <Type>String</Type>
        <UseDialog>false</UseDialog>
      </WorkflowTaskAction>
    </Actions>
    <AssignmentDate>0001-01-01T00:00:00</AssignmentDate>
    <CanAccept>false</CanAccept>
    <CompletionDate>0001-01-01T00:00:00</CompletionDate>
    <ContextTitle>String</ContextTitle>
    <Description>String</Description>
    <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
    <Extension>String</Extension>
    <ExtraField>String</ExtraField>
    <HasPendingSideSteps>false</HasPendingSideSteps>
    <HasPreview>false</HasPreview>
    <ID>0</ID>
    <ImageKey>String</ImageKey>
    <IsInformative>false</IsInformative>
    <IsRead>false</IsRead>
    <NumberOfComments>0</NumberOfComments>
    <Project>String</Project>
    <Relation>String</Relation>
    <Title>String</Title>
    <Urgent>false</Urgent>
  </WorkflowTask>
</ArrayOfWorkflowTask>