 | DataExportServiceGetAllParents Method |
Note: This API is now obsolete.
Namespace:
(Default Namespace)
Assembly:
SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntax[ObsoleteAttribute("Use GetAllPersons instead")]
public Person[] GetAllParents(
string authKey,
bool webusersOnly,
bool includeSpouseInfo,
bool includeStudents,
bool oneParentPerFamily
)
<ObsoleteAttribute("Use GetAllPersons instead")>
Public Function GetAllParents (
authKey As String,
webusersOnly As Boolean,
includeSpouseInfo As Boolean,
includeStudents As Boolean,
oneParentPerFamily As Boolean
) As Person()
public:
[ObsoleteAttribute(L"Use GetAllPersons instead")]
array<Person^>^ GetAllParents(
String^ authKey,
bool webusersOnly,
bool includeSpouseInfo,
bool includeStudents,
bool oneParentPerFamily
)
public function GetAllParents(
authKey : String,
webusersOnly : boolean,
includeSpouseInfo : boolean,
includeStudents : boolean,
oneParentPerFamily : boolean
) : Person[]
function GetAllParents(authKey, webusersOnly, includeSpouseInfo, includeStudents, oneParentPerFamily);
Parameters
- authKey
- Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService - webusersOnly
- Type: SystemBoolean
if set to True then only parents having web accounts will be returned. - 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. - oneParentPerFamily
- Type: SystemBoolean
if set to True, then the returned Person structure will include only one parent (name 1 or name 2).
Return Value
Type:
PersonA list of
Person objects.
Remarks
See Also