DigiOffice Gateway Web Services

<back to all web services

GetUsersAndGroups

Requires Authentication

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); }
}

export class GetUsersAndGroups
{
    public UserEnvironment?: number;
    public PageSize?: number;
    public PageNumber?: number;
    public SearchCriteria?: string;
    public SelectedUserIDs?: number[];
    public SelectedGroupIDs?: number[];

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

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

POST /jsv/reply/GetUsersAndGroups HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserEnvironment: 0,
	PageSize: 0,
	PageNumber: 0,
	SearchCriteria: String,
	SelectedUserIDs: 
	[
		0
	],
	SelectedGroupIDs: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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