DigiOffice Gateway Web Services

<back to all web services

GetUsersAndGroups

Requires Authentication
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetUsersAndGroups
    {
        public Integer UserEnvironment = null;
        public Integer PageSize = null;
        public Integer PageNumber = null;
        public String SearchCriteria = null;
        public ArrayList<Integer> SelectedUserIDs = null;
        public ArrayList<Integer> SelectedGroupIDs = null;
        
        public Integer getUserEnvironment() { return UserEnvironment; }
        public GetUsersAndGroups setUserEnvironment(Integer value) { this.UserEnvironment = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public GetUsersAndGroups setPageSize(Integer value) { this.PageSize = value; return this; }
        public Integer getPageNumber() { return PageNumber; }
        public GetUsersAndGroups setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public String getSearchCriteria() { return SearchCriteria; }
        public GetUsersAndGroups setSearchCriteria(String value) { this.SearchCriteria = value; return this; }
        public ArrayList<Integer> getSelectedUserIDs() { return SelectedUserIDs; }
        public GetUsersAndGroups setSelectedUserIDs(ArrayList<Integer> value) { this.SelectedUserIDs = value; return this; }
        public ArrayList<Integer> getSelectedGroupIDs() { return SelectedGroupIDs; }
        public GetUsersAndGroups 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 GetUsersAndGroups 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.

POST /xml/reply/GetUsersAndGroups HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetUsersAndGroups xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.UserInformation.Operations">
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <SearchCriteria>String</SearchCriteria>
  <SelectedGroupIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </SelectedGroupIDs>
  <SelectedUserIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </SelectedUserIDs>
  <UserEnvironment>0</UserEnvironment>
</GetUsersAndGroups>
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>