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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.Workflow.API.Operations;
using IDB.API.DTO.UserInformation;
using IDB.API.DTO;
using IDB.API.DTO.Controls.QuickLookup;

namespace IDB.API.DTO
{
    public partial class UserOrGroup
    {
        public virtual int ID { get; set; }
        public virtual string Title { get; set; }
        public virtual bool IsChecked { get; set; }
        public virtual string Image { get; set; }
    }

}

namespace IDB.API.DTO.Controls.QuickLookup
{
    public partial class QuickAddOption
    {
        public virtual string Name { get; set; }
        public virtual string EntityType { get; set; }
    }

}

namespace IDB.API.DTO.UserInformation
{
    public partial class UsersOrGroupsResponse
        : IBaseQuickLookupResponse
    {
        public UsersOrGroupsResponse()
        {
            UsersOrGroups = new List<UserOrGroup>{};
            QuickAddOptions = new List<QuickAddOption>{};
        }

        public virtual int NumberOfAllRecords { get; set; }
        public virtual List<UserOrGroup> UsersOrGroups { get; set; }
        public virtual List<QuickAddOption> QuickAddOptions { get; set; }
    }

}

namespace IDB.Workflow.API.Operations
{
    ///<summary>
    ///Get available users and groups to assign to a transition.
    ///</summary>
    [Api(Description="Get available users and groups to assign to a transition.")]
    public partial class GetUsersAndGroupsForTransition
    {
        public GetUsersAndGroupsForTransition()
        {
            SelectedUserIDs = new List<int>{};
            SelectedGroupIDs = new List<int>{};
        }

        ///<summary>
        ///ID of the transition
        ///</summary>
        [ApiMember(Description="ID of the transition", IsRequired=true)]
        public virtual Guid TransitionID { get; set; }

        public virtual int PageSize { get; set; }
        public virtual int PageNumber { get; set; }
        public virtual string SearchCriteria { get; set; }
        public virtual List<int> SelectedUserIDs { get; set; }
        public virtual List<int> SelectedGroupIDs { get; set; }
    }

}

C# 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>