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

public class dtos
{

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

        public Integer PageSize = null;
        public Integer PageNumber = null;
        public String SearchCriteria = null;
        public ArrayList<Integer> SelectedUserIDs = null;
        public ArrayList<Integer> SelectedGroupIDs = null;
        
        public UUID getTransitionID() { return TransitionID; }
        public GetUsersAndGroupsForTransition setTransitionID(UUID value) { this.TransitionID = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public GetUsersAndGroupsForTransition setPageSize(Integer value) { this.PageSize = value; return this; }
        public Integer getPageNumber() { return PageNumber; }
        public GetUsersAndGroupsForTransition setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public String getSearchCriteria() { return SearchCriteria; }
        public GetUsersAndGroupsForTransition setSearchCriteria(String value) { this.SearchCriteria = value; return this; }
        public ArrayList<Integer> getSelectedUserIDs() { return SelectedUserIDs; }
        public GetUsersAndGroupsForTransition setSelectedUserIDs(ArrayList<Integer> value) { this.SelectedUserIDs = value; return this; }
        public ArrayList<Integer> getSelectedGroupIDs() { return SelectedGroupIDs; }
        public GetUsersAndGroupsForTransition setSelectedGroupIDs(ArrayList<Integer> value) { this.SelectedGroupIDs = value; return this; }
    }

    public static class UsersOrGroupsResponse implements IBaseQuickLookupResponse
    {
        public Integer NumberOfAllRecords = null;
        public ArrayList<UserOrGroup> UsersOrGroups = null;
        public ArrayList<QuickAddOption> QuickAddOptions = null;
        
        public Integer getNumberOfAllRecords() { return NumberOfAllRecords; }
        public UsersOrGroupsResponse setNumberOfAllRecords(Integer value) { this.NumberOfAllRecords = value; return this; }
        public ArrayList<UserOrGroup> getUsersOrGroups() { return UsersOrGroups; }
        public UsersOrGroupsResponse setUsersOrGroups(ArrayList<UserOrGroup> value) { this.UsersOrGroups = value; return this; }
        public ArrayList<QuickAddOption> getQuickAddOptions() { return QuickAddOptions; }
        public UsersOrGroupsResponse setQuickAddOptions(ArrayList<QuickAddOption> value) { this.QuickAddOptions = value; return this; }
    }

    public static class UserOrGroup
    {
        public Integer ID = null;
        public String Title = null;
        public Boolean IsChecked = null;
        public String Image = null;
        
        public Integer getId() { return ID; }
        public UserOrGroup setId(Integer value) { this.ID = value; return this; }
        public String getTitle() { return Title; }
        public UserOrGroup setTitle(String value) { this.Title = value; return this; }
        public Boolean getIsChecked() { return IsChecked; }
        public UserOrGroup setIsChecked(Boolean value) { this.IsChecked = value; return this; }
        public String getImage() { return Image; }
        public UserOrGroup setImage(String value) { this.Image = value; return this; }
    }

    public static class QuickAddOption
    {
        public String Name = null;
        public String EntityType = null;
        
        public String getName() { return Name; }
        public QuickAddOption setName(String value) { this.Name = value; return this; }
        public String getEntityType() { return EntityType; }
        public QuickAddOption setEntityType(String value) { this.EntityType = value; return this; }
    }

}

Java GetUsersAndGroupsForTransition DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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