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

GET /api/workflowtransitions/{TransitionID}/getusersandgroups HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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