listStudentAutoSchedulerProposedStudentSectionTransactions: List StudentAutoSchedulerProposedStudentSectionTransactions

In samterfa/rqmlativ: Creates R Functions for Skyward Qmlativ's Generic API

Description

This function returns a dataframe or json object of StudentAutoSchedulerProposedStudentSectionTransactions

Usage

listStudentAutoSchedulerProposedStudentSectionTransactions(
  searchConditionsList = NULL,
  BaseRunAnalysisID = F,
  CachedStudentSectionID = F,
  CreatedTime = F,
  DataCommittedToRealObjects = F,
  EndDate = F,
  EndDateOriginal = F,
  EntityIDCountsAs = F,
  ModifiedTime = F,
  SectionID = F,
  SectionIDOriginal = F,
  SectionLengthSubsetID = F,
  SectionLengthSubsetIDOriginal = F,
  StartDate = F,
  StartDateOriginal = F,
  StudentAutoSchedulerProposedStudentSectionTransactionID = F,
  StudentID = F,
  StudentIDOriginal = F,
  StudentSectionID = F,
  StudentSectionIDOriginal = F,
  StudentSectionTransactionID = F,
  StudentSectionTransactionIDOriginal = F,
  UserIDCreatedBy = F,
  UserIDModifiedBy = 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('StudentAutoSchedulerProposedStudentSectionTransaction') 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 StudentAutoSchedulerProposedStudentSectionTransactions. Defaults to FALSE for all return fields which, for convenience, returns all fields for the StudentAutoSchedulerProposedStudentSectionTransactions.

Value

A list of StudentAutoSchedulerProposedStudentSectionTransactions Skyward's Knowledge Hub

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