DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTask

Requires Authentication
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Workflow.Operations;
using IDB.API.DTO.Workflow;

namespace IDB.API.DTO.Workflow
{
    [DataContract]
    public partial class WorkflowTask
    {
        public WorkflowTask()
        {
            Actions = new List<WorkflowTaskAction>{};
        }

        [DataMember]
        public virtual int ID { get; set; }

        [DataMember]
        public virtual Guid DocumentID { get; set; }

        [DataMember]
        public virtual string Title { get; set; }

        [DataMember]
        public virtual string Description { get; set; }

        [DataMember]
        public virtual string ContextTitle { get; set; }

        [DataMember]
        public virtual string Project { get; set; }

        [DataMember]
        public virtual string Relation { get; set; }

        [DataMember]
        public virtual string ImageKey { get; set; }

        [DataMember]
        public virtual bool Urgent { get; set; }

        [DataMember]
        public virtual bool IsRead { get; set; }

        [DataMember]
        public virtual DateTime? AssignmentDate { get; set; }

        [DataMember]
        public virtual DateTime? CompletionDate { get; set; }

        [DataMember]
        public virtual int NumberOfComments { get; set; }

        [DataMember]
        public virtual string ExtraField { get; set; }

        [DataMember]
        public virtual bool HasPreview { get; set; }

        [DataMember]
        public virtual string Extension { get; set; }

        [DataMember]
        public virtual bool IsInformative { get; set; }

        [DataMember]
        public virtual bool HasPendingSideSteps { get; set; }

        [DataMember]
        public virtual List<WorkflowTaskAction> Actions { get; set; }

        [DataMember]
        public virtual bool CanAccept { get; set; }
    }

    public partial class WorkflowTaskAction
    {
        public virtual int ID { get; set; }
        public virtual string Title { get; set; }
        public virtual string Type { get; set; }
        public virtual bool UseDialog { get; set; }
        public virtual Guid ConnectionID { get; set; }
    }

}

namespace IDB.API.DTO.Workflow.Operations
{
    public partial class GetWorkflowTask
        : IHasVersion
    {
        public virtual int ID { get; set; }
        public virtual int Version { get; set; }
    }

}

C# GetWorkflowTask 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/GetWorkflowTask HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetWorkflowTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow.Operations">
  <ID>0</ID>
  <Version>0</Version>
</GetWorkflowTask>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow">
  <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>