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

import Foundation
import ServiceStack

/**
* Get available users and groups to assign to a transition.
*/
// @Api(Description="Get available users and groups to assign to a transition.")
public class GetUsersAndGroupsForTransition : Codable
{
    /**
    * ID of the transition
    */
    // @ApiMember(Description="ID of the transition", IsRequired=true)
    public var transitionID:String

    public var pageSize:Int
    public var pageNumber:Int
    public var searchCriteria:String
    public var selectedUserIDs:[Int] = []
    public var selectedGroupIDs:[Int] = []

    required public init(){}
}

public class UsersOrGroupsResponse : IBaseQuickLookupResponse, Codable
{
    public var numberOfAllRecords:Int
    public var usersOrGroups:[UserOrGroup] = []
    public var quickAddOptions:[QuickAddOption] = []

    required public init(){}
}

public class UserOrGroup : Codable
{
    public var id:Int
    public var title:String
    public var isChecked:Bool
    public var image:String

    required public init(){}
}

public class QuickAddOption : Codable
{
    public var name:String
    public var entityType:String

    required public init(){}
}

Swift 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: doapigw.baasbv.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>