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

export class UserOrGroup
{
    public ID: number;
    public Title: string;
    public IsChecked: boolean;
    public Image: string;

    public constructor(init?: Partial<UserOrGroup>) { (Object as any).assign(this, init); }
}

export class QuickAddOption
{
    public Name: string;
    public EntityType: string;

    public constructor(init?: Partial<QuickAddOption>) { (Object as any).assign(this, init); }
}

export class UsersOrGroupsResponse implements IBaseQuickLookupResponse
{
    public NumberOfAllRecords: number;
    public UsersOrGroups: UserOrGroup[];
    public QuickAddOptions: QuickAddOption[];

    public constructor(init?: Partial<UsersOrGroupsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get available users and groups to assign to a transition. */
// @Api(Description="Get available users and groups to assign to a transition.")
export class GetUsersAndGroupsForTransition
{
    /** @description ID of the transition */
    // @ApiMember(Description="ID of the transition", IsRequired=true)
    public TransitionID: string;

    public PageSize: number;
    public PageNumber: number;
    public SearchCriteria: string;
    public SelectedUserIDs: number[];
    public SelectedGroupIDs: number[];

    public constructor(init?: Partial<GetUsersAndGroupsForTransition>) { (Object as any).assign(this, init); }
}

TypeScript GetUsersAndGroupsForTransition DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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