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
GetUsersAndGroupsForTransition Parameters:
NameParameterData TypeRequiredDescription
TransitionIDpathGuidYesID of the transition
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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