![]() | Parameter Enumeration |
Namespace: SeniorSystemsWS.Entity
Member name | Value | Description | |
---|---|---|---|
IncludeStudents | 1 | If "True", include individuals who are Students. | |
IncludeParents | 2 | If "True", include individuals who are Parents. | |
IncludeFaculty | 3 | If "True", include individuals who are Faculty. | |
IncludeConstituents | 4 | If "True", include individuals who are Constituents. | |
IncludePersonSpouseInfo | 5 | If "True", include spouse information for a Person. | |
IncludePersonStudents | 6 | If "True", include the Person's students' (children) information. | |
ReturnFacultyOnlyAddresses | 8 | If "True", return Faculty addresses for Faculty that are not parents or constituents. | |
StudentsGroup | 9 | A comma separated list of Student Groups. These are used to determine which Students and also which Parents to return (having students in those groups). | |
ReturnOnlyWebUsers | 10 | If "True", only return individuals who have Web Accounts. | |
Constituencies | 11 | A comma separated list of Constituencies to limit the Constituents being returned (IncludeConstituents="True") | |
IncludeAddressPendingChanges | 12 | If "True", also return addresses that have pending changes and have not yet been approved. In this case, the addresses will contain the original address (marked as having pending changes) AND the changed address. See the Address.HasPendingChanges property. | |
FamilyID | 13 | A comma separated list of Family IDs. These are used to determine which Students and also which Parents to return. | |
IncludeInactiveFaculty | 14 | If "True", return faculty members that have been marked as Inactive. | |
IncludeLostDeceasedConstituents | 15 |
If "True", return constituents that have been marked as Lost/Deceased.
Default value is True. Set this parameter to False to exclude Lost/Deceased constituents. | |
FacultyID | 16 | A comma separated list of Faculty IDs. These are used to determine which Faculty memebers are returned. The IncludePersonStudents and IncludePersonSpouseInfo will be respected (they will be returned) | |
ConstituentID | 17 | A comma separated list of Constituent IDs. These are used to determine which Constituents are returned. The IncludePersonStudents and IncludePersonSpouseInfo will be respected (they will be returned) | |
StudentID | 18 | A comma separated list of Student IDs. These are used to determine which students are returned. | |
EntityNo | 19 | A comma separated list of Entity Numbers. These are used to determine which persons are returned. The IncludePersonStudents and IncludePersonSpouseInfo will be respected (they will be returned) |