getAllStudents: Get all Students.
In samterfa/SkywardSDK: Creates R Functions for Skyward Generic API Functions

Description Usage Arguments Value References

This function returns a dataframe of all Students in the database.

getAllStudents(
  EntityID = 1,
  searchConditionsList = NULL,
  searchConditionsGroupType = "And",
  searchSortFieldNamesList = NULL,
  searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)),
  page = 1,
  pageSize = "100000",
  returnStudentID = F,
  returnAllowCustomerCategoryAdd = F,
  returnAllowDistrictDistribution = F,
  returnAllowHigherEdDistribution = F,
  returnAllowLocalDistribution = F,
  returnAllowMediaDistribution = F,
  returnAllowMilitaryDistribution = F,
  returnAllowPublicDistribution = F,
  returnAllowStudentAccess = F,
  returnAllowTripsDistribution = F,
  returnAllowVendorsDistribution = F,
  returnArrestCount = F,
  returnAttachmentCount = F,
  returnAttachmentIndicatorColumn = F,
  returnCalculatedEntityYearIsActive = F,
  returnCalculatedGrade = F,
  returnCalculatedGradYear = F,
  returnCalculatedLocation = F,
  returnCalculatedPrimaryFormattedPhoneNumber = F,
  returnCalculatedStudentStateID = F,
  returnConversionKey = F,
  returnCorporalPunishmentIncidents = F,
  returnCreatedTime = F,
  returnCurrentDefaultEntityIsActive = F,
  returnCurrentEconomicIndicator = F,
  returnDateOfFirstEntryWithdrawalInEntity = F,
  returnDentalPolicyNumber = F,
  returnDisciplinedBullyingDisability = F,
  returnDisciplinedBullyingRace = F,
  returnDisciplinedBullyingSex = F,
  returnEarliestDistrictEnrollmentDate = F,
  returnEarnedCredits = F,
  returnEarnedCreditsPossible = F,
  returnEdFiCountryIDBirth = F,
  returnEntityConfigEarnedCredits = F,
  returnEntityConfigFailedCredits = F,
  returnEntryWithdrawalIDDefaultEntityToday = F,
  returnExpulsionWithoutServicesCount = F,
  returnExpulsionWithServicesCount = F,
  returnFailedCredits = F,
  returnFeeOnlinePaymentOverrideType = F,
  returnFeeOnlinePaymentOverrideTypeCode = F,
  returnFirstName = F,
  returnFoodServiceOnlinePaymentOverrideType = F,
  returnFoodServiceOnlinePaymentOverrideTypeCode = F,
  returnFormattedVaccinationDates = F,
  returnFullNameFL = F,
  returnFullNameFML = F,
  returnFullNameLFM = F,
  returnGrade = F,
  returnGradeNumeric = F,
  returnGraduationDate = F,
  returnGraduationRequirementYear = F,
  returnGradYear = F,
  returnHasActiveAlert = F,
  returnHasActiveCriticalAlert = F,
  returnHasActiveGeneralNote = F,
  returnHasActiveHealthCondition = F,
  returnHasActiveIHP = F,
  returnHasActiveInterventionPlan = F,
  returnHasActiveParentalConsentNote = F,
  returnHasActiveSection504 = F,
  returnHasActiveSpecialEducation = F,
  returnHasActiveStudentGuardianRestrictedAccess = F,
  returnHasAdvancedMathGrade0912 = F,
  returnHasAlertIndicator = F,
  returnHasAlgebraIGrade07 = F,
  returnHasAlgebraIGrade08 = F,
  returnHasAlgebraIGrade0910 = F,
  returnHasAlgebraIGrade1112 = F,
  returnHasAlgebraIIGrade0912 = F,
  returnHasAllowStudentAccessButNoSecurity = F,
  returnHasAPComputerScienceGrade0912 = F,
  returnHasAPCourseGrade0912 = F,
  returnHasAPMathGrade0912 = F,
  returnHasAPOtherGrade0912 = F,
  returnHasAPScienceGrade0912 = F,
  returnHasBiologyGrade0912 = F,
  returnHasCalculusGrade0912 = F,
  returnHasChemistryGrade0912 = F,
  returnHasComputerScienceGrade0912 = F,
  returnHasCreditRecovery = F,
  returnHasCriticalAlertIndicator = F,
  returnHasDuplicateStudentNumber = F,
  returnHasGeneralNoteIndicator = F,
  returnHasGeometryGrade08 = F,
  returnHasGeometryGrade0912 = F,
  returnHasHealthIndicator = F,
  returnHasIHPIndicator = F,
  returnHasInterventionPlanIndicator = F,
  returnHasOneNormalEnrollmentInEntityDuringSchoolYear = F,
  returnHasParentalConsentNoteIndicator = F,
  returnHasPassedAlgebraIGrade07 = F,
  returnHasPassedAlgebraIGrade08 = F,
  returnHasPassedAlgebraIGrade0910 = F,
  returnHasPassedAlgebraIGrade1112 = F,
  returnHasPhysicsGrade0912 = F,
  returnHasSection504Indicator = F,
  returnHasSpecialEducationIndicator = F,
  returnHasStudentEntityYearForCurrentSchoolYear = F,
  returnHasStudentGuardianWithAllowFamilyAccessButNoSecurity = F,
  returnHasTakenACT0912 = F,
  returnHasTakenAPExam0912 = F,
  returnHasTakenSAT0912 = F,
  returnHealthPolicyNumber = F,
  returnHealthProfessionalIDDentist = F,
  returnHealthProfessionalIDPrimaryPhysician = F,
  returnIndicatorsXML = F,
  returnInSchoolSuspensionCount = F,
  returnIsActiveAsOfDate = F,
  returnIsChronicallyAbsent = F,
  returnIsCurrentActive = F,
  returnIsCurrentActiveDefaultEnrollment = F,
  returnIsCurrentlyTransported = F,
  returnIsFederalDistanceEducation = F,
  returnIsFederalDualEnrollment = F,
  returnIsGiftedTalentedSnapshot = F,
  returnIsGraduated = F,
  returnIsHealthProfessionalDentist = F,
  returnIsHealthProfessionalPrimaryPhysician = F,
  returnIsIBDiplomaProgramme = F,
  returnIsIDEA = F,
  returnIsIDEASnapshot = F,
  returnIsLEP = F,
  returnIsLEPSnapshot = F,
  returnIsSection504 = F,
  returnIsSection504Snapshot = F,
  returnIsStateReportingUnknownGender = F,
  returnLanguageIDNative = F,
  returnLanguageIDPrimary = F,
  returnLastName = F,
  returnLawEnforcementReferralCount = F,
  returnLocation = F,
  returnLocationDateToUse = F,
  returnLocationEntityID = F,
  returnLocationSchoolYearID = F,
  returnMaskedStudentNumber = F,
  returnMechanicalRestraintCount = F,
  returnMedicaidNumber = F,
  returnMiddleName = F,
  returnMMRStatus = F,
  returnModifiedTime = F,
  returnNameID = F,
  returnNameIDDentalInsuranceCompany = F,
  returnNameIDDentalPractice = F,
  returnNameIDHealthInsuranceCompany = F,
  returnNameIDHospital = F,
  returnOutOfSchoolSuspensionCount = F,
  returnOutOfSchoolSuspensionMissedDays = F,
  returnOverrideFeeOnlinePaymentAccess = F,
  returnOverrideFoodServiceOnlinePaymentAccess = F,
  returnPhysicalRestraintCount = F,
  returnReportedBulliedDisability = F,
  returnReportedBulliedRace = F,
  returnReportedBulliedSex = F,
  returnSchoolPathExpectedSchoolCode = F,
  returnSchoolPathExpectedSchoolName = F,
  returnSchoolYearIDSpecifiedCohort = F,
  returnSeclusionCount = F,
  returnSingleSexAthleticCount = F,
  returnSpecifiedCohortNumericSchoolYear = F,
  returnSpecifiedEntityYearNoShow = F,
  returnStateEthnicityRaceCodeMNID = F,
  returnStudentIDHash = F,
  returnStudentIndicatorColumn = F,
  returnStudentMNID = F,
  returnStudentNumber = F,
  returnStudentNumberForGradebook = F,
  returnStudentRankSort = F,
  returnStudentStateID = F,
  returnTotalCommunityServiceHours = F,
  returnTransferToAlternativeSchool = F,
  returnUserIDCreatedBy = F,
  returnUserIDModifiedBy = F,
  returnXMLIndicators = F,
  returnZeroToleranceWithoutServicesCount = F,
  returnZeroToleranceWithServicesCount = F
)

`EntityID`	The id of the entity. Run `getAllEntities` for a list of entities.
`searchConditionsList`	A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form FieldName ConditionType SearchCondition. For example, c('StudentID LessEqual 500', 'LastName Like Ander%'). Run `getAllSearchConditionTypes` for a list of ConditionTypes. Defaults to NULL (unfiltered).
`searchConditionsGroupType`	The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
`searchSortFieldNamesList`	The list of fields sort results by. Defaults to NULL (unsorted).
`searchSortFieldNamesDescendingList`	A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
`returnFieldName`	A TRUE or FALSE value determining whether or not to return FieldName for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.