DigiOffice API Services Services

<back to all web services

MarkAsReadTaskOperation

Mark a workflow task as (un)read.

Requires Authentication
The following routes are available for this service:
POST/api/workflowtasks/markasread
<?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};


/** @description Mark a workflow task as (un)read. */
// @Api(Description="Mark a workflow task as (un)read.")
class MarkAsReadTaskOperation implements JsonSerializable
{
    public function __construct(
        /** @description ID of the workflow task(s) to affect */
        // @ApiMember(Description="ID of the workflow task(s) to affect", IsRequired=true)
        /** @var int[] */
        public array $TaskIDs=[],

        /** @description Read status flag */
        // @ApiMember(Description="Read status flag", IsRequired=true)
        /** @var bool|null */
        public ?bool $Read=null
    ) {
    }

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

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

<MarkAsReadTaskOperation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.Operations">
  <Read>false</Read>
  <TaskIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TaskIDs>
</MarkAsReadTaskOperation>