Click or drag to resize

DataExportServiceGetAllWebUsersPaged Method

Gets all web users, returning only a selected number of records at a time.

Namespace:  (Default Namespace)
Assembly:  SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntax
public Person[] GetAllWebUsersPaged(
	string authKey,
	bool includeSpouseInfo,
	bool includeStudents,
	int numberOfRecords,
	int lastEntityNumber,
	DateTime lastUpdateDate
)

Parameters

authKey
Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService for a current administrator connection.
includeSpouseInfo
Type: SystemBoolean
If set to True, then the returned Person structure will include spouse information.
includeStudents
Type: SystemBoolean
If set to True, then the returned Person structure will include the Person's students' (children) information.
numberOfRecords
Type: SystemInt32
The number of records to return with this call.
lastEntityNumber
Type: SystemInt32
The last entity number. The next page of records will begin with persons with a higher entity number.
lastUpdateDate
Type: SystemDateTime
The last update date. The next page of records will only contain persons who have had changed made since this date.

Return Value

Type: Person
A list of Person objects.
Exceptions
ExceptionCondition
ApplicationExceptionInvalid authorization key
ApplicationExceptionInsufficient privileges
Remarks
Typically, this call is made in a loop for performance reasons. The first call, will have lastEntityNo = 0. The next call would contain the entity number of the last record.

The authorization key provided must be linked to an administrator role.

See Also