GetAllPersons Parameters

authKey

Authentication Key obtained from the loginExt method in UserManagementService for a current administrator connection.

numberOfRecords

The number of records to return with this call.

Timeouts can occur if too many records are returned in a single call. Select a value that balances performance with the timeout.

lastEntityNumber

The highest entity number returned from the prior call. The next page of records will begin with persons with a higher entity number.

Set lastEntityNumber to 0 for the first call.

lastUpdateDate

The next page of records will only contain persons who have had changes made on or after this date.

Set lastUpdateDate to be a system minimum date for the first call.

parameters

The options to use to limit the records selected as well as how much information to include.

IncludeStudents

If True, include individuals who are Students.

A Student must be active in both Registrar and Accounts Receivable.

Only Students with STUDENT_MASTER.UPDATE_DATE_TIME on or after lastUpdateDate will be returned.

IncludeParents

If True, include individuals who are Parents.

Name1 and Name2 people on an address record are returned independently.

Only Active P1 and P2 addresses will be included.

Only Parents with ADDRESS.UPDATE_DATE_TIME on or after lastUpdateDate will be returned.

IncludeFaculty

If True, include individuals who are Faculty.

By default, only Active Faculty are included.

Only Faculty with FACULTY_STAFF.UPDATE_DATE_TIME on or after lastUpdateDate will be returned.

IncludeConstituents

If True, include individuals who are Constituents.

By default, only Constituents with a blank value in CONSTITUENT.LOST_DEC are included.

Only Constituents with either CONSTITUENT.UPDATE_DATE_TIME or a linked address (ADDRESS.UPDATE_DATE_TIME)on or after lastUpdateDate will be returned.

StudentsGroup

A comma separated list of Student Groups. These are used to determine which Students to return. For example: "Student,Graduate".

STUDENT_GROUP is used for the test unless AR is installed and RG is not installed. In that case, AR_GROUP is used.

StudentID

A comma separated list of Student IDs. Only those specific students will be returned.

FamilyID

A comma separated list of Family IDs. Only those Students with a Family ID in the list will be returned.

StudentsGroup

A comma separated list of Student Groups. These are used to determine which Parents to return (having students in those groups). For example: "Student,Graduate".

STUDENT_GROUP is used for the test unless AR is installed and RG is not installed. In that case, AR_GROUP is used.

FamilyID

A comma separated list of Family IDs. Only those Parents with a Family ID in the list will be returned.

IncludeInactiveFaculty

When True, all Faculty will be returned; not just the inactive ones.

This overrides the default behavior of IncludeFaculty.

ReturnFacultyOnlyAddresses

If True, return Faculty addresses for Faculty that are not Parents or Constituents.

FacultyID

A comma separated list of Faculty IDs. These are used to determine which Faculty memebers are returned.

ConstituentID

A comma separated list of Constituent IDs. These are used to determine which Constituents are returned.

IncludeLostDeceasedConstituents

When True, Constituents will be returned whether or not they have a value in CONSTITUENT.LOST_DEC

This overrides the default behavior of IncludeConstituent.

Constituencies

A comma separated list of Constituencies. These are used to determine which Constituents to return. For example: "Alum,Parent".

All Constituencies (CONS_CONSTIUENCY table) are considered.

IncludePersonSpouseInfo

When True, the Person.Spouse fields will be populated.

Regardless of the Include parameter used, this parameter takes effect if a person being returned is a Parent or a Constituent.

For Constituents, a spouse is the other entity within the same constituent household.

For Parents, a spouse is the other entity (name1/name2) on an address record for Student/Parent addresses.

For example, if IncludeFaculty is set to True and the faculty member is also a constituent, then the spouse information for the person in the same household as the faculty's constituent record will be returned.

IncludePersonStudents

When True, the Person.StudentAccount fields will be populated.

Regardless of the Include parameter used, this parameter takes effect if a person being returned is a Parent.

Students selected must be:

• in the family of the parent record (same Family ID)

• be assigned to a division where

  • ADM_SCHOOLS.WEB_ACTIVE='Y' and either

  • ADM_SCHOOLS.IS_ACADEMIC_SCHOOL='Y' or ADM_SCHOOLS.IS_SUMMER_SCHOOL='Y'

• If StudentsGroup is also a parameter

  • Students must have their AR_GROUP or STUDENT_GROUP in the provided list.

• If StudentsGroup is not a parameter

  • Students must have their AR_GROUP or STUDENT_GROUP be a "Current Student" group type.

EntityNo

A comma separated list of Entity Numbers.

These are used to determine which persons are returned.

This parameter is used in conjunction with the Include parameters.

For example, if IncludeConstituent is set to True and EntityNo 123 is provided, a person will be returned only if there is a constituent with an entity number of 123. If all Include parameters are set to True, then the entity that matches 123 will be returned if they are a Student, Parent, Faculty, or Constituent.

ReturnOnlyWebUsers

If True, only return individuals who have Web Accounts.

Only current web user accounts will be selected (valid end date is null or greater than the current date)

This parameter impacts all Include parameters.

IncludeAddressPendingChanges

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.

At this time, only Constituents and Parents can have pending changes.