Click or drag to resize

DataExportServiceGetAllParentsByFamilyID Method

Gets all person information for all parents in a family.

Namespace:  (Default Namespace)
Assembly:  SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntax
public Person[] GetAllParentsByFamilyID(
	string authKey,
	string sFamilyID,
	bool includeSpouseInfo,
	bool includeStudents
)

Parameters

authKey
Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService for a current administrator connection.
sFamilyID
Type: SystemString
The family ID.
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 list of Person objects.
Exceptions
ExceptionCondition
ApplicationExceptionInvalid authorization key
ApplicationExceptionInsufficient privileges
Remarks
The authorization key provided must be linked to an administrator role.
See Also