getAllFallSports: Get all FallSports.

In samterfa/SkywardSDK: Creates R Functions for Skyward Generic API Functions

Description

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

Usage

getAllFallSports(
  EntityID = 1,
  searchConditionsList = NULL,
  searchConditionsGroupType = "And",
  searchSortFieldNamesList = NULL,
  searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)),
  page = 1,
  pageSize = "100000",
  returnFallSportID = F,
  returnCode = F,
  returnCreatedTime = F,
  returnFallSport = F,
  returnModifiedTime = F,
  returnUserIDCreatedBy = F,
  returnUserIDModifiedBy = F
)

Arguments

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.

Value

All FallSports in the database.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub

samterfa/SkywardSDK documentation built on Oct. 13, 2020, 6:53 a.m.