listSections: List Sections

Description Usage Arguments Value

Description

This function returns a dataframe or json object of Sections

Usage

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
listSections(
  searchConditionsList = NULL,
  AllowCECE = F,
  AllowStudentsWithoutCategoryToBeAssigned = F,
  AssignmentCount = F,
  AssignmentDataString = F,
  AssignmentsHaveBeenCreated = F,
  BellScheduleGroupID = F,
  CalculatedBellScheduleGroupID = F,
  CalendarIDMCCCOverride = F,
  CanAddStudentSection = F,
  CanBeOffered = F,
  Code = F,
  CourseCodeSectionCode = F,
  CourseCodeSectionCodeCourseDescription = F,
  CourseDescriptionCodeSectionCode = F,
  CourseID = F,
  CreatedTime = F,
  CurrentEnrollmentEntityForFilter = F,
  CurrentEnrollmentForFilter = F,
  CurrentGradingPeriod = F,
  CurrentlyRecalculating = F,
  DisplayForTeachers = F,
  DisplayPeriodIDCurrentStoredPrimary = F,
  DueDateOfLastAssignmentScored = F,
  EdFiEducationalEnvironmentID = F,
  EffectiveTeacherFirstLastName = F,
  EffectiveTeacherLastFirstName = F,
  EntityCodeTeacherNumber = F,
  EntityID = F,
  ExcludeFromStudentSectionLink = F,
  ExcusedAbsencesForTerm = F,
  ExcusedAbsencesYTD = F,
  FitCode = F,
  GradebookCanHaveSettingsCopiedFromPreviousYear = F,
  HasAssignments = F,
  HasAssignmentsWithAcademicStandards = F,
  HasAssignmentsWithStudentGroups = F,
  HasAssignmentsWithSubjects = F,
  HasCalculationGroupCourse = F,
  HasCategoriesInDistrict = F,
  HasCompletedForFilter = F,
  HasDeletedStudentAssignments = F,
  HasGradeMarksInEntity = F,
  HasGradingPeriodGradeBuckets = F,
  HasGradingScales = F,
  HasIncompleteClosedGradeChangeRequests = F,
  HasNonDeletedAssignments = F,
  HasNotStartedForFilter = F,
  HasPreviousYearSettings = F,
  HasStandardsCheckSectionLengthGradingPeriodSet = F,
  HasStudentSections = F,
  HasSubjectsCheckSectionLengthGradingPeriodSet = F,
  HasValidGradebookSetup = F,
  HasValidStandardsSetup = F,
  HasValidSubjectsSetup = F,
  HomeroomID = F,
  InPastYear = F,
  IsActive = F,
  IsActiveOverride = F,
  IsAdministeredForTSA = F,
  IsAHistoricRecord = F,
  IsBilingual = F,
  IsCreditRecovery = F,
  IsInProgressForFilter = F,
  IsOffered = F,
  IsOfferedToAnotherEntity = F,
  IsSelfPaced = F,
  IsSelfPacedAndActive = F,
  IsTSAProficient = F,
  LanguageID = F,
  LockSectionFromSectionScheduler = F,
  LockSectionLengthFromSectionScheduler = F,
  MaximumStudentCount = F,
  MaximumStudentCountEntityForFilter = F,
  MaximumStudentCountOfferedForFilter = F,
  MaximumStudentCountOfferedToSpecifiedEntity = F,
  MeetIDCurrentStoredPrimary = F,
  MeetSummaryIDCurrentStoredPrimary = F,
  MinimumStudentCount = F,
  MissingAssignmentCount = F,
  ModifiedTime = F,
  NonGradedAssignmentCountForTerm = F,
  NonGradedAssignmentCountNoStudentAssignmentsForTerm = F,
  NonTransferCourseEnrollmentCountFemales = F,
  NonTransferCourseEnrollmentCountFemalesEntity = F,
  NonTransferCourseEnrollmentCountFemalesEntityFirstDay = F,
  NonTransferCourseEnrollmentCountFemalesEntitySpecifiedDate = F,
  NonTransferCourseEnrollmentCountFemalesEntityToday = F,
  NonTransferCourseEnrollmentCountFemalesFirstDay = F,
  NonTransferCourseEnrollmentCountFemalesSpecifiedDate = F,
  NonTransferCourseEnrollmentCountFemalesToday = F,
  NonTransferCourseEnrollmentCountMales = F,
  NonTransferCourseEnrollmentCountMalesEntity = F,
  NonTransferCourseEnrollmentCountMalesEntityFirstDay = F,
  NonTransferCourseEnrollmentCountMalesEntitySpecifiedDate = F,
  NonTransferCourseEnrollmentCountMalesEntityToday = F,
  NonTransferCourseEnrollmentCountMalesFirstDay = F,
  NonTransferCourseEnrollmentCountMalesSpecifiedDate = F,
  NonTransferCourseEnrollmentCountMalesToday = F,
  NonTransferCourseStudentEnrollmentCount = F,
  NonTransferCourseStudentEnrollmentCountEntity = F,
  NumberOfTransferStudentSectionsForFilter = F,
  OffenseCount = F,
  OffenseCountYTD = F,
  OptimalStudentCount = F,
  OtherAbsencesForTerm = F,
  OtherAbsencesYTD = F,
  PreviousVersionOfFitCode = F,
  ProgressStatusSpecifiedDateCode = F,
  ProgressStatusTodayCode = F,
  RecalculateGradebook = F,
  RecalculateGradebookAdmin = F,
  ReservedSeatCount = F,
  RoomSeatsAvailable = F,
  SchedulingCategories = F,
  SchedulingTeams = F,
  SchoolYearID = F,
  ScoredAssignmentCount = F,
  ScoredAssignmentRange0CurrentTerm = F,
  ScoredAssignmentRange100to90CurrentTerm = F,
  ScoredAssignmentRange49to1CurrentTerm = F,
  ScoredAssignmentRange59to50CurrentTerm = F,
  ScoredAssignmentRange69to60CurrentTerm = F,
  ScoredAssignmentRange79to70CurrentTerm = F,
  ScoredAssignmentRange89to80CurrentTerm = F,
  SeatsAvailableEntityForFilter = F,
  SeatsAvailableForFilter = F,
  SectionEnrollmentTotalsForSectionLengthSubsetSummary = F,
  SectionEnrollmentTotalsForSectionLengthSubsetSummaryForEntity = F,
  SectionID = F,
  SectionIDClonedFrom = F,
  SectionIDClonedTo = F,
  SectionLengthID = F,
  SectionLengthScheduledBySectionScheduler = F,
  SectionMNID = F,
  SelfPacedEndTime = F,
  SingleSex = F,
  SpecialEdPercentageLimit = F,
  SpecifiedPeriodDaySummary = F,
  StaffIDCurrentStoredPrimary = F,
  StaffMeetIDCurrentStoredPrimary = F,
  StateInstructionalMethodCodeMNID = F,
  StateSTARModeOfTeachingMNID = F,
  StudentAssignmentDataString = F,
  StudentCountForTerm = F,
  StudentEnrollmentAsOfSpecifiedDateForFilter = F,
  StudentEnrollmentEntityForFilter = F,
  StudentEnrollmentFemalesAsOfSpecifiedDateForFilter = F,
  StudentEnrollmentFemalesEntityForFilter = F,
  StudentEnrollmentFemalesForFilter = F,
  StudentEnrollmentForFilter = F,
  StudentEnrollmentMalesAsOfSpecifiedDateForFilter = F,
  StudentEnrollmentMalesEntityForFilter = F,
  StudentEnrollmentMalesForFilter = F,
  TardiesForTerm = F,
  TardiesYTD = F,
  ThisPeriodDaySummary = F,
  TotalEnrollmentCountEntityForFilter = F,
  TotalEnrollmentCountForFilter = F,
  TotalMeetCount = F,
  TotalSeatsOfferedToOtherEntities = F,
  TransferCourseEnrollmentCountFemales = F,
  TransferCourseEnrollmentCountFemalesEntity = F,
  TransferCourseEnrollmentCountFemalesEntityFirstDay = F,
  TransferCourseEnrollmentCountFemalesEntitySpecifiedDate = F,
  TransferCourseEnrollmentCountFemalesEntityToday = F,
  TransferCourseEnrollmentCountFemalesFirstDay = F,
  TransferCourseEnrollmentCountFemalesSpecifiedDate = F,
  TransferCourseEnrollmentCountFemalesToday = F,
  TransferCourseEnrollmentCountMales = F,
  TransferCourseEnrollmentCountMalesEntity = F,
  TransferCourseEnrollmentCountMalesEntityFirstDay = F,
  TransferCourseEnrollmentCountMalesEntitySpecifiedDate = F,
  TransferCourseEnrollmentCountMalesEntityToday = F,
  TransferCourseEnrollmentCountMalesFirstDay = F,
  TransferCourseEnrollmentCountMalesSpecifiedDate = F,
  TransferCourseEnrollmentCountMalesToday = F,
  UnexcusedAbsencesForTerm = F,
  UnexcusedAbsencesYTD = F,
  UnscoredAssignmentCount = F,
  UserIDCreatedBy = F,
  UserIDModifiedBy = F,
  UsingCurriculumSubjectsInGradebook = F,
  ViewingFromOfferingEntity = F,
  Website = F,
  fieldPaths = NULL,
  searchConditionsGroupType = "And",
  searchSortFieldNamesList = NULL,
  searchSortFieldNamesDescendingList = NULL,
  entityId = 1,
  query = NULL,
  page = 1,
  pageSize = 1e+05,
  flatten = T,
  returnResponse = F
)

Arguments

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 listSearchConditionTypes for a list of ConditionTypes. Defaults to NULL (unfiltered).

fieldPaths

Fields from other objects with 'Many to One' or 'One to One' relationships to the given object listed as text. Run getSchemaForObjects('Section') to get more field paths.

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.

entityId

The id of the entity (school). Run listEntities for a list of entities. Defaults to 1 (district).

query

Queries to be added to the request. Ex. list(SchoolYearID = 1). Defaults to NULL.

page

Results are paginated. The page of results to return. Default is 1.

pageSize

Results are paginated. The number of records per page to return. Default is 100,000 (essentially all records for most objects).

flatten

Whether to flatten results into a dataframe or return the json object. Default is TRUE (flatten to dataframe).

returnResponse

Whether to return the server response instead of the results. Useful for debugging. Default is FALSE.

fieldNames

A TRUE or FALSE value determining whether or not to return the field for the given Sections. Defaults to FALSE for all return fields which, for convenience, returns all fields for the Sections.

Value

A list of Sections Skyward's Knowledge Hub


samterfa/rqmlativ documentation built on April 2, 2021, 12:03 p.m.