 | 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)
Syntaxpublic Person getPersonInfoByEntityNo(
string authKey,
int entityNo,
bool includeSpouseInfo,
bool includeStudents
)
Public Function getPersonInfoByEntityNo (
authKey As String,
entityNo As Integer,
includeSpouseInfo As Boolean,
includeStudents As Boolean
) As Person
public:
Person^ getPersonInfoByEntityNo(
String^ authKey,
int entityNo,
bool includeSpouseInfo,
bool includeStudents
)
public function getPersonInfoByEntityNo(
authKey : String,
entityNo : int,
includeSpouseInfo : boolean,
includeStudents : boolean
) : Person
function getPersonInfoByEntityNo(authKey, entityNo, includeSpouseInfo, 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
Remarks
Use this routine for obtaining information on any user.
The authorization key provided must be linked to an administrator role.
See Also