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
namespace IDB.Workflow.API.Operations

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Mark a workflow task as (un)read.
    ///</summary>
    [<Api(Description="Mark a workflow task as (un)read.")>]
    [<AllowNullLiteral>]
    type MarkAsReadTaskOperation() = 
        ///<summary>
        ///ID of the workflow task(s) to affect
        ///</summary>
        [<ApiMember(Description="ID of the workflow task(s) to affect", IsRequired=true)>]
        member val TaskIDs:Int32[] = null with get,set

        ///<summary>
        ///Read status flag
        ///</summary>
        [<ApiMember(Description="Read status flag", IsRequired=true)>]
        member val Read:Boolean = new Boolean() with get,set

F# 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>