Click or drag to resize

UserProfileServicegetPersonInfoByEntityNo Method

Gets the Person information given a person's entity number.

Namespace:  (Default Namespace)
Assembly:  SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntax
public Person getPersonInfoByEntityNo(
	string authKey,
	int entityNo,
	bool includeSpouseInfo,
	bool includeStudents
)

Parameters

authKey
Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService for a current administrator connection.
entityNo
Type: SystemInt32
The entity number
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.

Return Value

Type: Person
A Person object.
Exceptions
ExceptionCondition
ApplicationExceptionInvalid authorization key
Remarks
Use this routine for obtaining information on any user.

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

See Also