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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/GetUsersAndGroups HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DTO.UserInformation.Operations.GetUsersAndGroups, IDB.API.DTO",
	UserEnvironment: 0,
	PageSize: 0,
	PageNumber: 0,
	SearchCriteria: String,
	SelectedUserIDs: 
	[
		0
	],
	SelectedGroupIDs: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DTO.UserInformation.UsersOrGroupsResponse, IDB.API.DTO",
	NumberOfAllRecords: 0,
	UsersOrGroups: 
	[
		{
			
		}
	],
	QuickAddOptions: 
	[
		{
			__type: "IDB.API.DTO.Controls.QuickLookup.QuickAddOption, IDB.API.DTO",
			Name: String,
			EntityType: String
		}
	]
}