DigiOffice Gateway Web Services

<back to all web services

GetUsersAndGroupsForTransition

Get available users and groups to assign to a transition.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.Workflow.API.Operations
Imports IDB.API.DTO.UserInformation
Imports IDB.API.DTO
Imports IDB.API.DTO.Controls.QuickLookup

Namespace Global

    Namespace IDB.API.DTO

        Public Partial Class UserOrGroup
            Public Overridable Property ID As Integer
            Public Overridable Property Title As String
            Public Overridable Property IsChecked As Boolean
            Public Overridable Property Image As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.Controls.QuickLookup

        Public Partial Class QuickAddOption
            Public Overridable Property Name As String
            Public Overridable Property EntityType As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.UserInformation

        Public Partial Class UsersOrGroupsResponse
            Implements IBaseQuickLookupResponse
            Public Sub New()
                UsersOrGroups = New List(Of UserOrGroup)
                QuickAddOptions = New List(Of QuickAddOption)
            End Sub

            Public Overridable Property NumberOfAllRecords As Integer
            Public Overridable Property UsersOrGroups As List(Of UserOrGroup)
            Public Overridable Property QuickAddOptions As List(Of QuickAddOption)
        End Class
    End Namespace

    Namespace IDB.Workflow.API.Operations

        '''<Summary>
        '''Get available users and groups to assign to a transition.
        '''</Summary>
        <Api(Description:="Get available users and groups to assign to a transition.")>
        Public Partial Class GetUsersAndGroupsForTransition
            Public Sub New()
                SelectedUserIDs = New List(Of Integer)
                SelectedGroupIDs = New List(Of Integer)
            End Sub

            '''<Summary>
            '''ID of the transition
            '''</Summary>
            <ApiMember(Description:="ID of the transition", IsRequired:=true)>
            Public Overridable Property TransitionID As Guid

            Public Overridable Property PageSize As Integer
            Public Overridable Property PageNumber As Integer
            Public Overridable Property SearchCriteria As String
            Public Overridable Property SelectedUserIDs As List(Of Integer)
            Public Overridable Property SelectedGroupIDs As List(Of Integer)
        End Class
    End Namespace
End Namespace

VB.NET GetUsersAndGroupsForTransition DTOs

GET /api/workflowtransitions/{TransitionID}/getusersandgroups HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"NumberOfAllRecords":0,"UsersOrGroups":[{}],"QuickAddOptions":[{"Name":"String","EntityType":"String"}]}