GetUsersByApplicationId

Note: This is only for the MTOA Platform Team.

Description

Retrieve internal users based on application id

Package Details

Interface

IUserApplicationManagementManager

Syntax

await UserApplicationManagementManager.GetUsersByApplicationId(int appId,  int? page = null, int? pageSize = null, string userName = "", string emailAddress = "", UserRoleType? userRoleType = null, int? servId = null);

Returns

UserApplicationInfoResult

API

GET - /api/v1/userapplications/{id}/users

Parameters

Parameter	Description	Type
appId	The identification number of the application.	Path
page	page number. Optional. If it is empty, the default value is 1	Query string
pageSize	size of the page. Optional. (default value is the MTOA max page size (100)).	Query string
userName	Optional. If it is entered, it will search users of the first name of last name that contains the value. Email address and name are entered, it will search users that have the email address or the user name.	Query string
emailAddress	Optional. If it is entered, it will search email address that contains the value. Email address and name are entered, it will search users that have the email address or the user name.	Query string
UserRoleType	Optional. If it is entered, it will search users with the role.	Query string
ServId	Optional. If it is entered, it will search users that have access to the service	Query string

Returns

HTTP 200 - OK

Example

const int applicationId = 12;
const UserRoleType userRoleType = UserRoleType.InvoiceManager;

await _userApplicationManagementManager.GetUsersByApplicationId(applicationId, 1, 20);

await _userApplicationManagementManager.GetUsersByApplicationId(applicationId, 1, 20, null, "test");