DigiOffice API Services 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 java.io.InputStream
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)
    open var TransitionID:UUID? = null

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

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

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

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

Kotlin GetUsersAndGroupsForTransition DTOs

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

HTTP + OTHER

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: test-do-services.klokgroep.nl 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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