DigiOffice Gateway Web Services

<back to all web services

GetUsersAndGroupsForTransition

Get available users and groups to assign to a transition.

Requires Authentication
The following routes are available for this service:
GET/api/workflowtransitions/{TransitionID}/getusersandgroups
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Get available users and groups to assign to a transition.
*/
@Api(Description="Get available users and groups to assign to a transition.")
open class GetUsersAndGroupsForTransition
{
    /**
    * ID of the transition
    */
    @ApiMember(Description="ID of the transition", IsRequired=true)
    var TransitionID:UUID? = null

    var PageSize:Int? = null
    var PageNumber:Int? = null
    var SearchCriteria:String? = null
    var SelectedUserIDs:ArrayList<Int> = ArrayList<Int>()
    var SelectedGroupIDs:ArrayList<Int> = ArrayList<Int>()
}

open class UsersOrGroupsResponse : IBaseQuickLookupResponse
{
    var NumberOfAllRecords:Int? = null
    var UsersOrGroups:ArrayList<UserOrGroup> = ArrayList<UserOrGroup>()
    var QuickAddOptions:ArrayList<QuickAddOption> = ArrayList<QuickAddOption>()
}

open class UserOrGroup
{
    var ID:Int? = null
    var Title:String? = null
    var IsChecked:Boolean? = null
    var Image:String? = null
}

open class QuickAddOption
{
    var Name:String? = null
    var EntityType:String? = null
}

Kotlin GetUsersAndGroupsForTransition DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/workflowtransitions/{TransitionID}/getusersandgroups HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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