DigiOffice Gateway Web Services

<back to all web services

GetUsersAndGroups

Requires Authentication
GetUsersAndGroups Parameters:
NameParameterData TypeRequiredDescription
UserEnvironmentqueryintNo
PageSizequeryintNo
PageNumberqueryintNo
SearchCriteriaquerystringNo
SelectedUserIDsqueryList<int>No
SelectedGroupIDsqueryList<int>No
UsersOrGroupsResponse Parameters:
NameParameterData TypeRequiredDescription
NumberOfAllRecordsformintNo
UsersOrGroupsformList<UserOrGroup>No
QuickAddOptionsformList<QuickAddOption>No
UserOrGroup Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
TitleformstringNo
IsCheckedformboolNo
ImageformstringNo
QuickAddOption Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EntityTypeformstringNo

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.

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

{"UserEnvironment":0,"PageSize":0,"PageNumber":0,"SearchCriteria":"String","SelectedUserIDs":[0],"SelectedGroupIDs":[0]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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