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

"use strict";
export class UserOrGroup {
    /** @param {{ID?:number,Title?:string,IsChecked?:boolean,Image?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Title;
    /** @type {boolean} */
    IsChecked;
    /** @type {string} */
    Image;
}
export class QuickAddOption {
    /** @param {{Name?:string,EntityType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    EntityType;
}
export class UsersOrGroupsResponse {
    /** @param {{NumberOfAllRecords?:number,UsersOrGroups?:UserOrGroup[],QuickAddOptions?:QuickAddOption[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    NumberOfAllRecords;
    /** @type {UserOrGroup[]} */
    UsersOrGroups;
    /** @type {QuickAddOption[]} */
    QuickAddOptions;
}
export class GetUsersAndGroupsForTransition {
    /** @param {{TransitionID?:string,PageSize?:number,PageNumber?:number,SearchCriteria?:string,SelectedUserIDs?:number[],SelectedGroupIDs?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID of the transition */
    TransitionID;
    /** @type {number} */
    PageSize;
    /** @type {number} */
    PageNumber;
    /** @type {string} */
    SearchCriteria;
    /** @type {number[]} */
    SelectedUserIDs;
    /** @type {number[]} */
    SelectedGroupIDs;
}

JavaScript 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: dogw.klokgroep.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>