 | UserProfileServicegetUserInfo Method |
Gets the Person information for a user.
Namespace:
(Default Namespace)
Assembly:
SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntaxpublic Person getUserInfo(
string authKey,
bool includeSpouseInfo,
bool includeStudents
)
Public Function getUserInfo (
authKey As String,
includeSpouseInfo As Boolean,
includeStudents As Boolean
) As Person
public:
Person^ getUserInfo(
String^ authKey,
bool includeSpouseInfo,
bool includeStudents
)
public function getUserInfo(
authKey : String,
includeSpouseInfo : boolean,
includeStudents : boolean
) : Person
function getUserInfo(authKey, includeSpouseInfo, includeStudents);
Parameters
- authKey
- Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService - 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 a currently logged in user. The
Person object
returned contains information for the user attached to the Authorization Key.
See Also