 | DataExportServiceGetAllConstituents 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[] GetAllConstituents(
string authKey,
string constituency,
bool webusersOnly,
bool includeSpouseInfo,
bool includeStudents,
int lastEntityNo,
int pageSize
)
<ObsoleteAttribute("Use GetAllPersons instead")>
Public Function GetAllConstituents (
authKey As String,
constituency As String,
webusersOnly As Boolean,
includeSpouseInfo As Boolean,
includeStudents As Boolean,
lastEntityNo As Integer,
pageSize As Integer
) As Person()
public:
[ObsoleteAttribute(L"Use GetAllPersons instead")]
array<Person^>^ GetAllConstituents(
String^ authKey,
String^ constituency,
bool webusersOnly,
bool includeSpouseInfo,
bool includeStudents,
int lastEntityNo,
int pageSize
)
public function GetAllConstituents(
authKey : String,
constituency : String,
webusersOnly : boolean,
includeSpouseInfo : boolean,
includeStudents : boolean,
lastEntityNo : int,
pageSize : int
) : Person[]
function GetAllConstituents(authKey, constituency, webusersOnly, includeSpouseInfo, includeStudents, lastEntityNo, pageSize);
Parameters
- authKey
- Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService - constituency
- Type: SystemString
The constituency. - 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. - lastEntityNo
- Type: SystemInt32
The last entity number. The next page of records will begin with persons with a higher entity number. - pageSize
- Type: SystemInt32
The number of records to return with this call.
Return Value
Type:
PersonA list of
Person objects.
Remarks
See Also