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

GET /api/workflowtransitions/{TransitionID}/getusersandgroups HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
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>