DigiOffice Gateway Web Services

GetUsersAndGroupsForTransition

Get available users and groups to assign to a transition.

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 .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.

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UsersOrGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.UserInformation">
  <NumberOfAllRecords>0</NumberOfAllRecords>
  <QuickAddOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Controls.QuickLookup">
    <d2p1:QuickAddOption>
      <d2p1:EntityType>String</d2p1:EntityType>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:QuickAddOption>
  </QuickAddOptions>
  <UsersOrGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO">
    <d2p1:UserOrGroup i:nil="true" />
  </UsersOrGroups>
</UsersOrGroupsResponse>