Skip to main content

UserPagedRequest

UserPagedRequest

FieldNULLDescriptionNote
searchByRole
arrray of objects		 An array of RoleDetail objects 
visibleUserIds
array of string (GUID)		 The list of visible users’ ids that the current user can view, search, sort 
userModeType
integer		 


  • 0 = All
  • 1 = Access
  • 2 = Schedule
 
includeRootAdminIfMatch
boolean		 Whether to include root admin if matching 

Inherited fields:

PagedRequest

FieldNULLDescriptionNote
tenantId
string (GUID)		YThe id of the tenant 
criteria
array of objects		 An array of SearchCriteria objects 
sortOrders
array of objects		 An array of SortOrder objects 
parentIds
array of strings (GUIDs)		 Ids of the parents 
pageIndex
integer		 The index of the pageInherited from PagingInfo
pageSize
integer		 The size of the pageInherited from PagingInfo
total
integer		 The total number of rowsInherited from PagingInfo
skipItems
integer		 Skip itemsInherited from PagingInfo
isLastPage
boolean		 Whether this is the last pageInherited from PagingInfo
PagedRequest Sample:
{"criteria":[{"key":"All","value":"","operation":1}],"pageIndex":1,"pageSize":10,"sortOrders":[{"key":"shareWith","descending":true}]}
UserPagedRequest Sample:
{"tenantId":null,"criteria":[{"key":"All","value":"","operation":1}],"pageIndex":1,"pageSize":10,"sortOrders":[{"key":"userName","descending":true}]}