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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Mark a workflow task as (un)read.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MarkAsReadTaskOperation:
    """
    Mark a workflow task as (un)read.
    """

    # @ApiMember(Description="ID of the workflow task(s) to affect", IsRequired=true)
    task_i_ds: List[int] = field(default_factory=list)
    """
    ID of the workflow task(s) to affect
    """


    # @ApiMember(Description="Read status flag", IsRequired=true)
    read: bool = False
    """
    Read status flag
    """

Python 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>