#' Get all Activities.
#'
#' This function returns a dataframe of all Activities in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All Activities in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllActivities <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnActivityID = F, returnActivityIDClonedFrom = F, returnActivityIDClonedTo = F, returnActivityLeaderNames = F, returnActivityTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnEndDate = F, returnEntityID = F, returnHideInFamilyAccess = F, returnModifiedTime = F, returnSchoolYearID = F, returnSingleSex = F, returnSingleSexCode = F, returnStartDate = F, returnStudentAwardID = F, returnUseForAthleticEligibilityReporting = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "Activity", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Activity
#'
#' This function returns fields for an Activity.
#'
#' @param ActivityID The id of the Activity.\cr Run \code{\link{getAllActivities}} for a list of Activities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the Activity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getActivity <- function(ActivityID, EntityID = 1, returnActivityID = F, returnActivityIDClonedFrom = F, returnActivityIDClonedTo = F, returnActivityLeaderNames = F, returnActivityTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnEndDate = F, returnEntityID = F, returnHideInFamilyAccess = F, returnModifiedTime = F, returnSchoolYearID = F, returnSingleSex = F, returnSingleSexCode = F, returnStartDate = F, returnStudentAwardID = F, returnUseForAthleticEligibilityReporting = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "Activity", ActivityID, searchFields, EntityID)
}
#' Modify a specific Activity
#'
#' This function modifies fields for an Activity.
#'
#' @param ActivityID The id of the Activity to be modified.\cr Run \code{\link{getAllActivities}} for a list of Activitys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified Activity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyActivity <- function(ActivityID, EntityID = 1, setActivityIDClonedFrom = NULL, setActivityTypeID = NULL, setCode = NULL, setDescription = NULL, setEndDate = NULL, setEntityID = NULL, setHideInFamilyAccess = NULL, setSchoolYearID = NULL, setSingleSex = NULL, setSingleSexCode = NULL, setStartDate = NULL, setStudentAwardID = NULL, setUseForAthleticEligibilityReporting = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "Activity", ActivityID, names(functionParams), functionParams, EntityID)
}
#' Create new Activity.
#'
#' This function creates a new Activity.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created Activity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createActivity <- function(EntityID = 1, setActivityIDClonedFrom = NULL, setActivityTypeID = NULL, setCode = NULL, setDescription = NULL, setEndDate = NULL, setEntityID = NULL, setHideInFamilyAccess = NULL, setSchoolYearID = NULL, setSingleSex = NULL, setSingleSexCode = NULL, setStartDate = NULL, setStudentAwardID = NULL, setUseForAthleticEligibilityReporting = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "Activity", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Activity
#'
#' This function deletes an Activity.
#'
#' @param ActivityID The id of the Activity.\cr Run \code{\link{getAllActivities}} for a list of Activities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted Activity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteActivity <- function(ActivityID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "Activity", ActivityID, EntityID)
}
#' Get all ActivityEvents.
#'
#' This function returns a dataframe of all ActivityEvents in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All ActivityEvents in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllActivityEvents <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnActivityEventID = F, returnActivityID = F, returnCodeSummary = F, returnContactType = F, returnContactTypeCode = F, returnCost = F, returnCreatedTime = F, returnDate = F, returnDescription = F, returnDisplayOnDistrictCalendar = F, returnEndTime = F, returnEventTypeID = F, returnLocationID = F, returnModifiedTime = F, returnNameIDContact = F, returnStartTime = F, returnStatus = F, returnStatusCode = F, returnSummary = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnVisibleTo = F, returnVisibleToCode = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "ActivityEvent", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ActivityEvent
#'
#' This function returns fields for an ActivityEvent.
#'
#' @param ActivityEventID The id of the ActivityEvent.\cr Run \code{\link{getAllActivityEvents}} for a list of ActivityEvents.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the ActivityEvent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getActivityEvent <- function(ActivityEventID, EntityID = 1, returnActivityEventID = F, returnActivityID = F, returnCodeSummary = F, returnContactType = F, returnContactTypeCode = F, returnCost = F, returnCreatedTime = F, returnDate = F, returnDescription = F, returnDisplayOnDistrictCalendar = F, returnEndTime = F, returnEventTypeID = F, returnLocationID = F, returnModifiedTime = F, returnNameIDContact = F, returnStartTime = F, returnStatus = F, returnStatusCode = F, returnSummary = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnVisibleTo = F, returnVisibleToCode = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "ActivityEvent", ActivityEventID, searchFields, EntityID)
}
#' Modify a specific ActivityEvent
#'
#' This function modifies fields for an ActivityEvent.
#'
#' @param ActivityEventID The id of the ActivityEvent to be modified.\cr Run \code{\link{getAllActivityEvents}} for a list of ActivityEvents.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified ActivityEvent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyActivityEvent <- function(ActivityEventID, EntityID = 1, setActivityID = NULL, setContactType = NULL, setContactTypeCode = NULL, setCost = NULL, setDate = NULL, setDescription = NULL, setDisplayOnDistrictCalendar = NULL, setEndTime = NULL, setEventTypeID = NULL, setLocationID = NULL, setNameIDContact = NULL, setStartTime = NULL, setStatus = NULL, setStatusCode = NULL, setSummary = NULL, setVisibleTo = NULL, setVisibleToCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "ActivityEvent", ActivityEventID, names(functionParams), functionParams, EntityID)
}
#' Create new ActivityEvent.
#'
#' This function creates a new ActivityEvent.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created ActivityEvent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createActivityEvent <- function(EntityID = 1, setActivityID = NULL, setContactType = NULL, setContactTypeCode = NULL, setCost = NULL, setDate = NULL, setDescription = NULL, setDisplayOnDistrictCalendar = NULL, setEndTime = NULL, setEventTypeID = NULL, setLocationID = NULL, setNameIDContact = NULL, setStartTime = NULL, setStatus = NULL, setStatusCode = NULL, setSummary = NULL, setVisibleTo = NULL, setVisibleToCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "ActivityEvent", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ActivityEvent
#'
#' This function deletes an ActivityEvent.
#'
#' @param ActivityEventID The id of the ActivityEvent.\cr Run \code{\link{getAllActivityEvents}} for a list of ActivityEvents.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted ActivityEvent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteActivityEvent <- function(ActivityEventID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "ActivityEvent", ActivityEventID, EntityID)
}
#' Get all ActivityPersonnels.
#'
#' This function returns a dataframe of all ActivityPersonnels in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All ActivityPersonnels in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllActivityPersonnels <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnActivityPersonnelID = F, returnActivityID = F, returnActivityPersonnelIDClonedFrom = F, returnCreatedTime = F, returnIsLeader = F, returnModifiedTime = F, returnNameID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "ActivityPersonnel", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ActivityPersonnel
#'
#' This function returns fields for an ActivityPersonnel.
#'
#' @param ActivityPersonnelID The id of the ActivityPersonnel.\cr Run \code{\link{getAllActivityPersonnels}} for a list of ActivityPersonnels.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the ActivityPersonnel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getActivityPersonnel <- function(ActivityPersonnelID, EntityID = 1, returnActivityPersonnelID = F, returnActivityID = F, returnActivityPersonnelIDClonedFrom = F, returnCreatedTime = F, returnIsLeader = F, returnModifiedTime = F, returnNameID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "ActivityPersonnel", ActivityPersonnelID, searchFields, EntityID)
}
#' Modify a specific ActivityPersonnel
#'
#' This function modifies fields for an ActivityPersonnel.
#'
#' @param ActivityPersonnelID The id of the ActivityPersonnel to be modified.\cr Run \code{\link{getAllActivityPersonnels}} for a list of ActivityPersonnels.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified ActivityPersonnel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyActivityPersonnel <- function(ActivityPersonnelID, EntityID = 1, setActivityID = NULL, setActivityPersonnelIDClonedFrom = NULL, setIsLeader = NULL, setNameID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "ActivityPersonnel", ActivityPersonnelID, names(functionParams), functionParams, EntityID)
}
#' Create new ActivityPersonnel.
#'
#' This function creates a new ActivityPersonnel.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created ActivityPersonnel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createActivityPersonnel <- function(EntityID = 1, setActivityID = NULL, setActivityPersonnelIDClonedFrom = NULL, setIsLeader = NULL, setNameID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "ActivityPersonnel", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ActivityPersonnel
#'
#' This function deletes an ActivityPersonnel.
#'
#' @param ActivityPersonnelID The id of the ActivityPersonnel.\cr Run \code{\link{getAllActivityPersonnels}} for a list of ActivityPersonnels.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted ActivityPersonnel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteActivityPersonnel <- function(ActivityPersonnelID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "ActivityPersonnel", ActivityPersonnelID, EntityID)
}
#' Get all ActivityTypes.
#'
#' This function returns a dataframe of all ActivityTypes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All ActivityTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllActivityTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnActivityTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "ActivityType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ActivityType
#'
#' This function returns fields for an ActivityType.
#'
#' @param ActivityTypeID The id of the ActivityType.\cr Run \code{\link{getAllActivityTypes}} for a list of ActivityTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the ActivityType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getActivityType <- function(ActivityTypeID, EntityID = 1, returnActivityTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "ActivityType", ActivityTypeID, searchFields, EntityID)
}
#' Modify a specific ActivityType
#'
#' This function modifies fields for an ActivityType.
#'
#' @param ActivityTypeID The id of the ActivityType to be modified.\cr Run \code{\link{getAllActivityTypes}} for a list of ActivityTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified ActivityType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyActivityType <- function(ActivityTypeID, EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "ActivityType", ActivityTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new ActivityType.
#'
#' This function creates a new ActivityType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created ActivityType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createActivityType <- function(EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "ActivityType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ActivityType
#'
#' This function deletes an ActivityType.
#'
#' @param ActivityTypeID The id of the ActivityType.\cr Run \code{\link{getAllActivityTypes}} for a list of ActivityTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted ActivityType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteActivityType <- function(ActivityTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "ActivityType", ActivityTypeID, EntityID)
}
#' Get all Alerts.
#'
#' This function returns a dataframe of all Alerts in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All Alerts in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAlerts <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAlertID = F, returnCreatedTime = F, returnEndDate = F, returnInformation = F, returnIsActive = F, returnIsCritical = F, returnModifiedTime = F, returnStartDate = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "Alert", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Alert
#'
#' This function returns fields for an Alert.
#'
#' @param AlertID The id of the Alert.\cr Run \code{\link{getAllAlerts}} for a list of Alerts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the Alert.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAlert <- function(AlertID, EntityID = 1, returnAlertID = F, returnCreatedTime = F, returnEndDate = F, returnInformation = F, returnIsActive = F, returnIsCritical = F, returnModifiedTime = F, returnStartDate = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "Alert", AlertID, searchFields, EntityID)
}
#' Modify a specific Alert
#'
#' This function modifies fields for an Alert.
#'
#' @param AlertID The id of the Alert to be modified.\cr Run \code{\link{getAllAlerts}} for a list of Alerts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified Alert.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAlert <- function(AlertID, EntityID = 1, setEndDate = NULL, setInformation = NULL, setIsCritical = NULL, setStartDate = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "Alert", AlertID, names(functionParams), functionParams, EntityID)
}
#' Create new Alert.
#'
#' This function creates a new Alert.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created Alert.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAlert <- function(EntityID = 1, setEndDate = NULL, setInformation = NULL, setIsCritical = NULL, setStartDate = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "Alert", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Alert
#'
#' This function deletes an Alert.
#'
#' @param AlertID The id of the Alert.\cr Run \code{\link{getAllAlerts}} for a list of Alerts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted Alert.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAlert <- function(AlertID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "Alert", AlertID, EntityID)
}
#' Get all AwardCategories.
#'
#' This function returns a dataframe of all AwardCategories in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All AwardCategories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAwardCategories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAwardCategoryID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "AwardCategory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AwardCategory
#'
#' This function returns fields for an AwardCategory.
#'
#' @param AwardCategoryID The id of the AwardCategory.\cr Run \code{\link{getAllAwardCategories}} for a list of AwardCategories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the AwardCategory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAwardCategory <- function(AwardCategoryID, EntityID = 1, returnAwardCategoryID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "AwardCategory", AwardCategoryID, searchFields, EntityID)
}
#' Modify a specific AwardCategory
#'
#' This function modifies fields for an AwardCategory.
#'
#' @param AwardCategoryID The id of the AwardCategory to be modified.\cr Run \code{\link{getAllAwardCategories}} for a list of AwardCategorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified AwardCategory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAwardCategory <- function(AwardCategoryID, EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "AwardCategory", AwardCategoryID, names(functionParams), functionParams, EntityID)
}
#' Create new AwardCategory.
#'
#' This function creates a new AwardCategory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created AwardCategory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAwardCategory <- function(EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "AwardCategory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AwardCategory
#'
#' This function deletes an AwardCategory.
#'
#' @param AwardCategoryID The id of the AwardCategory.\cr Run \code{\link{getAllAwardCategories}} for a list of AwardCategories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted AwardCategory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAwardCategory <- function(AwardCategoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "AwardCategory", AwardCategoryID, EntityID)
}
#' Get all AwardHardwares.
#'
#' This function returns a dataframe of all AwardHardwares in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All AwardHardwares in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAwardHardwares <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAwardHardwareID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "AwardHardware", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AwardHardware
#'
#' This function returns fields for an AwardHardware.
#'
#' @param AwardHardwareID The id of the AwardHardware.\cr Run \code{\link{getAllAwardHardwares}} for a list of AwardHardwares.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the AwardHardware.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAwardHardware <- function(AwardHardwareID, EntityID = 1, returnAwardHardwareID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "AwardHardware", AwardHardwareID, searchFields, EntityID)
}
#' Modify a specific AwardHardware
#'
#' This function modifies fields for an AwardHardware.
#'
#' @param AwardHardwareID The id of the AwardHardware to be modified.\cr Run \code{\link{getAllAwardHardwares}} for a list of AwardHardwares.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified AwardHardware.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAwardHardware <- function(AwardHardwareID, EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "AwardHardware", AwardHardwareID, names(functionParams), functionParams, EntityID)
}
#' Create new AwardHardware.
#'
#' This function creates a new AwardHardware.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created AwardHardware.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAwardHardware <- function(EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "AwardHardware", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AwardHardware
#'
#' This function deletes an AwardHardware.
#'
#' @param AwardHardwareID The id of the AwardHardware.\cr Run \code{\link{getAllAwardHardwares}} for a list of AwardHardwares.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted AwardHardware.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAwardHardware <- function(AwardHardwareID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "AwardHardware", AwardHardwareID, EntityID)
}
#' Get all AwardTypes.
#'
#' This function returns a dataframe of all AwardTypes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All AwardTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAwardTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAwardTypeID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "AwardType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AwardType
#'
#' This function returns fields for an AwardType.
#'
#' @param AwardTypeID The id of the AwardType.\cr Run \code{\link{getAllAwardTypes}} for a list of AwardTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the AwardType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAwardType <- function(AwardTypeID, EntityID = 1, returnAwardTypeID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "AwardType", AwardTypeID, searchFields, EntityID)
}
#' Modify a specific AwardType
#'
#' This function modifies fields for an AwardType.
#'
#' @param AwardTypeID The id of the AwardType to be modified.\cr Run \code{\link{getAllAwardTypes}} for a list of AwardTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified AwardType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAwardType <- function(AwardTypeID, EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "AwardType", AwardTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new AwardType.
#'
#' This function creates a new AwardType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created AwardType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAwardType <- function(EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "AwardType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AwardType
#'
#' This function deletes an AwardType.
#'
#' @param AwardTypeID The id of the AwardType.\cr Run \code{\link{getAllAwardTypes}} for a list of AwardTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted AwardType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAwardType <- function(AwardTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "AwardType", AwardTypeID, EntityID)
}
#' Get all ConfigDistricts.
#'
#' This function returns a dataframe of all ConfigDistricts in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All ConfigDistricts in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigDistrictsStudent <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigDistrictID = F, returnCreatedTime = F, returnDistrictID = F, returnEnableIEPWriterDocumentFunctions = F, returnIEPWriterDocumentSecurityToken = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "ConfigDistrict", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ConfigDistrict
#'
#' This function returns fields for a ConfigDistrict.
#'
#' @param ConfigDistrictID The id of the ConfigDistrict.\cr Run \code{\link{getAllConfigDistricts}} for a list of ConfigDistricts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the ConfigDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigDistrictStudent <- function(ConfigDistrictID, EntityID = 1, returnConfigDistrictID = F, returnCreatedTime = F, returnDistrictID = F, returnEnableIEPWriterDocumentFunctions = F, returnIEPWriterDocumentSecurityToken = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "ConfigDistrict", ConfigDistrictID, searchFields, EntityID)
}
#' Modify a specific ConfigDistrict
#'
#' This function modifies fields for a ConfigDistrict.
#'
#' @param ConfigDistrictID The id of the ConfigDistrict to be modified.\cr Run \code{\link{getAllConfigDistricts}} for a list of ConfigDistricts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified ConfigDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigDistrictStudent <- function(ConfigDistrictID, EntityID = 1, setDistrictID = NULL, setEnableIEPWriterDocumentFunctions = NULL, setIEPWriterDocumentSecurityToken = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "ConfigDistrict", ConfigDistrictID, names(functionParams), functionParams, EntityID)
}
#' Create new ConfigDistrict.
#'
#' This function creates a new ConfigDistrict.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created ConfigDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createConfigDistrictStudent <- function(EntityID = 1, setDistrictID = NULL, setEnableIEPWriterDocumentFunctions = NULL, setIEPWriterDocumentSecurityToken = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "ConfigDistrict", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ConfigDistrict
#'
#' This function deletes a ConfigDistrict.
#'
#' @param ConfigDistrictID The id of the ConfigDistrict.\cr Run \code{\link{getAllConfigDistricts}} for a list of ConfigDistricts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted ConfigDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigDistrictStudent <- function(ConfigDistrictID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "ConfigDistrict", ConfigDistrictID, EntityID)
}
#' Get all ConfigEntityGroupYears.
#'
#' This function returns a dataframe of all ConfigEntityGroupYears in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All ConfigEntityGroupYears in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigEntityGroupYearsStudent <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigEntityGroupYearID = F, returnConfigEntityGroupYearIDClonedFrom = F, returnCourseSubjectIDFollettDestinyRoomTeacher = F, returnCreatedTime = F, returnDefaultAllowFeeManagementOnlinePaymentAccess = F, returnDefaultAllowFoodServiceOnlinePaymentAccess = F, returnEntityGroupKey = F, returnEntityID = F, returnFollettDestinyCustomEntityCode = F, returnFollettDestinyRoomTeacherPeriod = F, returnFollettDestinyRoomTeacherType = F, returnFollettDestinyRoomTeacherTypeCode = F, returnModifiedTime = F, returnSchoolYearID = F, returnStudentAccessAccountInfoEmailBody = F, returnStudentAccessAccountInfoEmailIncludeResetPasswordText = F, returnStudentAccessAccountInfoEmailSubject = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "ConfigEntityGroupYear", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ConfigEntityGroupYear
#'
#' This function returns fields for a ConfigEntityGroupYear.
#'
#' @param ConfigEntityGroupYearID The id of the ConfigEntityGroupYear.\cr Run \code{\link{getAllConfigEntityGroupYears}} for a list of ConfigEntityGroupYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the ConfigEntityGroupYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigEntityGroupYearStudent <- function(ConfigEntityGroupYearID, EntityID = 1, returnConfigEntityGroupYearID = F, returnConfigEntityGroupYearIDClonedFrom = F, returnCourseSubjectIDFollettDestinyRoomTeacher = F, returnCreatedTime = F, returnDefaultAllowFeeManagementOnlinePaymentAccess = F, returnDefaultAllowFoodServiceOnlinePaymentAccess = F, returnEntityGroupKey = F, returnEntityID = F, returnFollettDestinyCustomEntityCode = F, returnFollettDestinyRoomTeacherPeriod = F, returnFollettDestinyRoomTeacherType = F, returnFollettDestinyRoomTeacherTypeCode = F, returnModifiedTime = F, returnSchoolYearID = F, returnStudentAccessAccountInfoEmailBody = F, returnStudentAccessAccountInfoEmailIncludeResetPasswordText = F, returnStudentAccessAccountInfoEmailSubject = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "ConfigEntityGroupYear", ConfigEntityGroupYearID, searchFields, EntityID)
}
#' Modify a specific ConfigEntityGroupYear
#'
#' This function modifies fields for a ConfigEntityGroupYear.
#'
#' @param ConfigEntityGroupYearID The id of the ConfigEntityGroupYear to be modified.\cr Run \code{\link{getAllConfigEntityGroupYears}} for a list of ConfigEntityGroupYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified ConfigEntityGroupYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigEntityGroupYearStudent <- function(ConfigEntityGroupYearID, EntityID = 1, setConfigEntityGroupYearIDClonedFrom = NULL, setCourseSubjectIDFollettDestinyRoomTeacher = NULL, setDefaultAllowFeeManagementOnlinePaymentAccess = NULL, setDefaultAllowFoodServiceOnlinePaymentAccess = NULL, setEntityGroupKey = NULL, setEntityID = NULL, setFollettDestinyCustomEntityCode = NULL, setFollettDestinyRoomTeacherPeriod = NULL, setFollettDestinyRoomTeacherType = NULL, setFollettDestinyRoomTeacherTypeCode = NULL, setSchoolYearID = NULL, setStudentAccessAccountInfoEmailBody = NULL, setStudentAccessAccountInfoEmailIncludeResetPasswordText = NULL, setStudentAccessAccountInfoEmailSubject = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "ConfigEntityGroupYear", ConfigEntityGroupYearID, names(functionParams), functionParams, EntityID)
}
#' Create new ConfigEntityGroupYear.
#'
#' This function creates a new ConfigEntityGroupYear.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created ConfigEntityGroupYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createConfigEntityGroupYearStudent <- function(EntityID = 1, setConfigEntityGroupYearIDClonedFrom = NULL, setCourseSubjectIDFollettDestinyRoomTeacher = NULL, setDefaultAllowFeeManagementOnlinePaymentAccess = NULL, setDefaultAllowFoodServiceOnlinePaymentAccess = NULL, setEntityGroupKey = NULL, setEntityID = NULL, setFollettDestinyCustomEntityCode = NULL, setFollettDestinyRoomTeacherPeriod = NULL, setFollettDestinyRoomTeacherType = NULL, setFollettDestinyRoomTeacherTypeCode = NULL, setSchoolYearID = NULL, setStudentAccessAccountInfoEmailBody = NULL, setStudentAccessAccountInfoEmailIncludeResetPasswordText = NULL, setStudentAccessAccountInfoEmailSubject = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "ConfigEntityGroupYear", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ConfigEntityGroupYear
#'
#' This function deletes a ConfigEntityGroupYear.
#'
#' @param ConfigEntityGroupYearID The id of the ConfigEntityGroupYear.\cr Run \code{\link{getAllConfigEntityGroupYears}} for a list of ConfigEntityGroupYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted ConfigEntityGroupYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigEntityGroupYearStudent <- function(ConfigEntityGroupYearID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "ConfigEntityGroupYear", ConfigEntityGroupYearID, EntityID)
}
#' Get all ConfigSystems.
#'
#' This function returns a dataframe of all ConfigSystems in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All ConfigSystems in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigSystemsStudent <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigSystemID = F, returnAllowStudentAccessDefault = F, returnAutoGenerateEmail = F, returnAutoGenerateEmailCode = F, returnAutoGenerateSecurityUser = F, returnAutoGenerateSecurityUserCode = F, returnCreatedTime = F, returnEasyIEPSection504ImportFilePath = F, returnEasyIEPSpecEdImportFilePath = F, returnEmailDomain = F, returnEmailTypeIDDefault = F, returnModifiedTime = F, returnStudentAttachmentVisibility = F, returnStudentAttachmentVisibilityCode = F, returnStudentNumberMask = F, returnStudentNumberStartValue = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "ConfigSystem", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ConfigSystem
#'
#' This function returns fields for a ConfigSystem.
#'
#' @param ConfigSystemID The id of the ConfigSystem.\cr Run \code{\link{getAllConfigSystems}} for a list of ConfigSystems.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigSystemStudent <- function(ConfigSystemID, EntityID = 1, returnConfigSystemID = F, returnAllowStudentAccessDefault = F, returnAutoGenerateEmail = F, returnAutoGenerateEmailCode = F, returnAutoGenerateSecurityUser = F, returnAutoGenerateSecurityUserCode = F, returnCreatedTime = F, returnEasyIEPSection504ImportFilePath = F, returnEasyIEPSpecEdImportFilePath = F, returnEmailDomain = F, returnEmailTypeIDDefault = F, returnModifiedTime = F, returnStudentAttachmentVisibility = F, returnStudentAttachmentVisibilityCode = F, returnStudentNumberMask = F, returnStudentNumberStartValue = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "ConfigSystem", ConfigSystemID, searchFields, EntityID)
}
#' Modify a specific ConfigSystem
#'
#' This function modifies fields for a ConfigSystem.
#'
#' @param ConfigSystemID The id of the ConfigSystem to be modified.\cr Run \code{\link{getAllConfigSystems}} for a list of ConfigSystems.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigSystemStudent <- function(ConfigSystemID, EntityID = 1, setAllowStudentAccessDefault = NULL, setAutoGenerateEmail = NULL, setAutoGenerateEmailCode = NULL, setAutoGenerateSecurityUser = NULL, setAutoGenerateSecurityUserCode = NULL, setEasyIEPSection504ImportFilePath = NULL, setEasyIEPSpecEdImportFilePath = NULL, setEmailDomain = NULL, setEmailTypeIDDefault = NULL, setStudentAttachmentVisibility = NULL, setStudentAttachmentVisibilityCode = NULL, setStudentNumberMask = NULL, setStudentNumberStartValue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "ConfigSystem", ConfigSystemID, names(functionParams), functionParams, EntityID)
}
#' Create new ConfigSystem.
#'
#' This function creates a new ConfigSystem.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createConfigSystemStudent <- function(EntityID = 1, setAllowStudentAccessDefault = NULL, setAutoGenerateEmail = NULL, setAutoGenerateEmailCode = NULL, setAutoGenerateSecurityUser = NULL, setAutoGenerateSecurityUserCode = NULL, setEasyIEPSection504ImportFilePath = NULL, setEasyIEPSpecEdImportFilePath = NULL, setEmailDomain = NULL, setEmailTypeIDDefault = NULL, setStudentAttachmentVisibility = NULL, setStudentAttachmentVisibilityCode = NULL, setStudentNumberMask = NULL, setStudentNumberStartValue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "ConfigSystem", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ConfigSystem
#'
#' This function deletes a ConfigSystem.
#'
#' @param ConfigSystemID The id of the ConfigSystem.\cr Run \code{\link{getAllConfigSystems}} for a list of ConfigSystems.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigSystemStudent <- function(ConfigSystemID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "ConfigSystem", ConfigSystemID, EntityID)
}
#' Get all CurrentSportsSelectionses.
#'
#' This function returns a dataframe of all CurrentSportsSelectionses in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All CurrentSportsSelectionses in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCurrentSportsSelectionses <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCurrentSportsSelectionsID = F, returnCreatedTime = F, returnFallSportID = F, returnModifiedTime = F, returnSpringSportID = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWinterSportID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "CurrentSportsSelections", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CurrentSportsSelections
#'
#' This function returns fields for a CurrentSportsSelections.
#'
#' @param CurrentSportsSelectionsID The id of the CurrentSportsSelections.\cr Run \code{\link{getAllCurrentSportsSelectionses}} for a list of CurrentSportsSelectionses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the CurrentSportsSelections.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCurrentSportsSelections <- function(CurrentSportsSelectionsID, EntityID = 1, returnCurrentSportsSelectionsID = F, returnCreatedTime = F, returnFallSportID = F, returnModifiedTime = F, returnSpringSportID = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWinterSportID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "CurrentSportsSelections", CurrentSportsSelectionsID, searchFields, EntityID)
}
#' Modify a specific CurrentSportsSelections
#'
#' This function modifies fields for a CurrentSportsSelections.
#'
#' @param CurrentSportsSelectionsID The id of the CurrentSportsSelections to be modified.\cr Run \code{\link{getAllCurrentSportsSelectionses}} for a list of CurrentSportsSelections.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified CurrentSportsSelections.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCurrentSportsSelections <- function(CurrentSportsSelectionsID, EntityID = 1, setFallSportID = NULL, setSpringSportID = NULL, setStudentID = NULL, setWinterSportID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "CurrentSportsSelections", CurrentSportsSelectionsID, names(functionParams), functionParams, EntityID)
}
#' Create new CurrentSportsSelections.
#'
#' This function creates a new CurrentSportsSelections.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created CurrentSportsSelections.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCurrentSportsSelections <- function(EntityID = 1, setFallSportID = NULL, setSpringSportID = NULL, setStudentID = NULL, setWinterSportID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "CurrentSportsSelections", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CurrentSportsSelections
#'
#' This function deletes a CurrentSportsSelections.
#'
#' @param CurrentSportsSelectionsID The id of the CurrentSportsSelections.\cr Run \code{\link{getAllCurrentSportsSelectionses}} for a list of CurrentSportsSelectionses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted CurrentSportsSelections.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCurrentSportsSelections <- function(CurrentSportsSelectionsID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "CurrentSportsSelections", CurrentSportsSelectionsID, EntityID)
}
#' Get all CustomCodes.
#'
#' This function returns a dataframe of all CustomCodes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All CustomCodes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCustomCodes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCustomCodeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnCustomCodeTypeID = F, returnDescription = F, returnDistrictGroupKey = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "CustomCode", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CustomCode
#'
#' This function returns fields for a CustomCode.
#'
#' @param CustomCodeID The id of the CustomCode.\cr Run \code{\link{getAllCustomCodes}} for a list of CustomCodes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the CustomCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCustomCode <- function(CustomCodeID, EntityID = 1, returnCustomCodeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnCustomCodeTypeID = F, returnDescription = F, returnDistrictGroupKey = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "CustomCode", CustomCodeID, searchFields, EntityID)
}
#' Modify a specific CustomCode
#'
#' This function modifies fields for a CustomCode.
#'
#' @param CustomCodeID The id of the CustomCode to be modified.\cr Run \code{\link{getAllCustomCodes}} for a list of CustomCodes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified CustomCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCustomCode <- function(CustomCodeID, EntityID = 1, setCode = NULL, setCustomCodeTypeID = NULL, setDescription = NULL, setDistrictGroupKey = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "CustomCode", CustomCodeID, names(functionParams), functionParams, EntityID)
}
#' Create new CustomCode.
#'
#' This function creates a new CustomCode.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created CustomCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCustomCode <- function(EntityID = 1, setCode = NULL, setCustomCodeTypeID = NULL, setDescription = NULL, setDistrictGroupKey = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "CustomCode", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CustomCode
#'
#' This function deletes a CustomCode.
#'
#' @param CustomCodeID The id of the CustomCode.\cr Run \code{\link{getAllCustomCodes}} for a list of CustomCodes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted CustomCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCustomCode <- function(CustomCodeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "CustomCode", CustomCodeID, EntityID)
}
#' Get all CustomCodeTypes.
#'
#' This function returns a dataframe of all CustomCodeTypes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All CustomCodeTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCustomCodeTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCustomCodeTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "CustomCodeType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CustomCodeType
#'
#' This function returns fields for a CustomCodeType.
#'
#' @param CustomCodeTypeID The id of the CustomCodeType.\cr Run \code{\link{getAllCustomCodeTypes}} for a list of CustomCodeTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the CustomCodeType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCustomCodeType <- function(CustomCodeTypeID, EntityID = 1, returnCustomCodeTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "CustomCodeType", CustomCodeTypeID, searchFields, EntityID)
}
#' Modify a specific CustomCodeType
#'
#' This function modifies fields for a CustomCodeType.
#'
#' @param CustomCodeTypeID The id of the CustomCodeType to be modified.\cr Run \code{\link{getAllCustomCodeTypes}} for a list of CustomCodeTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified CustomCodeType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCustomCodeType <- function(CustomCodeTypeID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "CustomCodeType", CustomCodeTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new CustomCodeType.
#'
#' This function creates a new CustomCodeType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created CustomCodeType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCustomCodeType <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "CustomCodeType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CustomCodeType
#'
#' This function deletes a CustomCodeType.
#'
#' @param CustomCodeTypeID The id of the CustomCodeType.\cr Run \code{\link{getAllCustomCodeTypes}} for a list of CustomCodeTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted CustomCodeType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCustomCodeType <- function(CustomCodeTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "CustomCodeType", CustomCodeTypeID, EntityID)
}
#' Get all EthnicityMAs.
#'
#' This function returns a dataframe of all EthnicityMAs in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All EthnicityMAs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllEthnicityMAs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnEthnicityMAID = F, returnCode = F, returnCreatedTime = F, returnEthnicity = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "EthnicityMA", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific EthnicityMA
#'
#' This function returns fields for an EthnicityMA.
#'
#' @param EthnicityMAID The id of the EthnicityMA.\cr Run \code{\link{getAllEthnicityMAs}} for a list of EthnicityMAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the EthnicityMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getEthnicityMA <- function(EthnicityMAID, EntityID = 1, returnEthnicityMAID = F, returnCode = F, returnCreatedTime = F, returnEthnicity = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "EthnicityMA", EthnicityMAID, searchFields, EntityID)
}
#' Modify a specific EthnicityMA
#'
#' This function modifies fields for an EthnicityMA.
#'
#' @param EthnicityMAID The id of the EthnicityMA to be modified.\cr Run \code{\link{getAllEthnicityMAs}} for a list of EthnicityMAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified EthnicityMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyEthnicityMA <- function(EthnicityMAID, EntityID = 1, setCode = NULL, setEthnicity = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "EthnicityMA", EthnicityMAID, names(functionParams), functionParams, EntityID)
}
#' Create new EthnicityMA.
#'
#' This function creates a new EthnicityMA.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created EthnicityMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createEthnicityMA <- function(EntityID = 1, setCode = NULL, setEthnicity = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "EthnicityMA", names(functionParams), functionParams, EntityID)
}
#' Delete a specific EthnicityMA
#'
#' This function deletes an EthnicityMA.
#'
#' @param EthnicityMAID The id of the EthnicityMA.\cr Run \code{\link{getAllEthnicityMAs}} for a list of EthnicityMAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted EthnicityMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteEthnicityMA <- function(EthnicityMAID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "EthnicityMA", EthnicityMAID, EntityID)
}
#' Get all EventTypes.
#'
#' This function returns a dataframe of all EventTypes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All EventTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllEventTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnEventTypeID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "EventType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific EventType
#'
#' This function returns fields for an EventType.
#'
#' @param EventTypeID The id of the EventType.\cr Run \code{\link{getAllEventTypes}} for a list of EventTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the EventType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getEventType <- function(EventTypeID, EntityID = 1, returnEventTypeID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "EventType", EventTypeID, searchFields, EntityID)
}
#' Modify a specific EventType
#'
#' This function modifies fields for an EventType.
#'
#' @param EventTypeID The id of the EventType to be modified.\cr Run \code{\link{getAllEventTypes}} for a list of EventTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified EventType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyEventType <- function(EventTypeID, EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "EventType", EventTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new EventType.
#'
#' This function creates a new EventType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created EventType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createEventType <- function(EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "EventType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific EventType
#'
#' This function deletes an EventType.
#'
#' @param EventTypeID The id of the EventType.\cr Run \code{\link{getAllEventTypes}} for a list of EventTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted EventType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteEventType <- function(EventTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "EventType", EventTypeID, EntityID)
}
#' Get all FallSports.
#'
#' This function returns a dataframe of all FallSports in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All FallSports in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFallSports <- function(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){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "FallSport", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific FallSport
#'
#' This function returns fields for a FallSport.
#'
#' @param FallSportID The id of the FallSport.\cr Run \code{\link{getAllFallSports}} for a list of FallSports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the FallSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFallSport <- function(FallSportID, EntityID = 1, returnFallSportID = F, returnCode = F, returnCreatedTime = F, returnFallSport = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "FallSport", FallSportID, searchFields, EntityID)
}
#' Modify a specific FallSport
#'
#' This function modifies fields for a FallSport.
#'
#' @param FallSportID The id of the FallSport to be modified.\cr Run \code{\link{getAllFallSports}} for a list of FallSports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified FallSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFallSport <- function(FallSportID, EntityID = 1, setCode = NULL, setFallSport = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "FallSport", FallSportID, names(functionParams), functionParams, EntityID)
}
#' Create new FallSport.
#'
#' This function creates a new FallSport.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created FallSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFallSport <- function(EntityID = 1, setCode = NULL, setFallSport = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "FallSport", names(functionParams), functionParams, EntityID)
}
#' Delete a specific FallSport
#'
#' This function deletes a FallSport.
#'
#' @param FallSportID The id of the FallSport.\cr Run \code{\link{getAllFallSports}} for a list of FallSports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted FallSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFallSport <- function(FallSportID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "FallSport", FallSportID, EntityID)
}
#' Get all FallSportsTeams.
#'
#' This function returns a dataframe of all FallSportsTeams in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All FallSportsTeams in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFallSportsTeams <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFallSportsTeamID = F, returnCaptain = F, returnCreatedTime = F, returnFallSportID = F, returnLettered = F, returnModifiedTime = F, returnSchoolYearID = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "FallSportsTeam", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific FallSportsTeam
#'
#' This function returns fields for a FallSportsTeam.
#'
#' @param FallSportsTeamID The id of the FallSportsTeam.\cr Run \code{\link{getAllFallSportsTeams}} for a list of FallSportsTeams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the FallSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFallSportsTeam <- function(FallSportsTeamID, EntityID = 1, returnFallSportsTeamID = F, returnCaptain = F, returnCreatedTime = F, returnFallSportID = F, returnLettered = F, returnModifiedTime = F, returnSchoolYearID = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "FallSportsTeam", FallSportsTeamID, searchFields, EntityID)
}
#' Modify a specific FallSportsTeam
#'
#' This function modifies fields for a FallSportsTeam.
#'
#' @param FallSportsTeamID The id of the FallSportsTeam to be modified.\cr Run \code{\link{getAllFallSportsTeams}} for a list of FallSportsTeams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified FallSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFallSportsTeam <- function(FallSportsTeamID, EntityID = 1, setCaptain = NULL, setFallSportID = NULL, setLettered = NULL, setSchoolYearID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "FallSportsTeam", FallSportsTeamID, names(functionParams), functionParams, EntityID)
}
#' Create new FallSportsTeam.
#'
#' This function creates a new FallSportsTeam.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created FallSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFallSportsTeam <- function(EntityID = 1, setCaptain = NULL, setFallSportID = NULL, setLettered = NULL, setSchoolYearID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "FallSportsTeam", names(functionParams), functionParams, EntityID)
}
#' Delete a specific FallSportsTeam
#'
#' This function deletes a FallSportsTeam.
#'
#' @param FallSportsTeamID The id of the FallSportsTeam.\cr Run \code{\link{getAllFallSportsTeams}} for a list of FallSportsTeams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted FallSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFallSportsTeam <- function(FallSportsTeamID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "FallSportsTeam", FallSportsTeamID, EntityID)
}
#' Get all FeederSchools.
#'
#' This function returns a dataframe of all FeederSchools in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All FeederSchools in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllFeederSchools <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnFeederSchoolID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "FeederSchool", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific FeederSchool
#'
#' This function returns fields for a FeederSchool.
#'
#' @param FeederSchoolID The id of the FeederSchool.\cr Run \code{\link{getAllFeederSchools}} for a list of FeederSchools.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the FeederSchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getFeederSchool <- function(FeederSchoolID, EntityID = 1, returnFeederSchoolID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "FeederSchool", FeederSchoolID, searchFields, EntityID)
}
#' Modify a specific FeederSchool
#'
#' This function modifies fields for a FeederSchool.
#'
#' @param FeederSchoolID The id of the FeederSchool to be modified.\cr Run \code{\link{getAllFeederSchools}} for a list of FeederSchools.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified FeederSchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyFeederSchool <- function(FeederSchoolID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "FeederSchool", FeederSchoolID, names(functionParams), functionParams, EntityID)
}
#' Create new FeederSchool.
#'
#' This function creates a new FeederSchool.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created FeederSchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createFeederSchool <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "FeederSchool", names(functionParams), functionParams, EntityID)
}
#' Delete a specific FeederSchool
#'
#' This function deletes a FeederSchool.
#'
#' @param FeederSchoolID The id of the FeederSchool.\cr Run \code{\link{getAllFeederSchools}} for a list of FeederSchools.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted FeederSchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteFeederSchool <- function(FeederSchoolID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "FeederSchool", FeederSchoolID, EntityID)
}
#' Get all Indicators.
#'
#' This function returns a dataframe of all Indicators in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All Indicators in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIndicators <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIndicatorID = F, returnCreatedTime = F, returnImage = F, returnImageCode = F, returnIsActive = F, returnModifiedTime = F, returnName = F, returnRank = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "Indicator", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Indicator
#'
#' This function returns fields for an Indicator.
#'
#' @param IndicatorID The id of the Indicator.\cr Run \code{\link{getAllIndicators}} for a list of Indicators.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the Indicator.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIndicator <- function(IndicatorID, EntityID = 1, returnIndicatorID = F, returnCreatedTime = F, returnImage = F, returnImageCode = F, returnIsActive = F, returnModifiedTime = F, returnName = F, returnRank = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "Indicator", IndicatorID, searchFields, EntityID)
}
#' Modify a specific Indicator
#'
#' This function modifies fields for an Indicator.
#'
#' @param IndicatorID The id of the Indicator to be modified.\cr Run \code{\link{getAllIndicators}} for a list of Indicators.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified Indicator.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIndicator <- function(IndicatorID, EntityID = 1, setImage = NULL, setImageCode = NULL, setIsActive = NULL, setName = NULL, setRank = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "Indicator", IndicatorID, names(functionParams), functionParams, EntityID)
}
#' Create new Indicator.
#'
#' This function creates a new Indicator.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created Indicator.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIndicator <- function(EntityID = 1, setImage = NULL, setImageCode = NULL, setIsActive = NULL, setName = NULL, setRank = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "Indicator", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Indicator
#'
#' This function deletes an Indicator.
#'
#' @param IndicatorID The id of the Indicator.\cr Run \code{\link{getAllIndicators}} for a list of Indicators.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted Indicator.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIndicator <- function(IndicatorID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "Indicator", IndicatorID, EntityID)
}
#' Get all Locks.
#'
#' This function returns a dataframe of all Locks in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All Locks in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllLocks <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnLockID = F, returnBuildingID = F, returnCreatedTime = F, returnIsAssigned = F, returnIsAttached = F, returnIsAvailable = F, returnIsBuiltInLock = F, returnLockerID = F, returnLockMakeID = F, returnModifiedTime = F, returnOwnedBySchool = F, returnRenderRemoveLock = F, returnSerialNumber = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "Lock", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Lock
#'
#' This function returns fields for a Lock.
#'
#' @param LockID The id of the Lock.\cr Run \code{\link{getAllLocks}} for a list of Locks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the Lock.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getLock <- function(LockID, EntityID = 1, returnLockID = F, returnBuildingID = F, returnCreatedTime = F, returnIsAssigned = F, returnIsAttached = F, returnIsAvailable = F, returnIsBuiltInLock = F, returnLockerID = F, returnLockMakeID = F, returnModifiedTime = F, returnOwnedBySchool = F, returnRenderRemoveLock = F, returnSerialNumber = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "Lock", LockID, searchFields, EntityID)
}
#' Modify a specific Lock
#'
#' This function modifies fields for a Lock.
#'
#' @param LockID The id of the Lock to be modified.\cr Run \code{\link{getAllLocks}} for a list of Locks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified Lock.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyLock <- function(LockID, EntityID = 1, setBuildingID = NULL, setIsBuiltInLock = NULL, setLockerID = NULL, setLockMakeID = NULL, setOwnedBySchool = NULL, setSerialNumber = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "Lock", LockID, names(functionParams), functionParams, EntityID)
}
#' Create new Lock.
#'
#' This function creates a new Lock.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created Lock.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createLock <- function(EntityID = 1, setBuildingID = NULL, setIsBuiltInLock = NULL, setLockerID = NULL, setLockMakeID = NULL, setOwnedBySchool = NULL, setSerialNumber = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "Lock", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Lock
#'
#' This function deletes a Lock.
#'
#' @param LockID The id of the Lock.\cr Run \code{\link{getAllLocks}} for a list of Locks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted Lock.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteLock <- function(LockID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "Lock", LockID, EntityID)
}
#' Get all LockCombinations.
#'
#' This function returns a dataframe of all LockCombinations in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All LockCombinations in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllLockCombinations <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnLockCombinationID = F, returnCombination = F, returnCombinationNumber = F, returnCreatedTime = F, returnIsCurrentCombination = F, returnLockID = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "LockCombination", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific LockCombination
#'
#' This function returns fields for a LockCombination.
#'
#' @param LockCombinationID The id of the LockCombination.\cr Run \code{\link{getAllLockCombinations}} for a list of LockCombinations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the LockCombination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getLockCombination <- function(LockCombinationID, EntityID = 1, returnLockCombinationID = F, returnCombination = F, returnCombinationNumber = F, returnCreatedTime = F, returnIsCurrentCombination = F, returnLockID = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "LockCombination", LockCombinationID, searchFields, EntityID)
}
#' Modify a specific LockCombination
#'
#' This function modifies fields for a LockCombination.
#'
#' @param LockCombinationID The id of the LockCombination to be modified.\cr Run \code{\link{getAllLockCombinations}} for a list of LockCombinations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified LockCombination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyLockCombination <- function(LockCombinationID, EntityID = 1, setCombination = NULL, setCombinationNumber = NULL, setIsCurrentCombination = NULL, setLockID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "LockCombination", LockCombinationID, names(functionParams), functionParams, EntityID)
}
#' Create new LockCombination.
#'
#' This function creates a new LockCombination.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created LockCombination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createLockCombination <- function(EntityID = 1, setCombination = NULL, setCombinationNumber = NULL, setIsCurrentCombination = NULL, setLockID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "LockCombination", names(functionParams), functionParams, EntityID)
}
#' Delete a specific LockCombination
#'
#' This function deletes a LockCombination.
#'
#' @param LockCombinationID The id of the LockCombination.\cr Run \code{\link{getAllLockCombinations}} for a list of LockCombinations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted LockCombination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteLockCombination <- function(LockCombinationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "LockCombination", LockCombinationID, EntityID)
}
#' Get all Lockers.
#'
#' This function returns a dataframe of all Lockers in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All Lockers in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllLockers <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnLockerID = F, returnComment = F, returnCreatedTime = F, returnCurrentCombination = F, returnGender = F, returnGenderCode = F, returnGenderCount = F, returnHasBuiltInLock = F, returnIsActive = F, returnIsAvailable = F, returnIsDamaged = F, returnLockerAreaID = F, returnLockerNumber = F, returnModifiedTime = F, returnNeedsLock = F, returnStudentsPerLocker = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "Locker", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Locker
#'
#' This function returns fields for a Locker.
#'
#' @param LockerID The id of the Locker.\cr Run \code{\link{getAllLockers}} for a list of Lockers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the Locker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getLocker <- function(LockerID, EntityID = 1, returnLockerID = F, returnComment = F, returnCreatedTime = F, returnCurrentCombination = F, returnGender = F, returnGenderCode = F, returnGenderCount = F, returnHasBuiltInLock = F, returnIsActive = F, returnIsAvailable = F, returnIsDamaged = F, returnLockerAreaID = F, returnLockerNumber = F, returnModifiedTime = F, returnNeedsLock = F, returnStudentsPerLocker = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "Locker", LockerID, searchFields, EntityID)
}
#' Modify a specific Locker
#'
#' This function modifies fields for a Locker.
#'
#' @param LockerID The id of the Locker to be modified.\cr Run \code{\link{getAllLockers}} for a list of Lockers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified Locker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyLocker <- function(LockerID, EntityID = 1, setComment = NULL, setGender = NULL, setGenderCode = NULL, setGenderCount = NULL, setHasBuiltInLock = NULL, setIsActive = NULL, setIsDamaged = NULL, setLockerAreaID = NULL, setLockerNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "Locker", LockerID, names(functionParams), functionParams, EntityID)
}
#' Create new Locker.
#'
#' This function creates a new Locker.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created Locker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createLocker <- function(EntityID = 1, setComment = NULL, setGender = NULL, setGenderCode = NULL, setGenderCount = NULL, setHasBuiltInLock = NULL, setIsActive = NULL, setIsDamaged = NULL, setLockerAreaID = NULL, setLockerNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "Locker", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Locker
#'
#' This function deletes a Locker.
#'
#' @param LockerID The id of the Locker.\cr Run \code{\link{getAllLockers}} for a list of Lockers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted Locker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteLocker <- function(LockerID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "Locker", LockerID, EntityID)
}
#' Get all LockerAreas.
#'
#' This function returns a dataframe of all LockerAreas in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All LockerAreas in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllLockerAreas <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnLockerAreaID = F, returnAllowCoedLocker = F, returnBuildingID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnHasBuiltInLockDefault = F, returnMaximumStudentsPerLocker = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "LockerArea", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific LockerArea
#'
#' This function returns fields for a LockerArea.
#'
#' @param LockerAreaID The id of the LockerArea.\cr Run \code{\link{getAllLockerAreas}} for a list of LockerAreas.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the LockerArea.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getLockerArea <- function(LockerAreaID, EntityID = 1, returnLockerAreaID = F, returnAllowCoedLocker = F, returnBuildingID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnHasBuiltInLockDefault = F, returnMaximumStudentsPerLocker = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "LockerArea", LockerAreaID, searchFields, EntityID)
}
#' Modify a specific LockerArea
#'
#' This function modifies fields for a LockerArea.
#'
#' @param LockerAreaID The id of the LockerArea to be modified.\cr Run \code{\link{getAllLockerAreas}} for a list of LockerAreas.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified LockerArea.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyLockerArea <- function(LockerAreaID, EntityID = 1, setAllowCoedLocker = NULL, setBuildingID = NULL, setCode = NULL, setDescription = NULL, setHasBuiltInLockDefault = NULL, setMaximumStudentsPerLocker = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "LockerArea", LockerAreaID, names(functionParams), functionParams, EntityID)
}
#' Create new LockerArea.
#'
#' This function creates a new LockerArea.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created LockerArea.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createLockerArea <- function(EntityID = 1, setAllowCoedLocker = NULL, setBuildingID = NULL, setCode = NULL, setDescription = NULL, setHasBuiltInLockDefault = NULL, setMaximumStudentsPerLocker = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "LockerArea", names(functionParams), functionParams, EntityID)
}
#' Delete a specific LockerArea
#'
#' This function deletes a LockerArea.
#'
#' @param LockerAreaID The id of the LockerArea.\cr Run \code{\link{getAllLockerAreas}} for a list of LockerAreas.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted LockerArea.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteLockerArea <- function(LockerAreaID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "LockerArea", LockerAreaID, EntityID)
}
#' Get all LockMakes.
#'
#' This function returns a dataframe of all LockMakes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All LockMakes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllLockMakes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnLockMakeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "LockMake", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific LockMake
#'
#' This function returns fields for a LockMake.
#'
#' @param LockMakeID The id of the LockMake.\cr Run \code{\link{getAllLockMakes}} for a list of LockMakes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the LockMake.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getLockMake <- function(LockMakeID, EntityID = 1, returnLockMakeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "LockMake", LockMakeID, searchFields, EntityID)
}
#' Modify a specific LockMake
#'
#' This function modifies fields for a LockMake.
#'
#' @param LockMakeID The id of the LockMake to be modified.\cr Run \code{\link{getAllLockMakes}} for a list of LockMakes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified LockMake.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyLockMake <- function(LockMakeID, EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "LockMake", LockMakeID, names(functionParams), functionParams, EntityID)
}
#' Create new LockMake.
#'
#' This function creates a new LockMake.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created LockMake.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createLockMake <- function(EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "LockMake", names(functionParams), functionParams, EntityID)
}
#' Delete a specific LockMake
#'
#' This function deletes a LockMake.
#'
#' @param LockMakeID The id of the LockMake.\cr Run \code{\link{getAllLockMakes}} for a list of LockMakes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted LockMake.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteLockMake <- function(LockMakeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "LockMake", LockMakeID, EntityID)
}
#' Get all NextStudentNumbers.
#'
#' This function returns a dataframe of all NextStudentNumbers in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All NextStudentNumbers in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllNextStudentNumbers <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnNextStudentNumberID = F, returnCreatedTime = F, returnIsForStateID = F, returnMaskPrefix = F, returnModifiedTime = F, returnSequenceNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "NextStudentNumber", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific NextStudentNumber
#'
#' This function returns fields for a NextStudentNumber.
#'
#' @param NextStudentNumberID The id of the NextStudentNumber.\cr Run \code{\link{getAllNextStudentNumbers}} for a list of NextStudentNumbers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the NextStudentNumber.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getNextStudentNumber <- function(NextStudentNumberID, EntityID = 1, returnNextStudentNumberID = F, returnCreatedTime = F, returnIsForStateID = F, returnMaskPrefix = F, returnModifiedTime = F, returnSequenceNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "NextStudentNumber", NextStudentNumberID, searchFields, EntityID)
}
#' Modify a specific NextStudentNumber
#'
#' This function modifies fields for a NextStudentNumber.
#'
#' @param NextStudentNumberID The id of the NextStudentNumber to be modified.\cr Run \code{\link{getAllNextStudentNumbers}} for a list of NextStudentNumbers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified NextStudentNumber.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyNextStudentNumber <- function(NextStudentNumberID, EntityID = 1, setIsForStateID = NULL, setMaskPrefix = NULL, setSequenceNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "NextStudentNumber", NextStudentNumberID, names(functionParams), functionParams, EntityID)
}
#' Create new NextStudentNumber.
#'
#' This function creates a new NextStudentNumber.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created NextStudentNumber.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createNextStudentNumber <- function(EntityID = 1, setIsForStateID = NULL, setMaskPrefix = NULL, setSequenceNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "NextStudentNumber", names(functionParams), functionParams, EntityID)
}
#' Delete a specific NextStudentNumber
#'
#' This function deletes a NextStudentNumber.
#'
#' @param NextStudentNumberID The id of the NextStudentNumber.\cr Run \code{\link{getAllNextStudentNumbers}} for a list of NextStudentNumbers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted NextStudentNumber.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteNextStudentNumber <- function(NextStudentNumberID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "NextStudentNumber", NextStudentNumberID, EntityID)
}
#' Get all NoteTypes.
#'
#' This function returns a dataframe of all NoteTypes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All NoteTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllNoteTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnNoteTypeID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnIndicatorID = F, returnIsActive = F, returnIsParentalConsent = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "NoteType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific NoteType
#'
#' This function returns fields for a NoteType.
#'
#' @param NoteTypeID The id of the NoteType.\cr Run \code{\link{getAllNoteTypes}} for a list of NoteTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the NoteType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getNoteType <- function(NoteTypeID, EntityID = 1, returnNoteTypeID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnIndicatorID = F, returnIsActive = F, returnIsParentalConsent = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "NoteType", NoteTypeID, searchFields, EntityID)
}
#' Modify a specific NoteType
#'
#' This function modifies fields for a NoteType.
#'
#' @param NoteTypeID The id of the NoteType to be modified.\cr Run \code{\link{getAllNoteTypes}} for a list of NoteTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified NoteType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyNoteType <- function(NoteTypeID, EntityID = 1, setCode = NULL, setDescription = NULL, setIndicatorID = NULL, setIsActive = NULL, setIsParentalConsent = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "NoteType", NoteTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new NoteType.
#'
#' This function creates a new NoteType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created NoteType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createNoteType <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setIndicatorID = NULL, setIsActive = NULL, setIsParentalConsent = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "NoteType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific NoteType
#'
#' This function deletes a NoteType.
#'
#' @param NoteTypeID The id of the NoteType.\cr Run \code{\link{getAllNoteTypes}} for a list of NoteTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted NoteType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteNoteType <- function(NoteTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "NoteType", NoteTypeID, EntityID)
}
#' Get all Religions.
#'
#' This function returns a dataframe of all Religions in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All Religions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllReligions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnReligionID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "Religion", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Religion
#'
#' This function returns fields for a Religion.
#'
#' @param ReligionID The id of the Religion.\cr Run \code{\link{getAllReligions}} for a list of Religions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the Religion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getReligion <- function(ReligionID, EntityID = 1, returnReligionID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "Religion", ReligionID, searchFields, EntityID)
}
#' Modify a specific Religion
#'
#' This function modifies fields for a Religion.
#'
#' @param ReligionID The id of the Religion to be modified.\cr Run \code{\link{getAllReligions}} for a list of Religions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified Religion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyReligion <- function(ReligionID, EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "Religion", ReligionID, names(functionParams), functionParams, EntityID)
}
#' Create new Religion.
#'
#' This function creates a new Religion.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created Religion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createReligion <- function(EntityID = 1, setCode = NULL, setDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "Religion", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Religion
#'
#' This function deletes a Religion.
#'
#' @param ReligionID The id of the Religion.\cr Run \code{\link{getAllReligions}} for a list of Religions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted Religion.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteReligion <- function(ReligionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "Religion", ReligionID, EntityID)
}
#' Get all SkylertAttendanceExportAttendanceTypes.
#'
#' This function returns a dataframe of all SkylertAttendanceExportAttendanceTypes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All SkylertAttendanceExportAttendanceTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSkylertAttendanceExportAttendanceTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSkylertAttendanceExportAttendanceTypeID = F, returnAttendanceTypeCodeOverride = F, returnAttendanceTypeID = F, returnCreatedTime = F, returnModifiedTime = F, returnSkylertAttendanceExportSettingID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "SkylertAttendanceExportAttendanceType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SkylertAttendanceExportAttendanceType
#'
#' This function returns fields for a SkylertAttendanceExportAttendanceType.
#'
#' @param SkylertAttendanceExportAttendanceTypeID The id of the SkylertAttendanceExportAttendanceType.\cr Run \code{\link{getAllSkylertAttendanceExportAttendanceTypes}} for a list of SkylertAttendanceExportAttendanceTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the SkylertAttendanceExportAttendanceType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSkylertAttendanceExportAttendanceType <- function(SkylertAttendanceExportAttendanceTypeID, EntityID = 1, returnSkylertAttendanceExportAttendanceTypeID = F, returnAttendanceTypeCodeOverride = F, returnAttendanceTypeID = F, returnCreatedTime = F, returnModifiedTime = F, returnSkylertAttendanceExportSettingID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "SkylertAttendanceExportAttendanceType", SkylertAttendanceExportAttendanceTypeID, searchFields, EntityID)
}
#' Modify a specific SkylertAttendanceExportAttendanceType
#'
#' This function modifies fields for a SkylertAttendanceExportAttendanceType.
#'
#' @param SkylertAttendanceExportAttendanceTypeID The id of the SkylertAttendanceExportAttendanceType to be modified.\cr Run \code{\link{getAllSkylertAttendanceExportAttendanceTypes}} for a list of SkylertAttendanceExportAttendanceTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified SkylertAttendanceExportAttendanceType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySkylertAttendanceExportAttendanceType <- function(SkylertAttendanceExportAttendanceTypeID, EntityID = 1, setAttendanceTypeCodeOverride = NULL, setAttendanceTypeID = NULL, setSkylertAttendanceExportSettingID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "SkylertAttendanceExportAttendanceType", SkylertAttendanceExportAttendanceTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new SkylertAttendanceExportAttendanceType.
#'
#' This function creates a new SkylertAttendanceExportAttendanceType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created SkylertAttendanceExportAttendanceType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSkylertAttendanceExportAttendanceType <- function(EntityID = 1, setAttendanceTypeCodeOverride = NULL, setAttendanceTypeID = NULL, setSkylertAttendanceExportSettingID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "SkylertAttendanceExportAttendanceType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SkylertAttendanceExportAttendanceType
#'
#' This function deletes a SkylertAttendanceExportAttendanceType.
#'
#' @param SkylertAttendanceExportAttendanceTypeID The id of the SkylertAttendanceExportAttendanceType.\cr Run \code{\link{getAllSkylertAttendanceExportAttendanceTypes}} for a list of SkylertAttendanceExportAttendanceTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted SkylertAttendanceExportAttendanceType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSkylertAttendanceExportAttendanceType <- function(SkylertAttendanceExportAttendanceTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "SkylertAttendanceExportAttendanceType", SkylertAttendanceExportAttendanceTypeID, EntityID)
}
#' Get all SkylertAttendanceExportSettings.
#'
#' This function returns a dataframe of all SkylertAttendanceExportSettings in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All SkylertAttendanceExportSettings in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSkylertAttendanceExportSettings <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSkylertAttendanceExportSettingID = F, returnAttendancePeriodIDHigh = F, returnAttendancePeriodIDLow = F, returnCreatedTime = F, returnEntityID = F, returnFileSequence = F, returnMinimumPeriodsAbsent = F, returnModifiedTime = F, returnParentNotifiedOption = F, returnParentNotifiedOptionCode = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "SkylertAttendanceExportSetting", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SkylertAttendanceExportSetting
#'
#' This function returns fields for a SkylertAttendanceExportSetting.
#'
#' @param SkylertAttendanceExportSettingID The id of the SkylertAttendanceExportSetting.\cr Run \code{\link{getAllSkylertAttendanceExportSettings}} for a list of SkylertAttendanceExportSettings.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the SkylertAttendanceExportSetting.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSkylertAttendanceExportSetting <- function(SkylertAttendanceExportSettingID, EntityID = 1, returnSkylertAttendanceExportSettingID = F, returnAttendancePeriodIDHigh = F, returnAttendancePeriodIDLow = F, returnCreatedTime = F, returnEntityID = F, returnFileSequence = F, returnMinimumPeriodsAbsent = F, returnModifiedTime = F, returnParentNotifiedOption = F, returnParentNotifiedOptionCode = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "SkylertAttendanceExportSetting", SkylertAttendanceExportSettingID, searchFields, EntityID)
}
#' Modify a specific SkylertAttendanceExportSetting
#'
#' This function modifies fields for a SkylertAttendanceExportSetting.
#'
#' @param SkylertAttendanceExportSettingID The id of the SkylertAttendanceExportSetting to be modified.\cr Run \code{\link{getAllSkylertAttendanceExportSettings}} for a list of SkylertAttendanceExportSettings.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified SkylertAttendanceExportSetting.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySkylertAttendanceExportSetting <- function(SkylertAttendanceExportSettingID, EntityID = 1, setAttendancePeriodIDHigh = NULL, setAttendancePeriodIDLow = NULL, setEntityID = NULL, setFileSequence = NULL, setMinimumPeriodsAbsent = NULL, setParentNotifiedOption = NULL, setParentNotifiedOptionCode = NULL, setSchoolYearID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "SkylertAttendanceExportSetting", SkylertAttendanceExportSettingID, names(functionParams), functionParams, EntityID)
}
#' Create new SkylertAttendanceExportSetting.
#'
#' This function creates a new SkylertAttendanceExportSetting.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created SkylertAttendanceExportSetting.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSkylertAttendanceExportSetting <- function(EntityID = 1, setAttendancePeriodIDHigh = NULL, setAttendancePeriodIDLow = NULL, setEntityID = NULL, setFileSequence = NULL, setMinimumPeriodsAbsent = NULL, setParentNotifiedOption = NULL, setParentNotifiedOptionCode = NULL, setSchoolYearID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "SkylertAttendanceExportSetting", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SkylertAttendanceExportSetting
#'
#' This function deletes a SkylertAttendanceExportSetting.
#'
#' @param SkylertAttendanceExportSettingID The id of the SkylertAttendanceExportSetting.\cr Run \code{\link{getAllSkylertAttendanceExportSettings}} for a list of SkylertAttendanceExportSettings.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted SkylertAttendanceExportSetting.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSkylertAttendanceExportSetting <- function(SkylertAttendanceExportSettingID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "SkylertAttendanceExportSetting", SkylertAttendanceExportSettingID, EntityID)
}
#' Get all SkylertAttendanceExportSettingScheduledTasks.
#'
#' This function returns a dataframe of all SkylertAttendanceExportSettingScheduledTasks in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All SkylertAttendanceExportSettingScheduledTasks in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSkylertAttendanceExportSettingScheduledTasks <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSkylertAttendanceExportSettingScheduledTaskID = F, returnCreatedTime = F, returnModifiedTime = F, returnScheduledTaskID = F, returnSkylertAttendanceExportSettingID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "SkylertAttendanceExportSettingScheduledTask", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SkylertAttendanceExportSettingScheduledTask
#'
#' This function returns fields for a SkylertAttendanceExportSettingScheduledTask.
#'
#' @param SkylertAttendanceExportSettingScheduledTaskID The id of the SkylertAttendanceExportSettingScheduledTask.\cr Run \code{\link{getAllSkylertAttendanceExportSettingScheduledTasks}} for a list of SkylertAttendanceExportSettingScheduledTasks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the SkylertAttendanceExportSettingScheduledTask.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSkylertAttendanceExportSettingScheduledTask <- function(SkylertAttendanceExportSettingScheduledTaskID, EntityID = 1, returnSkylertAttendanceExportSettingScheduledTaskID = F, returnCreatedTime = F, returnModifiedTime = F, returnScheduledTaskID = F, returnSkylertAttendanceExportSettingID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "SkylertAttendanceExportSettingScheduledTask", SkylertAttendanceExportSettingScheduledTaskID, searchFields, EntityID)
}
#' Modify a specific SkylertAttendanceExportSettingScheduledTask
#'
#' This function modifies fields for a SkylertAttendanceExportSettingScheduledTask.
#'
#' @param SkylertAttendanceExportSettingScheduledTaskID The id of the SkylertAttendanceExportSettingScheduledTask to be modified.\cr Run \code{\link{getAllSkylertAttendanceExportSettingScheduledTasks}} for a list of SkylertAttendanceExportSettingScheduledTasks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified SkylertAttendanceExportSettingScheduledTask.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySkylertAttendanceExportSettingScheduledTask <- function(SkylertAttendanceExportSettingScheduledTaskID, EntityID = 1, setScheduledTaskID = NULL, setSkylertAttendanceExportSettingID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "SkylertAttendanceExportSettingScheduledTask", SkylertAttendanceExportSettingScheduledTaskID, names(functionParams), functionParams, EntityID)
}
#' Create new SkylertAttendanceExportSettingScheduledTask.
#'
#' This function creates a new SkylertAttendanceExportSettingScheduledTask.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created SkylertAttendanceExportSettingScheduledTask.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSkylertAttendanceExportSettingScheduledTask <- function(EntityID = 1, setScheduledTaskID = NULL, setSkylertAttendanceExportSettingID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "SkylertAttendanceExportSettingScheduledTask", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SkylertAttendanceExportSettingScheduledTask
#'
#' This function deletes a SkylertAttendanceExportSettingScheduledTask.
#'
#' @param SkylertAttendanceExportSettingScheduledTaskID The id of the SkylertAttendanceExportSettingScheduledTask.\cr Run \code{\link{getAllSkylertAttendanceExportSettingScheduledTasks}} for a list of SkylertAttendanceExportSettingScheduledTasks.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted SkylertAttendanceExportSettingScheduledTask.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSkylertAttendanceExportSettingScheduledTask <- function(SkylertAttendanceExportSettingScheduledTaskID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "SkylertAttendanceExportSettingScheduledTask", SkylertAttendanceExportSettingScheduledTaskID, EntityID)
}
#' Get all SpringSports.
#'
#' This function returns a dataframe of all SpringSports in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All SpringSports in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSpringSports <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSpringSportID = F, returnCode = F, returnCreatedTime = F, returnModifiedTime = F, returnSpringSport = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "SpringSport", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SpringSport
#'
#' This function returns fields for a SpringSport.
#'
#' @param SpringSportID The id of the SpringSport.\cr Run \code{\link{getAllSpringSports}} for a list of SpringSports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the SpringSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSpringSport <- function(SpringSportID, EntityID = 1, returnSpringSportID = F, returnCode = F, returnCreatedTime = F, returnModifiedTime = F, returnSpringSport = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "SpringSport", SpringSportID, searchFields, EntityID)
}
#' Modify a specific SpringSport
#'
#' This function modifies fields for a SpringSport.
#'
#' @param SpringSportID The id of the SpringSport to be modified.\cr Run \code{\link{getAllSpringSports}} for a list of SpringSports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified SpringSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySpringSport <- function(SpringSportID, EntityID = 1, setCode = NULL, setSpringSport = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "SpringSport", SpringSportID, names(functionParams), functionParams, EntityID)
}
#' Create new SpringSport.
#'
#' This function creates a new SpringSport.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created SpringSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSpringSport <- function(EntityID = 1, setCode = NULL, setSpringSport = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "SpringSport", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SpringSport
#'
#' This function deletes a SpringSport.
#'
#' @param SpringSportID The id of the SpringSport.\cr Run \code{\link{getAllSpringSports}} for a list of SpringSports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted SpringSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSpringSport <- function(SpringSportID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "SpringSport", SpringSportID, EntityID)
}
#' Get all SpringSportsTeams.
#'
#' This function returns a dataframe of all SpringSportsTeams in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All SpringSportsTeams in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSpringSportsTeams <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSpringSportsTeamID = F, returnCaptain = F, returnCreatedTime = F, returnLettered = F, returnModifiedTime = F, returnSchoolYearID = F, returnSpringSportID = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "SpringSportsTeam", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SpringSportsTeam
#'
#' This function returns fields for a SpringSportsTeam.
#'
#' @param SpringSportsTeamID The id of the SpringSportsTeam.\cr Run \code{\link{getAllSpringSportsTeams}} for a list of SpringSportsTeams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the SpringSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSpringSportsTeam <- function(SpringSportsTeamID, EntityID = 1, returnSpringSportsTeamID = F, returnCaptain = F, returnCreatedTime = F, returnLettered = F, returnModifiedTime = F, returnSchoolYearID = F, returnSpringSportID = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "SpringSportsTeam", SpringSportsTeamID, searchFields, EntityID)
}
#' Modify a specific SpringSportsTeam
#'
#' This function modifies fields for a SpringSportsTeam.
#'
#' @param SpringSportsTeamID The id of the SpringSportsTeam to be modified.\cr Run \code{\link{getAllSpringSportsTeams}} for a list of SpringSportsTeams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified SpringSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySpringSportsTeam <- function(SpringSportsTeamID, EntityID = 1, setCaptain = NULL, setLettered = NULL, setSchoolYearID = NULL, setSpringSportID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "SpringSportsTeam", SpringSportsTeamID, names(functionParams), functionParams, EntityID)
}
#' Create new SpringSportsTeam.
#'
#' This function creates a new SpringSportsTeam.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created SpringSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSpringSportsTeam <- function(EntityID = 1, setCaptain = NULL, setLettered = NULL, setSchoolYearID = NULL, setSpringSportID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "SpringSportsTeam", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SpringSportsTeam
#'
#' This function deletes a SpringSportsTeam.
#'
#' @param SpringSportsTeamID The id of the SpringSportsTeam.\cr Run \code{\link{getAllSpringSportsTeams}} for a list of SpringSportsTeams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted SpringSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSpringSportsTeam <- function(SpringSportsTeamID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "SpringSportsTeam", SpringSportsTeamID, EntityID)
}
#' Get all StudentActivities.
#'
#' This function returns a dataframe of all StudentActivities in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All StudentActivities in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentActivities <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentActivityID = F, returnActivityID = F, returnCourseID = F, returnCreatedTime = F, returnHasParticipation = F, returnIsActive = F, returnModifiedTime = F, returnStudentActivityIDClonedFrom = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "StudentActivity", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentActivity
#'
#' This function returns fields for a StudentActivity.
#'
#' @param StudentActivityID The id of the StudentActivity.\cr Run \code{\link{getAllStudentActivities}} for a list of StudentActivities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the StudentActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentActivity <- function(StudentActivityID, EntityID = 1, returnStudentActivityID = F, returnActivityID = F, returnCourseID = F, returnCreatedTime = F, returnHasParticipation = F, returnIsActive = F, returnModifiedTime = F, returnStudentActivityIDClonedFrom = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "StudentActivity", StudentActivityID, searchFields, EntityID)
}
#' Modify a specific StudentActivity
#'
#' This function modifies fields for a StudentActivity.
#'
#' @param StudentActivityID The id of the StudentActivity to be modified.\cr Run \code{\link{getAllStudentActivities}} for a list of StudentActivitys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified StudentActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentActivity <- function(StudentActivityID, EntityID = 1, setActivityID = NULL, setCourseID = NULL, setIsActive = NULL, setStudentActivityIDClonedFrom = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "StudentActivity", StudentActivityID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentActivity.
#'
#' This function creates a new StudentActivity.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created StudentActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentActivity <- function(EntityID = 1, setActivityID = NULL, setCourseID = NULL, setIsActive = NULL, setStudentActivityIDClonedFrom = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "StudentActivity", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentActivity
#'
#' This function deletes a StudentActivity.
#'
#' @param StudentActivityID The id of the StudentActivity.\cr Run \code{\link{getAllStudentActivities}} for a list of StudentActivities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted StudentActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentActivity <- function(StudentActivityID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "StudentActivity", StudentActivityID, EntityID)
}
#' Get all StudentActivityTransactions.
#'
#' This function returns a dataframe of all StudentActivityTransactions in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All StudentActivityTransactions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentActivityTransactions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentActivityTransactionID = F, returnCreatedTime = F, returnModifiedTime = F, returnParticipationEndDate = F, returnParticipationStartDate = F, returnStudentActivityID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "StudentActivityTransaction", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentActivityTransaction
#'
#' This function returns fields for a StudentActivityTransaction.
#'
#' @param StudentActivityTransactionID The id of the StudentActivityTransaction.\cr Run \code{\link{getAllStudentActivityTransactions}} for a list of StudentActivityTransactions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the StudentActivityTransaction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentActivityTransaction <- function(StudentActivityTransactionID, EntityID = 1, returnStudentActivityTransactionID = F, returnCreatedTime = F, returnModifiedTime = F, returnParticipationEndDate = F, returnParticipationStartDate = F, returnStudentActivityID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "StudentActivityTransaction", StudentActivityTransactionID, searchFields, EntityID)
}
#' Modify a specific StudentActivityTransaction
#'
#' This function modifies fields for a StudentActivityTransaction.
#'
#' @param StudentActivityTransactionID The id of the StudentActivityTransaction to be modified.\cr Run \code{\link{getAllStudentActivityTransactions}} for a list of StudentActivityTransactions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified StudentActivityTransaction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentActivityTransaction <- function(StudentActivityTransactionID, EntityID = 1, setParticipationEndDate = NULL, setParticipationStartDate = NULL, setStudentActivityID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "StudentActivityTransaction", StudentActivityTransactionID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentActivityTransaction.
#'
#' This function creates a new StudentActivityTransaction.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created StudentActivityTransaction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentActivityTransaction <- function(EntityID = 1, setParticipationEndDate = NULL, setParticipationStartDate = NULL, setStudentActivityID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "StudentActivityTransaction", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentActivityTransaction
#'
#' This function deletes a StudentActivityTransaction.
#'
#' @param StudentActivityTransactionID The id of the StudentActivityTransaction.\cr Run \code{\link{getAllStudentActivityTransactions}} for a list of StudentActivityTransactions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted StudentActivityTransaction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentActivityTransaction <- function(StudentActivityTransactionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "StudentActivityTransaction", StudentActivityTransactionID, EntityID)
}
#' Get all StudentAwards.
#'
#' This function returns a dataframe of all StudentAwards in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All StudentAwards in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentAwards <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentAwardID = F, returnActivityID = F, returnAwardCategoryID = F, returnAwardHardwareID = F, returnAwardTypeID = F, returnCreatedTime = F, returnModifiedTime = F, returnSchoolYearID = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "StudentAward", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentAward
#'
#' This function returns fields for a StudentAward.
#'
#' @param StudentAwardID The id of the StudentAward.\cr Run \code{\link{getAllStudentAwards}} for a list of StudentAwards.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the StudentAward.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentAward <- function(StudentAwardID, EntityID = 1, returnStudentAwardID = F, returnActivityID = F, returnAwardCategoryID = F, returnAwardHardwareID = F, returnAwardTypeID = F, returnCreatedTime = F, returnModifiedTime = F, returnSchoolYearID = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "StudentAward", StudentAwardID, searchFields, EntityID)
}
#' Modify a specific StudentAward
#'
#' This function modifies fields for a StudentAward.
#'
#' @param StudentAwardID The id of the StudentAward to be modified.\cr Run \code{\link{getAllStudentAwards}} for a list of StudentAwards.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified StudentAward.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentAward <- function(StudentAwardID, EntityID = 1, setActivityID = NULL, setAwardCategoryID = NULL, setAwardHardwareID = NULL, setAwardTypeID = NULL, setSchoolYearID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "StudentAward", StudentAwardID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentAward.
#'
#' This function creates a new StudentAward.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created StudentAward.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentAward <- function(EntityID = 1, setActivityID = NULL, setAwardCategoryID = NULL, setAwardHardwareID = NULL, setAwardTypeID = NULL, setSchoolYearID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "StudentAward", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentAward
#'
#' This function deletes a StudentAward.
#'
#' @param StudentAwardID The id of the StudentAward.\cr Run \code{\link{getAllStudentAwards}} for a list of StudentAwards.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted StudentAward.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentAward <- function(StudentAwardID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "StudentAward", StudentAwardID, EntityID)
}
#' Get all StudentCustomCodes.
#'
#' This function returns a dataframe of all StudentCustomCodes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All StudentCustomCodes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentCustomCodes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentCustomCodeID = F, returnCreatedTime = F, returnCustomCodeID = F, returnModifiedTime = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "StudentCustomCode", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentCustomCode
#'
#' This function returns fields for a StudentCustomCode.
#'
#' @param StudentCustomCodeID The id of the StudentCustomCode.\cr Run \code{\link{getAllStudentCustomCodes}} for a list of StudentCustomCodes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the StudentCustomCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentCustomCode <- function(StudentCustomCodeID, EntityID = 1, returnStudentCustomCodeID = F, returnCreatedTime = F, returnCustomCodeID = F, returnModifiedTime = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "StudentCustomCode", StudentCustomCodeID, searchFields, EntityID)
}
#' Modify a specific StudentCustomCode
#'
#' This function modifies fields for a StudentCustomCode.
#'
#' @param StudentCustomCodeID The id of the StudentCustomCode to be modified.\cr Run \code{\link{getAllStudentCustomCodes}} for a list of StudentCustomCodes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified StudentCustomCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentCustomCode <- function(StudentCustomCodeID, EntityID = 1, setCustomCodeID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "StudentCustomCode", StudentCustomCodeID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentCustomCode.
#'
#' This function creates a new StudentCustomCode.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created StudentCustomCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentCustomCode <- function(EntityID = 1, setCustomCodeID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "StudentCustomCode", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentCustomCode
#'
#' This function deletes a StudentCustomCode.
#'
#' @param StudentCustomCodeID The id of the StudentCustomCode.\cr Run \code{\link{getAllStudentCustomCodes}} for a list of StudentCustomCodes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted StudentCustomCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentCustomCode <- function(StudentCustomCodeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "StudentCustomCode", StudentCustomCodeID, EntityID)
}
#' Get all StudentDistricts.
#'
#' This function returns a dataframe of all StudentDistricts in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All StudentDistricts in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentDistricts <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentDistrictID = F, returnCreatedTime = F, returnDistrictID = F, returnFeederSchoolID = F, returnFirstName = F, returnGrade = F, returnLastName = F, returnMiddleName = F, returnModifiedTime = F, returnNameID = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "StudentDistrict", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentDistrict
#'
#' This function returns fields for a StudentDistrict.
#'
#' @param StudentDistrictID The id of the StudentDistrict.\cr Run \code{\link{getAllStudentDistricts}} for a list of StudentDistricts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the StudentDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentDistrict <- function(StudentDistrictID, EntityID = 1, returnStudentDistrictID = F, returnCreatedTime = F, returnDistrictID = F, returnFeederSchoolID = F, returnFirstName = F, returnGrade = F, returnLastName = F, returnMiddleName = F, returnModifiedTime = F, returnNameID = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "StudentDistrict", StudentDistrictID, searchFields, EntityID)
}
#' Modify a specific StudentDistrict
#'
#' This function modifies fields for a StudentDistrict.
#'
#' @param StudentDistrictID The id of the StudentDistrict to be modified.\cr Run \code{\link{getAllStudentDistricts}} for a list of StudentDistricts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified StudentDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentDistrict <- function(StudentDistrictID, EntityID = 1, setDistrictID = NULL, setFeederSchoolID = NULL, setGrade = NULL, setNameID = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "StudentDistrict", StudentDistrictID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentDistrict.
#'
#' This function creates a new StudentDistrict.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created StudentDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentDistrict <- function(EntityID = 1, setDistrictID = NULL, setFeederSchoolID = NULL, setGrade = NULL, setNameID = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "StudentDistrict", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentDistrict
#'
#' This function deletes a StudentDistrict.
#'
#' @param StudentDistrictID The id of the StudentDistrict.\cr Run \code{\link{getAllStudentDistricts}} for a list of StudentDistricts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted StudentDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentDistrict <- function(StudentDistrictID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "StudentDistrict", StudentDistrictID, EntityID)
}
#' Get all StudentEthnicityMAs.
#'
#' This function returns a dataframe of all StudentEthnicityMAs in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All StudentEthnicityMAs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentEthnicityMAs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentEthnicityMAID = F, returnCreatedTime = F, returnEthnicityMAID = F, returnModifiedTime = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "StudentEthnicityMA", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentEthnicityMA
#'
#' This function returns fields for a StudentEthnicityMA.
#'
#' @param StudentEthnicityMAID The id of the StudentEthnicityMA.\cr Run \code{\link{getAllStudentEthnicityMAs}} for a list of StudentEthnicityMAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the StudentEthnicityMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentEthnicityMA <- function(StudentEthnicityMAID, EntityID = 1, returnStudentEthnicityMAID = F, returnCreatedTime = F, returnEthnicityMAID = F, returnModifiedTime = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "StudentEthnicityMA", StudentEthnicityMAID, searchFields, EntityID)
}
#' Modify a specific StudentEthnicityMA
#'
#' This function modifies fields for a StudentEthnicityMA.
#'
#' @param StudentEthnicityMAID The id of the StudentEthnicityMA to be modified.\cr Run \code{\link{getAllStudentEthnicityMAs}} for a list of StudentEthnicityMAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified StudentEthnicityMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentEthnicityMA <- function(StudentEthnicityMAID, EntityID = 1, setEthnicityMAID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "StudentEthnicityMA", StudentEthnicityMAID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentEthnicityMA.
#'
#' This function creates a new StudentEthnicityMA.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created StudentEthnicityMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentEthnicityMA <- function(EntityID = 1, setEthnicityMAID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "StudentEthnicityMA", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentEthnicityMA
#'
#' This function deletes a StudentEthnicityMA.
#'
#' @param StudentEthnicityMAID The id of the StudentEthnicityMA.\cr Run \code{\link{getAllStudentEthnicityMAs}} for a list of StudentEthnicityMAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted StudentEthnicityMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentEthnicityMA <- function(StudentEthnicityMAID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "StudentEthnicityMA", StudentEthnicityMAID, EntityID)
}
#' Get all StudentLockers.
#'
#' This function returns a dataframe of all StudentLockers in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All StudentLockers in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentLockers <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentLockerID = F, returnCreatedTime = F, returnIsPrimaryLocker = F, returnLockerID = F, returnModifiedTime = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "StudentLocker", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentLocker
#'
#' This function returns fields for a StudentLocker.
#'
#' @param StudentLockerID The id of the StudentLocker.\cr Run \code{\link{getAllStudentLockers}} for a list of StudentLockers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the StudentLocker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentLocker <- function(StudentLockerID, EntityID = 1, returnStudentLockerID = F, returnCreatedTime = F, returnIsPrimaryLocker = F, returnLockerID = F, returnModifiedTime = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "StudentLocker", StudentLockerID, searchFields, EntityID)
}
#' Modify a specific StudentLocker
#'
#' This function modifies fields for a StudentLocker.
#'
#' @param StudentLockerID The id of the StudentLocker to be modified.\cr Run \code{\link{getAllStudentLockers}} for a list of StudentLockers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified StudentLocker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentLocker <- function(StudentLockerID, EntityID = 1, setIsPrimaryLocker = NULL, setLockerID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "StudentLocker", StudentLockerID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentLocker.
#'
#' This function creates a new StudentLocker.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created StudentLocker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentLocker <- function(EntityID = 1, setIsPrimaryLocker = NULL, setLockerID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "StudentLocker", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentLocker
#'
#' This function deletes a StudentLocker.
#'
#' @param StudentLockerID The id of the StudentLocker.\cr Run \code{\link{getAllStudentLockers}} for a list of StudentLockers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted StudentLocker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentLocker <- function(StudentLockerID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "StudentLocker", StudentLockerID, EntityID)
}
#' Get all StudentMassUpdates.
#'
#' This function returns a dataframe of all StudentMassUpdates in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All StudentMassUpdates in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentMassUpdates <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentMassUpdateID = F, returnAsOfDate = F, returnCreatedTime = F, returnDistrictID = F, returnFilterParameters = F, returnModifiedTime = F, returnRunReason = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDRanBy = F, returnValueParameters = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "StudentMassUpdate", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentMassUpdate
#'
#' This function returns fields for a StudentMassUpdate.
#'
#' @param StudentMassUpdateID The id of the StudentMassUpdate.\cr Run \code{\link{getAllStudentMassUpdates}} for a list of StudentMassUpdates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the StudentMassUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentMassUpdate <- function(StudentMassUpdateID, EntityID = 1, returnStudentMassUpdateID = F, returnAsOfDate = F, returnCreatedTime = F, returnDistrictID = F, returnFilterParameters = F, returnModifiedTime = F, returnRunReason = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDRanBy = F, returnValueParameters = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "StudentMassUpdate", StudentMassUpdateID, searchFields, EntityID)
}
#' Modify a specific StudentMassUpdate
#'
#' This function modifies fields for a StudentMassUpdate.
#'
#' @param StudentMassUpdateID The id of the StudentMassUpdate to be modified.\cr Run \code{\link{getAllStudentMassUpdates}} for a list of StudentMassUpdates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified StudentMassUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentMassUpdate <- function(StudentMassUpdateID, EntityID = 1, setAsOfDate = NULL, setDistrictID = NULL, setFilterParameters = NULL, setRunReason = NULL, setSchoolYearID = NULL, setUserIDRanBy = NULL, setValueParameters = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "StudentMassUpdate", StudentMassUpdateID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentMassUpdate.
#'
#' This function creates a new StudentMassUpdate.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created StudentMassUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentMassUpdate <- function(EntityID = 1, setAsOfDate = NULL, setDistrictID = NULL, setFilterParameters = NULL, setRunReason = NULL, setSchoolYearID = NULL, setUserIDRanBy = NULL, setValueParameters = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "StudentMassUpdate", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentMassUpdate
#'
#' This function deletes a StudentMassUpdate.
#'
#' @param StudentMassUpdateID The id of the StudentMassUpdate.\cr Run \code{\link{getAllStudentMassUpdates}} for a list of StudentMassUpdates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted StudentMassUpdate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentMassUpdate <- function(StudentMassUpdateID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "StudentMassUpdate", StudentMassUpdateID, EntityID)
}
#' Get all StudentMedias.
#'
#' This function returns a dataframe of all StudentMedias in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All StudentMedias in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentMedias <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentMediaID = F, returnAttachmentTypeID = F, returnCreatedTime = F, returnDisplayInTeacherAccess = F, returnDisplayName = F, returnDisplayNameOrMediaName = F, returnDisplayOnFamilyAccessPortfolio = F, returnDisplayOnStudentAccessPortfolio = F, returnMediaID = F, returnModifiedTime = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "StudentMedia", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentMedia
#'
#' This function returns fields for a StudentMedia.
#'
#' @param StudentMediaID The id of the StudentMedia.\cr Run \code{\link{getAllStudentMedias}} for a list of StudentMedias.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the StudentMedia.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentMedia <- function(StudentMediaID, EntityID = 1, returnStudentMediaID = F, returnAttachmentTypeID = F, returnCreatedTime = F, returnDisplayInTeacherAccess = F, returnDisplayName = F, returnDisplayNameOrMediaName = F, returnDisplayOnFamilyAccessPortfolio = F, returnDisplayOnStudentAccessPortfolio = F, returnMediaID = F, returnModifiedTime = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "StudentMedia", StudentMediaID, searchFields, EntityID)
}
#' Modify a specific StudentMedia
#'
#' This function modifies fields for a StudentMedia.
#'
#' @param StudentMediaID The id of the StudentMedia to be modified.\cr Run \code{\link{getAllStudentMedias}} for a list of StudentMedias.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified StudentMedia.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentMedia <- function(StudentMediaID, EntityID = 1, setAttachmentTypeID = NULL, setDisplayInTeacherAccess = NULL, setDisplayName = NULL, setDisplayOnFamilyAccessPortfolio = NULL, setDisplayOnStudentAccessPortfolio = NULL, setMediaID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "StudentMedia", StudentMediaID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentMedia.
#'
#' This function creates a new StudentMedia.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created StudentMedia.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentMedia <- function(EntityID = 1, setAttachmentTypeID = NULL, setDisplayInTeacherAccess = NULL, setDisplayName = NULL, setDisplayOnFamilyAccessPortfolio = NULL, setDisplayOnStudentAccessPortfolio = NULL, setMediaID = NULL, setStudentID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "StudentMedia", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentMedia
#'
#' This function deletes a StudentMedia.
#'
#' @param StudentMediaID The id of the StudentMedia.\cr Run \code{\link{getAllStudentMedias}} for a list of StudentMedias.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted StudentMedia.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentMedia <- function(StudentMediaID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "StudentMedia", StudentMediaID, EntityID)
}
#' Get all Students.
#'
#' This function returns a dataframe of all Students in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All Students in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudents <- function(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){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "Student", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Student
#'
#' This function returns fields for a Student.
#'
#' @param StudentID The id of the Student.\cr Run \code{\link{getAllStudents}} for a list of Students.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the Student.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudent <- function(StudentID, EntityID = 1, 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){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "Student", StudentID, searchFields, EntityID)
}
#' Modify a specific Student
#'
#' This function modifies fields for a Student.
#'
#' @param StudentID The id of the Student to be modified.\cr Run \code{\link{getAllStudents}} for a list of Students.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified Student.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudent <- function(StudentID, EntityID = 1, setAllowDistrictDistribution = NULL, setAllowHigherEdDistribution = NULL, setAllowLocalDistribution = NULL, setAllowMediaDistribution = NULL, setAllowMilitaryDistribution = NULL, setAllowPublicDistribution = NULL, setAllowStudentAccess = NULL, setAllowTripsDistribution = NULL, setAllowVendorsDistribution = NULL, setArrestCount = NULL, setConversionKey = NULL, setCorporalPunishmentIncidents = NULL, setDentalPolicyNumber = NULL, setDisciplinedBullyingDisability = NULL, setDisciplinedBullyingRace = NULL, setDisciplinedBullyingSex = NULL, setEarliestDistrictEnrollmentDate = NULL, setEdFiCountryIDBirth = NULL, setExpulsionWithoutServicesCount = NULL, setExpulsionWithServicesCount = NULL, setFeeOnlinePaymentOverrideType = NULL, setFeeOnlinePaymentOverrideTypeCode = NULL, setFoodServiceOnlinePaymentOverrideType = NULL, setFoodServiceOnlinePaymentOverrideTypeCode = NULL, setGrade = NULL, setGradeNumeric = NULL, setGraduationDate = NULL, setGraduationRequirementYear = NULL, setGradYear = NULL, setHasAdvancedMathGrade0912 = NULL, setHasAlertIndicator = NULL, setHasAlgebraIGrade07 = NULL, setHasAlgebraIGrade08 = NULL, setHasAlgebraIGrade0910 = NULL, setHasAlgebraIGrade1112 = NULL, setHasAlgebraIIGrade0912 = NULL, setHasAPComputerScienceGrade0912 = NULL, setHasAPCourseGrade0912 = NULL, setHasAPMathGrade0912 = NULL, setHasAPOtherGrade0912 = NULL, setHasAPScienceGrade0912 = NULL, setHasBiologyGrade0912 = NULL, setHasCalculusGrade0912 = NULL, setHasChemistryGrade0912 = NULL, setHasComputerScienceGrade0912 = NULL, setHasCreditRecovery = NULL, setHasCriticalAlertIndicator = NULL, setHasGeneralNoteIndicator = NULL, setHasGeometryGrade08 = NULL, setHasGeometryGrade0912 = NULL, setHasHealthIndicator = NULL, setHasIHPIndicator = NULL, setHasInterventionPlanIndicator = NULL, setHasParentalConsentNoteIndicator = NULL, setHasPassedAlgebraIGrade07 = NULL, setHasPassedAlgebraIGrade08 = NULL, setHasPassedAlgebraIGrade0910 = NULL, setHasPassedAlgebraIGrade1112 = NULL, setHasPhysicsGrade0912 = NULL, setHasSection504Indicator = NULL, setHasSpecialEducationIndicator = NULL, setHasTakenACT0912 = NULL, setHasTakenAPExam0912 = NULL, setHasTakenSAT0912 = NULL, setHealthPolicyNumber = NULL, setHealthProfessionalIDDentist = NULL, setHealthProfessionalIDPrimaryPhysician = NULL, setIndicatorsXML = NULL, setInSchoolSuspensionCount = NULL, setIsChronicallyAbsent = NULL, setIsFederalDistanceEducation = NULL, setIsFederalDualEnrollment = NULL, setIsGiftedTalentedSnapshot = NULL, setIsGraduated = NULL, setIsIBDiplomaProgramme = NULL, setIsIDEA = NULL, setIsIDEASnapshot = NULL, setIsLEP = NULL, setIsLEPSnapshot = NULL, setIsSection504 = NULL, setIsSection504Snapshot = NULL, setIsStateReportingUnknownGender = NULL, setLanguageIDNative = NULL, setLanguageIDPrimary = NULL, setLawEnforcementReferralCount = NULL, setMechanicalRestraintCount = NULL, setMedicaidNumber = NULL, setMMRStatus = NULL, setNameID = NULL, setNameIDDentalInsuranceCompany = NULL, setNameIDDentalPractice = NULL, setNameIDHealthInsuranceCompany = NULL, setNameIDHospital = NULL, setOutOfSchoolSuspensionCount = NULL, setOutOfSchoolSuspensionMissedDays = NULL, setOverrideFeeOnlinePaymentAccess = NULL, setOverrideFoodServiceOnlinePaymentAccess = NULL, setPhysicalRestraintCount = NULL, setReportedBulliedDisability = NULL, setReportedBulliedRace = NULL, setReportedBulliedSex = NULL, setSeclusionCount = NULL, setSingleSexAthleticCount = NULL, setStateEthnicityRaceCodeMNID = NULL, setStudentNumber = NULL, setStudentStateID = NULL, setTransferToAlternativeSchool = NULL, setXMLIndicators = NULL, setZeroToleranceWithoutServicesCount = NULL, setZeroToleranceWithServicesCount = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "Student", StudentID, names(functionParams), functionParams, EntityID)
}
#' Create new Student.
#'
#' This function creates a new Student.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created Student.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudent <- function(EntityID = 1, setAllowDistrictDistribution = NULL, setAllowHigherEdDistribution = NULL, setAllowLocalDistribution = NULL, setAllowMediaDistribution = NULL, setAllowMilitaryDistribution = NULL, setAllowPublicDistribution = NULL, setAllowStudentAccess = NULL, setAllowTripsDistribution = NULL, setAllowVendorsDistribution = NULL, setArrestCount = NULL, setConversionKey = NULL, setCorporalPunishmentIncidents = NULL, setDentalPolicyNumber = NULL, setDisciplinedBullyingDisability = NULL, setDisciplinedBullyingRace = NULL, setDisciplinedBullyingSex = NULL, setEarliestDistrictEnrollmentDate = NULL, setEdFiCountryIDBirth = NULL, setExpulsionWithoutServicesCount = NULL, setExpulsionWithServicesCount = NULL, setFeeOnlinePaymentOverrideType = NULL, setFeeOnlinePaymentOverrideTypeCode = NULL, setFoodServiceOnlinePaymentOverrideType = NULL, setFoodServiceOnlinePaymentOverrideTypeCode = NULL, setGrade = NULL, setGradeNumeric = NULL, setGraduationDate = NULL, setGraduationRequirementYear = NULL, setGradYear = NULL, setHasAdvancedMathGrade0912 = NULL, setHasAlertIndicator = NULL, setHasAlgebraIGrade07 = NULL, setHasAlgebraIGrade08 = NULL, setHasAlgebraIGrade0910 = NULL, setHasAlgebraIGrade1112 = NULL, setHasAlgebraIIGrade0912 = NULL, setHasAPComputerScienceGrade0912 = NULL, setHasAPCourseGrade0912 = NULL, setHasAPMathGrade0912 = NULL, setHasAPOtherGrade0912 = NULL, setHasAPScienceGrade0912 = NULL, setHasBiologyGrade0912 = NULL, setHasCalculusGrade0912 = NULL, setHasChemistryGrade0912 = NULL, setHasComputerScienceGrade0912 = NULL, setHasCreditRecovery = NULL, setHasCriticalAlertIndicator = NULL, setHasGeneralNoteIndicator = NULL, setHasGeometryGrade08 = NULL, setHasGeometryGrade0912 = NULL, setHasHealthIndicator = NULL, setHasIHPIndicator = NULL, setHasInterventionPlanIndicator = NULL, setHasParentalConsentNoteIndicator = NULL, setHasPassedAlgebraIGrade07 = NULL, setHasPassedAlgebraIGrade08 = NULL, setHasPassedAlgebraIGrade0910 = NULL, setHasPassedAlgebraIGrade1112 = NULL, setHasPhysicsGrade0912 = NULL, setHasSection504Indicator = NULL, setHasSpecialEducationIndicator = NULL, setHasTakenACT0912 = NULL, setHasTakenAPExam0912 = NULL, setHasTakenSAT0912 = NULL, setHealthPolicyNumber = NULL, setHealthProfessionalIDDentist = NULL, setHealthProfessionalIDPrimaryPhysician = NULL, setIndicatorsXML = NULL, setInSchoolSuspensionCount = NULL, setIsChronicallyAbsent = NULL, setIsFederalDistanceEducation = NULL, setIsFederalDualEnrollment = NULL, setIsGiftedTalentedSnapshot = NULL, setIsGraduated = NULL, setIsIBDiplomaProgramme = NULL, setIsIDEA = NULL, setIsIDEASnapshot = NULL, setIsLEP = NULL, setIsLEPSnapshot = NULL, setIsSection504 = NULL, setIsSection504Snapshot = NULL, setIsStateReportingUnknownGender = NULL, setLanguageIDNative = NULL, setLanguageIDPrimary = NULL, setLawEnforcementReferralCount = NULL, setMechanicalRestraintCount = NULL, setMedicaidNumber = NULL, setMMRStatus = NULL, setNameID = NULL, setNameIDDentalInsuranceCompany = NULL, setNameIDDentalPractice = NULL, setNameIDHealthInsuranceCompany = NULL, setNameIDHospital = NULL, setOutOfSchoolSuspensionCount = NULL, setOutOfSchoolSuspensionMissedDays = NULL, setOverrideFeeOnlinePaymentAccess = NULL, setOverrideFoodServiceOnlinePaymentAccess = NULL, setPhysicalRestraintCount = NULL, setReportedBulliedDisability = NULL, setReportedBulliedRace = NULL, setReportedBulliedSex = NULL, setSeclusionCount = NULL, setSingleSexAthleticCount = NULL, setStateEthnicityRaceCodeMNID = NULL, setStudentNumber = NULL, setStudentStateID = NULL, setTransferToAlternativeSchool = NULL, setXMLIndicators = NULL, setZeroToleranceWithoutServicesCount = NULL, setZeroToleranceWithServicesCount = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "Student", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Student
#'
#' This function deletes a Student.
#'
#' @param StudentID The id of the Student.\cr Run \code{\link{getAllStudents}} for a list of Students.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted Student.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudent <- function(StudentID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "Student", StudentID, EntityID)
}
#' Get all StudentNotes.
#'
#' This function returns a dataframe of all StudentNotes in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All StudentNotes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentNotes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentNoteID = F, returnAttachmentCount = F, returnAttachmentIndicatorColumn = F, returnCreatedTime = F, returnDescription = F, returnEndDate = F, returnIsActive = F, returnModifiedTime = F, returnNoteTypeID = F, returnStartDate = F, returnStudentID = F, returnStudentTransportationID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "StudentNote", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentNote
#'
#' This function returns fields for a StudentNote.
#'
#' @param StudentNoteID The id of the StudentNote.\cr Run \code{\link{getAllStudentNotes}} for a list of StudentNotes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the StudentNote.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentNote <- function(StudentNoteID, EntityID = 1, returnStudentNoteID = F, returnAttachmentCount = F, returnAttachmentIndicatorColumn = F, returnCreatedTime = F, returnDescription = F, returnEndDate = F, returnIsActive = F, returnModifiedTime = F, returnNoteTypeID = F, returnStartDate = F, returnStudentID = F, returnStudentTransportationID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "StudentNote", StudentNoteID, searchFields, EntityID)
}
#' Modify a specific StudentNote
#'
#' This function modifies fields for a StudentNote.
#'
#' @param StudentNoteID The id of the StudentNote to be modified.\cr Run \code{\link{getAllStudentNotes}} for a list of StudentNotes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified StudentNote.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentNote <- function(StudentNoteID, EntityID = 1, setDescription = NULL, setEndDate = NULL, setIsActive = NULL, setNoteTypeID = NULL, setStartDate = NULL, setStudentID = NULL, setStudentTransportationID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "StudentNote", StudentNoteID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentNote.
#'
#' This function creates a new StudentNote.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created StudentNote.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentNote <- function(EntityID = 1, setDescription = NULL, setEndDate = NULL, setIsActive = NULL, setNoteTypeID = NULL, setStartDate = NULL, setStudentID = NULL, setStudentTransportationID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "StudentNote", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentNote
#'
#' This function deletes a StudentNote.
#'
#' @param StudentNoteID The id of the StudentNote.\cr Run \code{\link{getAllStudentNotes}} for a list of StudentNotes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted StudentNote.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentNote <- function(StudentNoteID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "StudentNote", StudentNoteID, EntityID)
}
#' Get all TempActivityRecords.
#'
#' This function returns a dataframe of all TempActivityRecords in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempActivityRecords in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempActivityRecords <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempActivityRecordID = F, returnActivityID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnNewEndDate = F, returnNewStartDate = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempActivityRecord", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempActivityRecord
#'
#' This function returns fields for a TempActivityRecord.
#'
#' @param TempActivityRecordID The id of the TempActivityRecord.\cr Run \code{\link{getAllTempActivityRecords}} for a list of TempActivityRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempActivityRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempActivityRecord <- function(TempActivityRecordID, EntityID = 1, returnTempActivityRecordID = F, returnActivityID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnNewEndDate = F, returnNewStartDate = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempActivityRecord", TempActivityRecordID, searchFields, EntityID)
}
#' Modify a specific TempActivityRecord
#'
#' This function modifies fields for a TempActivityRecord.
#'
#' @param TempActivityRecordID The id of the TempActivityRecord to be modified.\cr Run \code{\link{getAllTempActivityRecords}} for a list of TempActivityRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempActivityRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempActivityRecord <- function(TempActivityRecordID, EntityID = 1, setActivityID = NULL, setCode = NULL, setDescription = NULL, setNewEndDate = NULL, setNewStartDate = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempActivityRecord", TempActivityRecordID, names(functionParams), functionParams, EntityID)
}
#' Create new TempActivityRecord.
#'
#' This function creates a new TempActivityRecord.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempActivityRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempActivityRecord <- function(EntityID = 1, setActivityID = NULL, setCode = NULL, setDescription = NULL, setNewEndDate = NULL, setNewStartDate = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempActivityRecord", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempActivityRecord
#'
#' This function deletes a TempActivityRecord.
#'
#' @param TempActivityRecordID The id of the TempActivityRecord.\cr Run \code{\link{getAllTempActivityRecords}} for a list of TempActivityRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempActivityRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempActivityRecord <- function(TempActivityRecordID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempActivityRecord", TempActivityRecordID, EntityID)
}
#' Get all TempFitnessGrams.
#'
#' This function returns a dataframe of all TempFitnessGrams in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempFitnessGrams in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempFitnessGrams <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempFitnessGramID = F, returnClassDescription = F, returnClassEndDate = F, returnClassID = F, returnClassName = F, returnClassStartDate = F, returnCourseCodeDescription = F, returnCreatedTime = F, returnHasMissingData = F, returnMessage = F, returnModifiedTime = F, returnParentReportEmail1 = F, returnParentReportEmail2 = F, returnSchoolID = F, returnSectionCode = F, returnStudentBirthdate = F, returnStudentFirstName = F, returnStudentGender = F, returnStudentGrade = F, returnStudentID = F, returnStudentLastName = F, returnStudentMiddleInitial = F, returnStudentPassword = F, returnStudentReportEmail = F, returnStudentSSOID = F, returnTeacherBirthDate = F, returnTeacherEmail = F, returnTeacherFirstName = F, returnTeacherID = F, returnTeacherLastName = F, returnTeacherMiddleInitial = F, returnTeacherPassword = F, returnTeacherSSOID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempFitnessGram", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempFitnessGram
#'
#' This function returns fields for a TempFitnessGram.
#'
#' @param TempFitnessGramID The id of the TempFitnessGram.\cr Run \code{\link{getAllTempFitnessGrams}} for a list of TempFitnessGrams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempFitnessGram.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempFitnessGram <- function(TempFitnessGramID, EntityID = 1, returnTempFitnessGramID = F, returnClassDescription = F, returnClassEndDate = F, returnClassID = F, returnClassName = F, returnClassStartDate = F, returnCourseCodeDescription = F, returnCreatedTime = F, returnHasMissingData = F, returnMessage = F, returnModifiedTime = F, returnParentReportEmail1 = F, returnParentReportEmail2 = F, returnSchoolID = F, returnSectionCode = F, returnStudentBirthdate = F, returnStudentFirstName = F, returnStudentGender = F, returnStudentGrade = F, returnStudentID = F, returnStudentLastName = F, returnStudentMiddleInitial = F, returnStudentPassword = F, returnStudentReportEmail = F, returnStudentSSOID = F, returnTeacherBirthDate = F, returnTeacherEmail = F, returnTeacherFirstName = F, returnTeacherID = F, returnTeacherLastName = F, returnTeacherMiddleInitial = F, returnTeacherPassword = F, returnTeacherSSOID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempFitnessGram", TempFitnessGramID, searchFields, EntityID)
}
#' Modify a specific TempFitnessGram
#'
#' This function modifies fields for a TempFitnessGram.
#'
#' @param TempFitnessGramID The id of the TempFitnessGram to be modified.\cr Run \code{\link{getAllTempFitnessGrams}} for a list of TempFitnessGrams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempFitnessGram.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempFitnessGram <- function(TempFitnessGramID, EntityID = 1, setClassDescription = NULL, setClassEndDate = NULL, setClassID = NULL, setClassName = NULL, setClassStartDate = NULL, setCourseCodeDescription = NULL, setHasMissingData = NULL, setMessage = NULL, setParentReportEmail1 = NULL, setParentReportEmail2 = NULL, setSchoolID = NULL, setSectionCode = NULL, setStudentBirthdate = NULL, setStudentFirstName = NULL, setStudentGender = NULL, setStudentGrade = NULL, setStudentID = NULL, setStudentLastName = NULL, setStudentMiddleInitial = NULL, setStudentPassword = NULL, setStudentReportEmail = NULL, setStudentSSOID = NULL, setTeacherBirthDate = NULL, setTeacherEmail = NULL, setTeacherFirstName = NULL, setTeacherID = NULL, setTeacherLastName = NULL, setTeacherMiddleInitial = NULL, setTeacherPassword = NULL, setTeacherSSOID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempFitnessGram", TempFitnessGramID, names(functionParams), functionParams, EntityID)
}
#' Create new TempFitnessGram.
#'
#' This function creates a new TempFitnessGram.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempFitnessGram.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempFitnessGram <- function(EntityID = 1, setClassDescription = NULL, setClassEndDate = NULL, setClassID = NULL, setClassName = NULL, setClassStartDate = NULL, setCourseCodeDescription = NULL, setHasMissingData = NULL, setMessage = NULL, setParentReportEmail1 = NULL, setParentReportEmail2 = NULL, setSchoolID = NULL, setSectionCode = NULL, setStudentBirthdate = NULL, setStudentFirstName = NULL, setStudentGender = NULL, setStudentGrade = NULL, setStudentID = NULL, setStudentLastName = NULL, setStudentMiddleInitial = NULL, setStudentPassword = NULL, setStudentReportEmail = NULL, setStudentSSOID = NULL, setTeacherBirthDate = NULL, setTeacherEmail = NULL, setTeacherFirstName = NULL, setTeacherID = NULL, setTeacherLastName = NULL, setTeacherMiddleInitial = NULL, setTeacherPassword = NULL, setTeacherSSOID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempFitnessGram", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempFitnessGram
#'
#' This function deletes a TempFitnessGram.
#'
#' @param TempFitnessGramID The id of the TempFitnessGram.\cr Run \code{\link{getAllTempFitnessGrams}} for a list of TempFitnessGrams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempFitnessGram.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempFitnessGram <- function(TempFitnessGramID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempFitnessGram", TempFitnessGramID, EntityID)
}
#' Get all TempLockCombinations.
#'
#' This function returns a dataframe of all TempLockCombinations in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempLockCombinations in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempLockCombinations <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempLockCombinationID = F, returnCombination = F, returnCombinationNumber = F, returnCreatedTime = F, returnFailureReason = F, returnModifiedTime = F, returnTempLockerID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempLockCombination", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempLockCombination
#'
#' This function returns fields for a TempLockCombination.
#'
#' @param TempLockCombinationID The id of the TempLockCombination.\cr Run \code{\link{getAllTempLockCombinations}} for a list of TempLockCombinations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempLockCombination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempLockCombination <- function(TempLockCombinationID, EntityID = 1, returnTempLockCombinationID = F, returnCombination = F, returnCombinationNumber = F, returnCreatedTime = F, returnFailureReason = F, returnModifiedTime = F, returnTempLockerID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempLockCombination", TempLockCombinationID, searchFields, EntityID)
}
#' Modify a specific TempLockCombination
#'
#' This function modifies fields for a TempLockCombination.
#'
#' @param TempLockCombinationID The id of the TempLockCombination to be modified.\cr Run \code{\link{getAllTempLockCombinations}} for a list of TempLockCombinations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempLockCombination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempLockCombination <- function(TempLockCombinationID, EntityID = 1, setCombination = NULL, setCombinationNumber = NULL, setFailureReason = NULL, setTempLockerID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempLockCombination", TempLockCombinationID, names(functionParams), functionParams, EntityID)
}
#' Create new TempLockCombination.
#'
#' This function creates a new TempLockCombination.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempLockCombination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempLockCombination <- function(EntityID = 1, setCombination = NULL, setCombinationNumber = NULL, setFailureReason = NULL, setTempLockerID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempLockCombination", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempLockCombination
#'
#' This function deletes a TempLockCombination.
#'
#' @param TempLockCombinationID The id of the TempLockCombination.\cr Run \code{\link{getAllTempLockCombinations}} for a list of TempLockCombinations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempLockCombination.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempLockCombination <- function(TempLockCombinationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempLockCombination", TempLockCombinationID, EntityID)
}
#' Get all TempLockers.
#'
#' This function returns a dataframe of all TempLockers in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempLockers in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempLockers <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempLockerID = F, returnBuilding = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnFailureReason = F, returnLockerArea = F, returnLockerAreaID = F, returnLockerID = F, returnLockerNumber = F, returnLockerNumberDigitLength = F, returnModifiedTime = F, returnNewLockerNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempLocker", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempLocker
#'
#' This function returns fields for a TempLocker.
#'
#' @param TempLockerID The id of the TempLocker.\cr Run \code{\link{getAllTempLockers}} for a list of TempLockers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempLocker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempLocker <- function(TempLockerID, EntityID = 1, returnTempLockerID = F, returnBuilding = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnFailureReason = F, returnLockerArea = F, returnLockerAreaID = F, returnLockerID = F, returnLockerNumber = F, returnLockerNumberDigitLength = F, returnModifiedTime = F, returnNewLockerNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempLocker", TempLockerID, searchFields, EntityID)
}
#' Modify a specific TempLocker
#'
#' This function modifies fields for a TempLocker.
#'
#' @param TempLockerID The id of the TempLocker to be modified.\cr Run \code{\link{getAllTempLockers}} for a list of TempLockers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempLocker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempLocker <- function(TempLockerID, EntityID = 1, setBuilding = NULL, setBuildingID = NULL, setComment = NULL, setFailureReason = NULL, setLockerArea = NULL, setLockerAreaID = NULL, setLockerID = NULL, setLockerNumber = NULL, setLockerNumberDigitLength = NULL, setNewLockerNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempLocker", TempLockerID, names(functionParams), functionParams, EntityID)
}
#' Create new TempLocker.
#'
#' This function creates a new TempLocker.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempLocker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempLocker <- function(EntityID = 1, setBuilding = NULL, setBuildingID = NULL, setComment = NULL, setFailureReason = NULL, setLockerArea = NULL, setLockerAreaID = NULL, setLockerID = NULL, setLockerNumber = NULL, setLockerNumberDigitLength = NULL, setNewLockerNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempLocker", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempLocker
#'
#' This function deletes a TempLocker.
#'
#' @param TempLockerID The id of the TempLocker.\cr Run \code{\link{getAllTempLockers}} for a list of TempLockers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempLocker.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempLocker <- function(TempLockerID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempLocker", TempLockerID, EntityID)
}
#' Get all TempStudentActivities.
#'
#' This function returns a dataframe of all TempStudentActivities in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentActivities in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentActivities <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentActivityID = F, returnActivityID = F, returnAge = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnEndDate = F, returnEntityCode = F, returnErrorNumber = F, returnFullNameLFM = F, returnGenderCodeAndGender = F, returnGradeLevel = F, returnGradYear = F, returnIsActive = F, returnModifiedTime = F, returnParticipationEndDate = F, returnParticipationStartDate = F, returnStartDate = F, returnStudentID = F, returnStudentName = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentActivity", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentActivity
#'
#' This function returns fields for a TempStudentActivity.
#'
#' @param TempStudentActivityID The id of the TempStudentActivity.\cr Run \code{\link{getAllTempStudentActivities}} for a list of TempStudentActivities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentActivity <- function(TempStudentActivityID, EntityID = 1, returnTempStudentActivityID = F, returnActivityID = F, returnAge = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnEndDate = F, returnEntityCode = F, returnErrorNumber = F, returnFullNameLFM = F, returnGenderCodeAndGender = F, returnGradeLevel = F, returnGradYear = F, returnIsActive = F, returnModifiedTime = F, returnParticipationEndDate = F, returnParticipationStartDate = F, returnStartDate = F, returnStudentID = F, returnStudentName = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentActivity", TempStudentActivityID, searchFields, EntityID)
}
#' Modify a specific TempStudentActivity
#'
#' This function modifies fields for a TempStudentActivity.
#'
#' @param TempStudentActivityID The id of the TempStudentActivity to be modified.\cr Run \code{\link{getAllTempStudentActivities}} for a list of TempStudentActivitys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentActivity <- function(TempStudentActivityID, EntityID = 1, setActivityID = NULL, setAge = NULL, setCode = NULL, setDescription = NULL, setEndDate = NULL, setEntityCode = NULL, setErrorNumber = NULL, setFullNameLFM = NULL, setGenderCodeAndGender = NULL, setGradeLevel = NULL, setGradYear = NULL, setIsActive = NULL, setParticipationEndDate = NULL, setParticipationStartDate = NULL, setStartDate = NULL, setStudentID = NULL, setStudentName = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentActivity", TempStudentActivityID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentActivity.
#'
#' This function creates a new TempStudentActivity.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentActivity <- function(EntityID = 1, setActivityID = NULL, setAge = NULL, setCode = NULL, setDescription = NULL, setEndDate = NULL, setEntityCode = NULL, setErrorNumber = NULL, setFullNameLFM = NULL, setGenderCodeAndGender = NULL, setGradeLevel = NULL, setGradYear = NULL, setIsActive = NULL, setParticipationEndDate = NULL, setParticipationStartDate = NULL, setStartDate = NULL, setStudentID = NULL, setStudentName = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentActivity", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentActivity
#'
#' This function deletes a TempStudentActivity.
#'
#' @param TempStudentActivityID The id of the TempStudentActivity.\cr Run \code{\link{getAllTempStudentActivities}} for a list of TempStudentActivities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentActivity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentActivity <- function(TempStudentActivityID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentActivity", TempStudentActivityID, EntityID)
}
#' Get all TempStudentActivityErrors.
#'
#' This function returns a dataframe of all TempStudentActivityErrors in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentActivityErrors in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentActivityErrors <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentActivityErrorID = F, returnCreatedTime = F, returnErrorNumber = F, returnErrorText = F, returnModifiedTime = F, returnTempStudentActivityID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentActivityError", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentActivityError
#'
#' This function returns fields for a TempStudentActivityError.
#'
#' @param TempStudentActivityErrorID The id of the TempStudentActivityError.\cr Run \code{\link{getAllTempStudentActivityErrors}} for a list of TempStudentActivityErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentActivityError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentActivityError <- function(TempStudentActivityErrorID, EntityID = 1, returnTempStudentActivityErrorID = F, returnCreatedTime = F, returnErrorNumber = F, returnErrorText = F, returnModifiedTime = F, returnTempStudentActivityID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentActivityError", TempStudentActivityErrorID, searchFields, EntityID)
}
#' Modify a specific TempStudentActivityError
#'
#' This function modifies fields for a TempStudentActivityError.
#'
#' @param TempStudentActivityErrorID The id of the TempStudentActivityError to be modified.\cr Run \code{\link{getAllTempStudentActivityErrors}} for a list of TempStudentActivityErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentActivityError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentActivityError <- function(TempStudentActivityErrorID, EntityID = 1, setErrorNumber = NULL, setErrorText = NULL, setTempStudentActivityID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentActivityError", TempStudentActivityErrorID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentActivityError.
#'
#' This function creates a new TempStudentActivityError.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentActivityError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentActivityError <- function(EntityID = 1, setErrorNumber = NULL, setErrorText = NULL, setTempStudentActivityID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentActivityError", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentActivityError
#'
#' This function deletes a TempStudentActivityError.
#'
#' @param TempStudentActivityErrorID The id of the TempStudentActivityError.\cr Run \code{\link{getAllTempStudentActivityErrors}} for a list of TempStudentActivityErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentActivityError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentActivityError <- function(TempStudentActivityErrorID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentActivityError", TempStudentActivityErrorID, EntityID)
}
#' Get all TempStudentActivityTransactionRecords.
#'
#' This function returns a dataframe of all TempStudentActivityTransactionRecords in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentActivityTransactionRecords in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentActivityTransactionRecords <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentActivityTransactionRecordID = F, returnActivityID = F, returnCreatedTime = F, returnIsValidTransaction = F, returnModifiedTime = F, returnNewEndDate = F, returnNewStartDate = F, returnStudentActivityTransactionID = F, returnStudentFullNameLFM = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentActivityTransactionRecord", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentActivityTransactionRecord
#'
#' This function returns fields for a TempStudentActivityTransactionRecord.
#'
#' @param TempStudentActivityTransactionRecordID The id of the TempStudentActivityTransactionRecord.\cr Run \code{\link{getAllTempStudentActivityTransactionRecords}} for a list of TempStudentActivityTransactionRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentActivityTransactionRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentActivityTransactionRecord <- function(TempStudentActivityTransactionRecordID, EntityID = 1, returnTempStudentActivityTransactionRecordID = F, returnActivityID = F, returnCreatedTime = F, returnIsValidTransaction = F, returnModifiedTime = F, returnNewEndDate = F, returnNewStartDate = F, returnStudentActivityTransactionID = F, returnStudentFullNameLFM = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentActivityTransactionRecord", TempStudentActivityTransactionRecordID, searchFields, EntityID)
}
#' Modify a specific TempStudentActivityTransactionRecord
#'
#' This function modifies fields for a TempStudentActivityTransactionRecord.
#'
#' @param TempStudentActivityTransactionRecordID The id of the TempStudentActivityTransactionRecord to be modified.\cr Run \code{\link{getAllTempStudentActivityTransactionRecords}} for a list of TempStudentActivityTransactionRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentActivityTransactionRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentActivityTransactionRecord <- function(TempStudentActivityTransactionRecordID, EntityID = 1, setActivityID = NULL, setIsValidTransaction = NULL, setNewEndDate = NULL, setNewStartDate = NULL, setStudentActivityTransactionID = NULL, setStudentFullNameLFM = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentActivityTransactionRecord", TempStudentActivityTransactionRecordID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentActivityTransactionRecord.
#'
#' This function creates a new TempStudentActivityTransactionRecord.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentActivityTransactionRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentActivityTransactionRecord <- function(EntityID = 1, setActivityID = NULL, setIsValidTransaction = NULL, setNewEndDate = NULL, setNewStartDate = NULL, setStudentActivityTransactionID = NULL, setStudentFullNameLFM = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentActivityTransactionRecord", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentActivityTransactionRecord
#'
#' This function deletes a TempStudentActivityTransactionRecord.
#'
#' @param TempStudentActivityTransactionRecordID The id of the TempStudentActivityTransactionRecord.\cr Run \code{\link{getAllTempStudentActivityTransactionRecords}} for a list of TempStudentActivityTransactionRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentActivityTransactionRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentActivityTransactionRecord <- function(TempStudentActivityTransactionRecordID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentActivityTransactionRecord", TempStudentActivityTransactionRecordID, EntityID)
}
#' Get all TempStudentAssignedLockCombinationRecords.
#'
#' This function returns a dataframe of all TempStudentAssignedLockCombinationRecords in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentAssignedLockCombinationRecords in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentAssignedLockCombinationRecords <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentAssignedLockCombinationRecordID = F, returnAge = F, returnBirthDate = F, returnBuilding = F, returnCreatedTime = F, returnFullName = F, returnGender = F, returnGrade = F, returnGradYear = F, returnLockerArea = F, returnLockerID = F, returnLockerNumber = F, returnLockID = F, returnModifiedTime = F, returnNewCombination = F, returnNewCombinationNumber = F, returnNewLockCombinationID = F, returnOldCombination = F, returnOldCombinationNumber = F, returnOldLockCombinationID = F, returnStudentID = F, returnStudentNumber = F, returnUnoccupiedLockersOnly = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentAssignedLockCombinationRecord", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentAssignedLockCombinationRecord
#'
#' This function returns fields for a TempStudentAssignedLockCombinationRecord.
#'
#' @param TempStudentAssignedLockCombinationRecordID The id of the TempStudentAssignedLockCombinationRecord.\cr Run \code{\link{getAllTempStudentAssignedLockCombinationRecords}} for a list of TempStudentAssignedLockCombinationRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentAssignedLockCombinationRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentAssignedLockCombinationRecord <- function(TempStudentAssignedLockCombinationRecordID, EntityID = 1, returnTempStudentAssignedLockCombinationRecordID = F, returnAge = F, returnBirthDate = F, returnBuilding = F, returnCreatedTime = F, returnFullName = F, returnGender = F, returnGrade = F, returnGradYear = F, returnLockerArea = F, returnLockerID = F, returnLockerNumber = F, returnLockID = F, returnModifiedTime = F, returnNewCombination = F, returnNewCombinationNumber = F, returnNewLockCombinationID = F, returnOldCombination = F, returnOldCombinationNumber = F, returnOldLockCombinationID = F, returnStudentID = F, returnStudentNumber = F, returnUnoccupiedLockersOnly = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentAssignedLockCombinationRecord", TempStudentAssignedLockCombinationRecordID, searchFields, EntityID)
}
#' Modify a specific TempStudentAssignedLockCombinationRecord
#'
#' This function modifies fields for a TempStudentAssignedLockCombinationRecord.
#'
#' @param TempStudentAssignedLockCombinationRecordID The id of the TempStudentAssignedLockCombinationRecord to be modified.\cr Run \code{\link{getAllTempStudentAssignedLockCombinationRecords}} for a list of TempStudentAssignedLockCombinationRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentAssignedLockCombinationRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentAssignedLockCombinationRecord <- function(TempStudentAssignedLockCombinationRecordID, EntityID = 1, setAge = NULL, setBirthDate = NULL, setBuilding = NULL, setFullName = NULL, setGender = NULL, setGrade = NULL, setGradYear = NULL, setLockerArea = NULL, setLockerID = NULL, setLockerNumber = NULL, setLockID = NULL, setNewCombination = NULL, setNewCombinationNumber = NULL, setNewLockCombinationID = NULL, setOldCombination = NULL, setOldCombinationNumber = NULL, setOldLockCombinationID = NULL, setStudentID = NULL, setStudentNumber = NULL, setUnoccupiedLockersOnly = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentAssignedLockCombinationRecord", TempStudentAssignedLockCombinationRecordID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentAssignedLockCombinationRecord.
#'
#' This function creates a new TempStudentAssignedLockCombinationRecord.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentAssignedLockCombinationRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentAssignedLockCombinationRecord <- function(EntityID = 1, setAge = NULL, setBirthDate = NULL, setBuilding = NULL, setFullName = NULL, setGender = NULL, setGrade = NULL, setGradYear = NULL, setLockerArea = NULL, setLockerID = NULL, setLockerNumber = NULL, setLockID = NULL, setNewCombination = NULL, setNewCombinationNumber = NULL, setNewLockCombinationID = NULL, setOldCombination = NULL, setOldCombinationNumber = NULL, setOldLockCombinationID = NULL, setStudentID = NULL, setStudentNumber = NULL, setUnoccupiedLockersOnly = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentAssignedLockCombinationRecord", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentAssignedLockCombinationRecord
#'
#' This function deletes a TempStudentAssignedLockCombinationRecord.
#'
#' @param TempStudentAssignedLockCombinationRecordID The id of the TempStudentAssignedLockCombinationRecord.\cr Run \code{\link{getAllTempStudentAssignedLockCombinationRecords}} for a list of TempStudentAssignedLockCombinationRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentAssignedLockCombinationRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentAssignedLockCombinationRecord <- function(TempStudentAssignedLockCombinationRecordID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentAssignedLockCombinationRecord", TempStudentAssignedLockCombinationRecordID, EntityID)
}
#' Get all TempStudentAssignedLockerRecords.
#'
#' This function returns a dataframe of all TempStudentAssignedLockerRecords in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentAssignedLockerRecords in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentAssignedLockerRecords <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentAssignedLockerRecordID = F, returnAge = F, returnBirthDate = F, returnBuilding = F, returnCombination = F, returnCreatedTime = F, returnFullName = F, returnGender = F, returnGrade = F, returnGradYear = F, returnIsStudentAccessUser = F, returnLockerArea = F, returnLockerID = F, returnLockerNumber = F, returnModifiedTime = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentAssignedLockerRecord", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentAssignedLockerRecord
#'
#' This function returns fields for a TempStudentAssignedLockerRecord.
#'
#' @param TempStudentAssignedLockerRecordID The id of the TempStudentAssignedLockerRecord.\cr Run \code{\link{getAllTempStudentAssignedLockerRecords}} for a list of TempStudentAssignedLockerRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentAssignedLockerRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentAssignedLockerRecord <- function(TempStudentAssignedLockerRecordID, EntityID = 1, returnTempStudentAssignedLockerRecordID = F, returnAge = F, returnBirthDate = F, returnBuilding = F, returnCombination = F, returnCreatedTime = F, returnFullName = F, returnGender = F, returnGrade = F, returnGradYear = F, returnIsStudentAccessUser = F, returnLockerArea = F, returnLockerID = F, returnLockerNumber = F, returnModifiedTime = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentAssignedLockerRecord", TempStudentAssignedLockerRecordID, searchFields, EntityID)
}
#' Modify a specific TempStudentAssignedLockerRecord
#'
#' This function modifies fields for a TempStudentAssignedLockerRecord.
#'
#' @param TempStudentAssignedLockerRecordID The id of the TempStudentAssignedLockerRecord to be modified.\cr Run \code{\link{getAllTempStudentAssignedLockerRecords}} for a list of TempStudentAssignedLockerRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentAssignedLockerRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentAssignedLockerRecord <- function(TempStudentAssignedLockerRecordID, EntityID = 1, setAge = NULL, setBirthDate = NULL, setBuilding = NULL, setCombination = NULL, setFullName = NULL, setGender = NULL, setGrade = NULL, setGradYear = NULL, setIsStudentAccessUser = NULL, setLockerArea = NULL, setLockerID = NULL, setLockerNumber = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentAssignedLockerRecord", TempStudentAssignedLockerRecordID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentAssignedLockerRecord.
#'
#' This function creates a new TempStudentAssignedLockerRecord.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentAssignedLockerRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentAssignedLockerRecord <- function(EntityID = 1, setAge = NULL, setBirthDate = NULL, setBuilding = NULL, setCombination = NULL, setFullName = NULL, setGender = NULL, setGrade = NULL, setGradYear = NULL, setIsStudentAccessUser = NULL, setLockerArea = NULL, setLockerID = NULL, setLockerNumber = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentAssignedLockerRecord", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentAssignedLockerRecord
#'
#' This function deletes a TempStudentAssignedLockerRecord.
#'
#' @param TempStudentAssignedLockerRecordID The id of the TempStudentAssignedLockerRecord.\cr Run \code{\link{getAllTempStudentAssignedLockerRecords}} for a list of TempStudentAssignedLockerRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentAssignedLockerRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentAssignedLockerRecord <- function(TempStudentAssignedLockerRecordID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentAssignedLockerRecord", TempStudentAssignedLockerRecordID, EntityID)
}
#' Get all TempStudentErrors.
#'
#' This function returns a dataframe of all TempStudentErrors in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentErrors in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentErrors <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentErrorID = F, returnCreatedTime = F, returnErrorCount = F, returnFullStudentNameLFM = F, returnGender = F, returnGradeLevelCode = F, returnGraduationRequirementYear = F, returnGradYear = F, returnIsCurrentActive = F, returnLockerNumber = F, returnModifiedTime = F, returnNote = F, returnStudentID = F, returnStudentNumber = F, returnStudentTypeCode = F, returnStudentTypeDescription = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentError", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentError
#'
#' This function returns fields for a TempStudentError.
#'
#' @param TempStudentErrorID The id of the TempStudentError.\cr Run \code{\link{getAllTempStudentErrors}} for a list of TempStudentErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentError <- function(TempStudentErrorID, EntityID = 1, returnTempStudentErrorID = F, returnCreatedTime = F, returnErrorCount = F, returnFullStudentNameLFM = F, returnGender = F, returnGradeLevelCode = F, returnGraduationRequirementYear = F, returnGradYear = F, returnIsCurrentActive = F, returnLockerNumber = F, returnModifiedTime = F, returnNote = F, returnStudentID = F, returnStudentNumber = F, returnStudentTypeCode = F, returnStudentTypeDescription = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentError", TempStudentErrorID, searchFields, EntityID)
}
#' Modify a specific TempStudentError
#'
#' This function modifies fields for a TempStudentError.
#'
#' @param TempStudentErrorID The id of the TempStudentError to be modified.\cr Run \code{\link{getAllTempStudentErrors}} for a list of TempStudentErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentError <- function(TempStudentErrorID, EntityID = 1, setErrorCount = NULL, setFullStudentNameLFM = NULL, setGender = NULL, setGradeLevelCode = NULL, setGraduationRequirementYear = NULL, setGradYear = NULL, setIsCurrentActive = NULL, setLockerNumber = NULL, setNote = NULL, setStudentID = NULL, setStudentNumber = NULL, setStudentTypeCode = NULL, setStudentTypeDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentError", TempStudentErrorID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentError.
#'
#' This function creates a new TempStudentError.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentError <- function(EntityID = 1, setErrorCount = NULL, setFullStudentNameLFM = NULL, setGender = NULL, setGradeLevelCode = NULL, setGraduationRequirementYear = NULL, setGradYear = NULL, setIsCurrentActive = NULL, setLockerNumber = NULL, setNote = NULL, setStudentID = NULL, setStudentNumber = NULL, setStudentTypeCode = NULL, setStudentTypeDescription = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentError", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentError
#'
#' This function deletes a TempStudentError.
#'
#' @param TempStudentErrorID The id of the TempStudentError.\cr Run \code{\link{getAllTempStudentErrors}} for a list of TempStudentErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentError <- function(TempStudentErrorID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentError", TempStudentErrorID, EntityID)
}
#' Get all TempStudentErrorMessages.
#'
#' This function returns a dataframe of all TempStudentErrorMessages in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentErrorMessages in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentErrorMessages <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentErrorMessageID = F, returnCreatedTime = F, returnError = F, returnErrorDetail = F, returnModifiedTime = F, returnTempStudentErrorID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentErrorMessage", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentErrorMessage
#'
#' This function returns fields for a TempStudentErrorMessage.
#'
#' @param TempStudentErrorMessageID The id of the TempStudentErrorMessage.\cr Run \code{\link{getAllTempStudentErrorMessages}} for a list of TempStudentErrorMessages.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentErrorMessage.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentErrorMessage <- function(TempStudentErrorMessageID, EntityID = 1, returnTempStudentErrorMessageID = F, returnCreatedTime = F, returnError = F, returnErrorDetail = F, returnModifiedTime = F, returnTempStudentErrorID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentErrorMessage", TempStudentErrorMessageID, searchFields, EntityID)
}
#' Modify a specific TempStudentErrorMessage
#'
#' This function modifies fields for a TempStudentErrorMessage.
#'
#' @param TempStudentErrorMessageID The id of the TempStudentErrorMessage to be modified.\cr Run \code{\link{getAllTempStudentErrorMessages}} for a list of TempStudentErrorMessages.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentErrorMessage.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentErrorMessage <- function(TempStudentErrorMessageID, EntityID = 1, setError = NULL, setErrorDetail = NULL, setTempStudentErrorID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentErrorMessage", TempStudentErrorMessageID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentErrorMessage.
#'
#' This function creates a new TempStudentErrorMessage.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentErrorMessage.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentErrorMessage <- function(EntityID = 1, setError = NULL, setErrorDetail = NULL, setTempStudentErrorID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentErrorMessage", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentErrorMessage
#'
#' This function deletes a TempStudentErrorMessage.
#'
#' @param TempStudentErrorMessageID The id of the TempStudentErrorMessage.\cr Run \code{\link{getAllTempStudentErrorMessages}} for a list of TempStudentErrorMessages.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentErrorMessage.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentErrorMessage <- function(TempStudentErrorMessageID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentErrorMessage", TempStudentErrorMessageID, EntityID)
}
#' Get all TempStudentMassUpdateErrors.
#'
#' This function returns a dataframe of all TempStudentMassUpdateErrors in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentMassUpdateErrors in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentMassUpdateErrors <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentMassUpdateErrorID = F, returnCreatedTime = F, returnFailureReason = F, returnFullNameLFM = F, returnModifiedTime = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentMassUpdateError", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentMassUpdateError
#'
#' This function returns fields for a TempStudentMassUpdateError.
#'
#' @param TempStudentMassUpdateErrorID The id of the TempStudentMassUpdateError.\cr Run \code{\link{getAllTempStudentMassUpdateErrors}} for a list of TempStudentMassUpdateErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentMassUpdateError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentMassUpdateError <- function(TempStudentMassUpdateErrorID, EntityID = 1, returnTempStudentMassUpdateErrorID = F, returnCreatedTime = F, returnFailureReason = F, returnFullNameLFM = F, returnModifiedTime = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentMassUpdateError", TempStudentMassUpdateErrorID, searchFields, EntityID)
}
#' Modify a specific TempStudentMassUpdateError
#'
#' This function modifies fields for a TempStudentMassUpdateError.
#'
#' @param TempStudentMassUpdateErrorID The id of the TempStudentMassUpdateError to be modified.\cr Run \code{\link{getAllTempStudentMassUpdateErrors}} for a list of TempStudentMassUpdateErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentMassUpdateError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentMassUpdateError <- function(TempStudentMassUpdateErrorID, EntityID = 1, setFailureReason = NULL, setFullNameLFM = NULL, setType = NULL, setTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentMassUpdateError", TempStudentMassUpdateErrorID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentMassUpdateError.
#'
#' This function creates a new TempStudentMassUpdateError.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentMassUpdateError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentMassUpdateError <- function(EntityID = 1, setFailureReason = NULL, setFullNameLFM = NULL, setType = NULL, setTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentMassUpdateError", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentMassUpdateError
#'
#' This function deletes a TempStudentMassUpdateError.
#'
#' @param TempStudentMassUpdateErrorID The id of the TempStudentMassUpdateError.\cr Run \code{\link{getAllTempStudentMassUpdateErrors}} for a list of TempStudentMassUpdateErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentMassUpdateError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentMassUpdateError <- function(TempStudentMassUpdateErrorID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentMassUpdateError", TempStudentMassUpdateErrorID, EntityID)
}
#' Get all TempStudentMassUpdateFields.
#'
#' This function returns a dataframe of all TempStudentMassUpdateFields in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentMassUpdateFields in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentMassUpdateFields <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentMassUpdateFieldID = F, returnAffectedPrimaryKey = F, returnCreatedTime = F, returnFieldName = F, returnFriendlyOriginalValue = F, returnFriendlyUpdatedValue = F, returnFullNameLFM = F, returnModifiedTime = F, returnOriginalValue = F, returnRelatedType = F, returnRelatedTypeCode = F, returnStudentID = F, returnUpdatedValue = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentMassUpdateField", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentMassUpdateField
#'
#' This function returns fields for a TempStudentMassUpdateField.
#'
#' @param TempStudentMassUpdateFieldID The id of the TempStudentMassUpdateField.\cr Run \code{\link{getAllTempStudentMassUpdateFields}} for a list of TempStudentMassUpdateFields.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentMassUpdateField.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentMassUpdateField <- function(TempStudentMassUpdateFieldID, EntityID = 1, returnTempStudentMassUpdateFieldID = F, returnAffectedPrimaryKey = F, returnCreatedTime = F, returnFieldName = F, returnFriendlyOriginalValue = F, returnFriendlyUpdatedValue = F, returnFullNameLFM = F, returnModifiedTime = F, returnOriginalValue = F, returnRelatedType = F, returnRelatedTypeCode = F, returnStudentID = F, returnUpdatedValue = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentMassUpdateField", TempStudentMassUpdateFieldID, searchFields, EntityID)
}
#' Modify a specific TempStudentMassUpdateField
#'
#' This function modifies fields for a TempStudentMassUpdateField.
#'
#' @param TempStudentMassUpdateFieldID The id of the TempStudentMassUpdateField to be modified.\cr Run \code{\link{getAllTempStudentMassUpdateFields}} for a list of TempStudentMassUpdateFields.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentMassUpdateField.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentMassUpdateField <- function(TempStudentMassUpdateFieldID, EntityID = 1, setAffectedPrimaryKey = NULL, setFieldName = NULL, setFriendlyOriginalValue = NULL, setFriendlyUpdatedValue = NULL, setFullNameLFM = NULL, setOriginalValue = NULL, setRelatedType = NULL, setRelatedTypeCode = NULL, setStudentID = NULL, setUpdatedValue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentMassUpdateField", TempStudentMassUpdateFieldID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentMassUpdateField.
#'
#' This function creates a new TempStudentMassUpdateField.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentMassUpdateField.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentMassUpdateField <- function(EntityID = 1, setAffectedPrimaryKey = NULL, setFieldName = NULL, setFriendlyOriginalValue = NULL, setFriendlyUpdatedValue = NULL, setFullNameLFM = NULL, setOriginalValue = NULL, setRelatedType = NULL, setRelatedTypeCode = NULL, setStudentID = NULL, setUpdatedValue = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentMassUpdateField", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentMassUpdateField
#'
#' This function deletes a TempStudentMassUpdateField.
#'
#' @param TempStudentMassUpdateFieldID The id of the TempStudentMassUpdateField.\cr Run \code{\link{getAllTempStudentMassUpdateFields}} for a list of TempStudentMassUpdateFields.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentMassUpdateField.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentMassUpdateField <- function(TempStudentMassUpdateFieldID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentMassUpdateField", TempStudentMassUpdateFieldID, EntityID)
}
#' Get all TempStudentMergeObjects.
#'
#' This function returns a dataframe of all TempStudentMergeObjects in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentMergeObjects in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentMergeObjects <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentMergeObjectID = F, returnCreatedTime = F, returnFieldToShow = F, returnHandlingType = F, returnHandlingTypeCode = F, returnModifiedTime = F, returnRecordType = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentMergeObject", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentMergeObject
#'
#' This function returns fields for a TempStudentMergeObject.
#'
#' @param TempStudentMergeObjectID The id of the TempStudentMergeObject.\cr Run \code{\link{getAllTempStudentMergeObjects}} for a list of TempStudentMergeObjects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentMergeObject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentMergeObject <- function(TempStudentMergeObjectID, EntityID = 1, returnTempStudentMergeObjectID = F, returnCreatedTime = F, returnFieldToShow = F, returnHandlingType = F, returnHandlingTypeCode = F, returnModifiedTime = F, returnRecordType = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentMergeObject", TempStudentMergeObjectID, searchFields, EntityID)
}
#' Modify a specific TempStudentMergeObject
#'
#' This function modifies fields for a TempStudentMergeObject.
#'
#' @param TempStudentMergeObjectID The id of the TempStudentMergeObject to be modified.\cr Run \code{\link{getAllTempStudentMergeObjects}} for a list of TempStudentMergeObjects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentMergeObject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentMergeObject <- function(TempStudentMergeObjectID, EntityID = 1, setFieldToShow = NULL, setHandlingType = NULL, setHandlingTypeCode = NULL, setRecordType = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentMergeObject", TempStudentMergeObjectID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentMergeObject.
#'
#' This function creates a new TempStudentMergeObject.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentMergeObject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentMergeObject <- function(EntityID = 1, setFieldToShow = NULL, setHandlingType = NULL, setHandlingTypeCode = NULL, setRecordType = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentMergeObject", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentMergeObject
#'
#' This function deletes a TempStudentMergeObject.
#'
#' @param TempStudentMergeObjectID The id of the TempStudentMergeObject.\cr Run \code{\link{getAllTempStudentMergeObjects}} for a list of TempStudentMergeObjects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentMergeObject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentMergeObject <- function(TempStudentMergeObjectID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentMergeObject", TempStudentMergeObjectID, EntityID)
}
#' Get all TempStudentPermits.
#'
#' This function returns a dataframe of all TempStudentPermits in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentPermits in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentPermits <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentPermitID = F, returnAddressID = F, returnAge = F, returnCreatedTime = F, returnDistrictID = F, returnEntityName = F, returnExceptionNote = F, returnFullNameLFM = F, returnGenderCode = F, returnGradYear = F, returnHasExceptions = F, returnModifiedTime = F, returnPermitID = F, returnSchoolYearID = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentPermit", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentPermit
#'
#' This function returns fields for a TempStudentPermit.
#'
#' @param TempStudentPermitID The id of the TempStudentPermit.\cr Run \code{\link{getAllTempStudentPermits}} for a list of TempStudentPermits.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentPermit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentPermit <- function(TempStudentPermitID, EntityID = 1, returnTempStudentPermitID = F, returnAddressID = F, returnAge = F, returnCreatedTime = F, returnDistrictID = F, returnEntityName = F, returnExceptionNote = F, returnFullNameLFM = F, returnGenderCode = F, returnGradYear = F, returnHasExceptions = F, returnModifiedTime = F, returnPermitID = F, returnSchoolYearID = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentPermit", TempStudentPermitID, searchFields, EntityID)
}
#' Modify a specific TempStudentPermit
#'
#' This function modifies fields for a TempStudentPermit.
#'
#' @param TempStudentPermitID The id of the TempStudentPermit to be modified.\cr Run \code{\link{getAllTempStudentPermits}} for a list of TempStudentPermits.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentPermit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentPermit <- function(TempStudentPermitID, EntityID = 1, setAddressID = NULL, setAge = NULL, setDistrictID = NULL, setEntityName = NULL, setExceptionNote = NULL, setFullNameLFM = NULL, setGenderCode = NULL, setGradYear = NULL, setHasExceptions = NULL, setPermitID = NULL, setSchoolYearID = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentPermit", TempStudentPermitID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentPermit.
#'
#' This function creates a new TempStudentPermit.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentPermit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentPermit <- function(EntityID = 1, setAddressID = NULL, setAge = NULL, setDistrictID = NULL, setEntityName = NULL, setExceptionNote = NULL, setFullNameLFM = NULL, setGenderCode = NULL, setGradYear = NULL, setHasExceptions = NULL, setPermitID = NULL, setSchoolYearID = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentPermit", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentPermit
#'
#' This function deletes a TempStudentPermit.
#'
#' @param TempStudentPermitID The id of the TempStudentPermit.\cr Run \code{\link{getAllTempStudentPermits}} for a list of TempStudentPermits.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentPermit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentPermit <- function(TempStudentPermitID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentPermit", TempStudentPermitID, EntityID)
}
#' Get all TempStudentWithoutLockerRecords.
#'
#' This function returns a dataframe of all TempStudentWithoutLockerRecords in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All TempStudentWithoutLockerRecords in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentWithoutLockerRecords <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentWithoutLockerRecordID = F, returnAge = F, returnCreatedTime = F, returnFullName = F, returnGender = F, returnGradYear = F, returnModifiedTime = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "TempStudentWithoutLockerRecord", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentWithoutLockerRecord
#'
#' This function returns fields for a TempStudentWithoutLockerRecord.
#'
#' @param TempStudentWithoutLockerRecordID The id of the TempStudentWithoutLockerRecord.\cr Run \code{\link{getAllTempStudentWithoutLockerRecords}} for a list of TempStudentWithoutLockerRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the TempStudentWithoutLockerRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentWithoutLockerRecord <- function(TempStudentWithoutLockerRecordID, EntityID = 1, returnTempStudentWithoutLockerRecordID = F, returnAge = F, returnCreatedTime = F, returnFullName = F, returnGender = F, returnGradYear = F, returnModifiedTime = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "TempStudentWithoutLockerRecord", TempStudentWithoutLockerRecordID, searchFields, EntityID)
}
#' Modify a specific TempStudentWithoutLockerRecord
#'
#' This function modifies fields for a TempStudentWithoutLockerRecord.
#'
#' @param TempStudentWithoutLockerRecordID The id of the TempStudentWithoutLockerRecord to be modified.\cr Run \code{\link{getAllTempStudentWithoutLockerRecords}} for a list of TempStudentWithoutLockerRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified TempStudentWithoutLockerRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentWithoutLockerRecord <- function(TempStudentWithoutLockerRecordID, EntityID = 1, setAge = NULL, setFullName = NULL, setGender = NULL, setGradYear = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "TempStudentWithoutLockerRecord", TempStudentWithoutLockerRecordID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentWithoutLockerRecord.
#'
#' This function creates a new TempStudentWithoutLockerRecord.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created TempStudentWithoutLockerRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentWithoutLockerRecord <- function(EntityID = 1, setAge = NULL, setFullName = NULL, setGender = NULL, setGradYear = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "TempStudentWithoutLockerRecord", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentWithoutLockerRecord
#'
#' This function deletes a TempStudentWithoutLockerRecord.
#'
#' @param TempStudentWithoutLockerRecordID The id of the TempStudentWithoutLockerRecord.\cr Run \code{\link{getAllTempStudentWithoutLockerRecords}} for a list of TempStudentWithoutLockerRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted TempStudentWithoutLockerRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentWithoutLockerRecord <- function(TempStudentWithoutLockerRecordID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "TempStudentWithoutLockerRecord", TempStudentWithoutLockerRecordID, EntityID)
}
#' Get all WinterSports.
#'
#' This function returns a dataframe of all WinterSports in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All WinterSports in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllWinterSports <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnWinterSportID = F, returnCode = F, returnCreatedTime = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWinterSport = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "WinterSport", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific WinterSport
#'
#' This function returns fields for a WinterSport.
#'
#' @param WinterSportID The id of the WinterSport.\cr Run \code{\link{getAllWinterSports}} for a list of WinterSports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the WinterSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getWinterSport <- function(WinterSportID, EntityID = 1, returnWinterSportID = F, returnCode = F, returnCreatedTime = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWinterSport = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "WinterSport", WinterSportID, searchFields, EntityID)
}
#' Modify a specific WinterSport
#'
#' This function modifies fields for a WinterSport.
#'
#' @param WinterSportID The id of the WinterSport to be modified.\cr Run \code{\link{getAllWinterSports}} for a list of WinterSports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified WinterSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyWinterSport <- function(WinterSportID, EntityID = 1, setCode = NULL, setWinterSport = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "WinterSport", WinterSportID, names(functionParams), functionParams, EntityID)
}
#' Create new WinterSport.
#'
#' This function creates a new WinterSport.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created WinterSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createWinterSport <- function(EntityID = 1, setCode = NULL, setWinterSport = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "WinterSport", names(functionParams), functionParams, EntityID)
}
#' Delete a specific WinterSport
#'
#' This function deletes a WinterSport.
#'
#' @param WinterSportID The id of the WinterSport.\cr Run \code{\link{getAllWinterSports}} for a list of WinterSports.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted WinterSport.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteWinterSport <- function(WinterSportID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "WinterSport", WinterSportID, EntityID)
}
#' Get all WinterSportsTeams.
#'
#' This function returns a dataframe of all WinterSportsTeams in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param 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 \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param 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.
#' @param return{FieldName} 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.
#' @concept Student
#' @return All WinterSportsTeams in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllWinterSportsTeams <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnWinterSportsTeamID = F, returnCaptain = F, returnCreatedTime = F, returnLettered = F, returnModifiedTime = F, returnSchoolYearID = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWinterSportID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Student", "WinterSportsTeam", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific WinterSportsTeam
#'
#' This function returns fields for a WinterSportsTeam.
#'
#' @param WinterSportsTeamID The id of the WinterSportsTeam.\cr Run \code{\link{getAllWinterSportsTeams}} for a list of WinterSportsTeams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} 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.
#' @concept Student
#' @return Details for the WinterSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getWinterSportsTeam <- function(WinterSportsTeamID, EntityID = 1, returnWinterSportsTeamID = F, returnCaptain = F, returnCreatedTime = F, returnLettered = F, returnModifiedTime = F, returnSchoolYearID = F, returnStudentID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWinterSportID = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Student", "WinterSportsTeam", WinterSportsTeamID, searchFields, EntityID)
}
#' Modify a specific WinterSportsTeam
#'
#' This function modifies fields for a WinterSportsTeam.
#'
#' @param WinterSportsTeamID The id of the WinterSportsTeam to be modified.\cr Run \code{\link{getAllWinterSportsTeams}} for a list of WinterSportsTeams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return Details of the modified WinterSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyWinterSportsTeam <- function(WinterSportsTeamID, EntityID = 1, setCaptain = NULL, setLettered = NULL, setSchoolYearID = NULL, setStudentID = NULL, setWinterSportID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Student", "WinterSportsTeam", WinterSportsTeamID, names(functionParams), functionParams, EntityID)
}
#' Create new WinterSportsTeam.
#'
#' This function creates a new WinterSportsTeam.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Student
#' @return The fields used to define the newly created WinterSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createWinterSportsTeam <- function(EntityID = 1, setCaptain = NULL, setLettered = NULL, setSchoolYearID = NULL, setStudentID = NULL, setWinterSportID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Student", "WinterSportsTeam", names(functionParams), functionParams, EntityID)
}
#' Delete a specific WinterSportsTeam
#'
#' This function deletes a WinterSportsTeam.
#'
#' @param WinterSportsTeamID The id of the WinterSportsTeam.\cr Run \code{\link{getAllWinterSportsTeams}} for a list of WinterSportsTeams.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Student
#' @return The id of the deleted WinterSportsTeam.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteWinterSportsTeam <- function(WinterSportsTeamID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Student", "WinterSportsTeam", WinterSportsTeamID, EntityID)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.