DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTasks

Requires Authentication
<?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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/GetWorkflowTasks HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ViewID: 00000000-0000-0000-0000-000000000000,
	PageSize: 0,
	PageNumber: 0,
	SearchCriteria: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		ID: 0,
		Title: String,
		Description: String,
		ContextTitle: String,
		Project: String,
		Relation: String,
		ImageKey: String,
		Urgent: False,
		IsRead: False,
		AssignmentDate: 0001-01-01,
		CompletionDate: 0001-01-01,
		NumberOfComments: 0,
		ExtraField: String,
		HasPreview: False,
		Extension: String,
		IsInformative: False,
		HasPendingSideSteps: False,
		Actions: 
		[
			{
				ID: 0,
				Title: String,
				Type: String,
				UseDialog: False
			}
		],
		CanAccept: False
	}
]