DigiOffice Gateway Web Services

GetUsersAndGroupsForTransition

Get available users and groups to assign to a transition.

The following routes are available for this service:
GET	/api/workflowtransitions/{TransitionID}/getusersandgroups

namespace IDB.API.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type UserOrGroup() = 
        member val ID:Int32 = new Int32() with get,set
        member val Title:String = null with get,set
        member val IsChecked:Boolean = new Boolean() with get,set
        member val Image:String = null with get,set

    [<AllowNullLiteral>]
    type QuickAddOption() = 
        member val Name:String = null with get,set
        member val EntityType:String = null with get,set

    [<AllowNullLiteral>]
    type UsersOrGroupsResponse() = 
        member val NumberOfAllRecords:Int32 = new Int32() with get,set
        member val UsersOrGroups:ResizeArray<UserOrGroup> = new ResizeArray<UserOrGroup>() with get,set
        member val QuickAddOptions:ResizeArray<QuickAddOption> = new ResizeArray<QuickAddOption>() with get,set

    ///<summary>
    ///Get available users and groups to assign to a transition.
    ///</summary>
    [<Api(Description="Get available users and groups to assign to a transition.")>]
    [<AllowNullLiteral>]
    type GetUsersAndGroupsForTransition() = 
        ///<summary>
        ///ID of the transition
        ///</summary>
        [<ApiMember(Description="ID of the transition", IsRequired=true)>]
        member val TransitionID:Guid = new Guid() with get,set

        member val PageSize:Int32 = new Int32() with get,set
        member val PageNumber:Int32 = new Int32() with get,set
        member val SearchCriteria:String = null with get,set
        member val SelectedUserIDs:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val SelectedGroupIDs:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set

F# GetUsersAndGroupsForTransition 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.

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>