#' Get all AMTransportations.
#'
#' This function returns a dataframe of all AMTransportations 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 Enrollment
#' @return All AMTransportations in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAMTransportations <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAMTransportationID = 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("Enrollment", "AMTransportation", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AMTransportation
#'
#' This function returns fields for an AMTransportation.
#'
#' @param AMTransportationID The id of the AMTransportation.\cr Run \code{\link{getAllAMTransportations}} for a list of AMTransportations.
#' @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 Enrollment
#' @return Details for the AMTransportation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAMTransportation <- function(AMTransportationID, EntityID = 1, returnAMTransportationID = 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("Enrollment", "AMTransportation", AMTransportationID, searchFields, EntityID)
}
#' Modify a specific AMTransportation
#'
#' This function modifies fields for an AMTransportation.
#'
#' @param AMTransportationID The id of the AMTransportation to be modified.\cr Run \code{\link{getAllAMTransportations}} for a list of AMTransportations.
#' @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 Enrollment
#' @return Details of the modified AMTransportation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAMTransportation <- function(AMTransportationID, 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("Enrollment", "AMTransportation", AMTransportationID, names(functionParams), functionParams, EntityID)
}
#' Create new AMTransportation.
#'
#' This function creates a new AMTransportation.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created AMTransportation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAMTransportation <- 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("Enrollment", "AMTransportation", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AMTransportation
#'
#' This function deletes an AMTransportation.
#'
#' @param AMTransportationID The id of the AMTransportation.\cr Run \code{\link{getAllAMTransportations}} for a list of AMTransportations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted AMTransportation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAMTransportation <- function(AMTransportationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "AMTransportation", AMTransportationID, EntityID)
}
#' Get all CommonEducationDataStandardsGradeLevels.
#'
#' This function returns a dataframe of all CommonEducationDataStandardsGradeLevels 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 Enrollment
#' @return All CommonEducationDataStandardsGradeLevels in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCommonEducationDataStandardsGradeLevels <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCommonEducationDataStandardsGradeLevelID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnOrderNumber = 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("Enrollment", "CommonEducationDataStandardsGradeLevel", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CommonEducationDataStandardsGradeLevel
#'
#' This function returns fields for a CommonEducationDataStandardsGradeLevel.
#'
#' @param CommonEducationDataStandardsGradeLevelID The id of the CommonEducationDataStandardsGradeLevel.\cr Run \code{\link{getAllCommonEducationDataStandardsGradeLevels}} for a list of CommonEducationDataStandardsGradeLevels.
#' @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 Enrollment
#' @return Details for the CommonEducationDataStandardsGradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCommonEducationDataStandardsGradeLevel <- function(CommonEducationDataStandardsGradeLevelID, EntityID = 1, returnCommonEducationDataStandardsGradeLevelID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnModifiedTime = F, returnOrderNumber = 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("Enrollment", "CommonEducationDataStandardsGradeLevel", CommonEducationDataStandardsGradeLevelID, searchFields, EntityID)
}
#' Modify a specific CommonEducationDataStandardsGradeLevel
#'
#' This function modifies fields for a CommonEducationDataStandardsGradeLevel.
#'
#' @param CommonEducationDataStandardsGradeLevelID The id of the CommonEducationDataStandardsGradeLevel to be modified.\cr Run \code{\link{getAllCommonEducationDataStandardsGradeLevels}} for a list of CommonEducationDataStandardsGradeLevels.
#' @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 Enrollment
#' @return Details of the modified CommonEducationDataStandardsGradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCommonEducationDataStandardsGradeLevel <- function(CommonEducationDataStandardsGradeLevelID, EntityID = 1, setCode = NULL, setDescription = NULL, setOrderNumber = 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("Enrollment", "CommonEducationDataStandardsGradeLevel", CommonEducationDataStandardsGradeLevelID, names(functionParams), functionParams, EntityID)
}
#' Create new CommonEducationDataStandardsGradeLevel.
#'
#' This function creates a new CommonEducationDataStandardsGradeLevel.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created CommonEducationDataStandardsGradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCommonEducationDataStandardsGradeLevel <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setOrderNumber = 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("Enrollment", "CommonEducationDataStandardsGradeLevel", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CommonEducationDataStandardsGradeLevel
#'
#' This function deletes a CommonEducationDataStandardsGradeLevel.
#'
#' @param CommonEducationDataStandardsGradeLevelID The id of the CommonEducationDataStandardsGradeLevel.\cr Run \code{\link{getAllCommonEducationDataStandardsGradeLevels}} for a list of CommonEducationDataStandardsGradeLevels.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted CommonEducationDataStandardsGradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCommonEducationDataStandardsGradeLevel <- function(CommonEducationDataStandardsGradeLevelID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "CommonEducationDataStandardsGradeLevel", CommonEducationDataStandardsGradeLevelID, 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 Enrollment
#' @return All ConfigDistricts in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigDistrictsEnrollment <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigDistrictID = F, returnAllowDualEnrollment = F, returnCreatedTime = F, returnDistrictID = F, returnEntryDaysBeforeCalendarStart = F, returnModifiedTime = F, returnNumberDaysBackdateEntry = F, returnNumberDaysBackdateWithdrawal = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalDaysAfterCalendarEnd = 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("Enrollment", "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 Enrollment
#' @return Details for the ConfigDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigDistrictEnrollment <- function(ConfigDistrictID, EntityID = 1, returnConfigDistrictID = F, returnAllowDualEnrollment = F, returnCreatedTime = F, returnDistrictID = F, returnEntryDaysBeforeCalendarStart = F, returnModifiedTime = F, returnNumberDaysBackdateEntry = F, returnNumberDaysBackdateWithdrawal = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalDaysAfterCalendarEnd = 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("Enrollment", "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 Enrollment
#' @return Details of the modified ConfigDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigDistrictEnrollment <- function(ConfigDistrictID, EntityID = 1, setAllowDualEnrollment = NULL, setDistrictID = NULL, setEntryDaysBeforeCalendarStart = NULL, setNumberDaysBackdateEntry = NULL, setNumberDaysBackdateWithdrawal = NULL, setWithdrawalDaysAfterCalendarEnd = 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("Enrollment", "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 Enrollment
#' @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
createConfigDistrictEnrollment <- function(EntityID = 1, setAllowDualEnrollment = NULL, setDistrictID = NULL, setEntryDaysBeforeCalendarStart = NULL, setNumberDaysBackdateEntry = NULL, setNumberDaysBackdateWithdrawal = NULL, setWithdrawalDaysAfterCalendarEnd = 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("Enrollment", "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 Enrollment
#' @return The id of the deleted ConfigDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigDistrictEnrollment <- function(ConfigDistrictID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "ConfigDistrict", ConfigDistrictID, EntityID)
}
#' Get all ConfigDistrictYears.
#'
#' This function returns a dataframe of all ConfigDistrictYears 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 Enrollment
#' @return All ConfigDistrictYears in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigDistrictYearsEnrollment <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigDistrictYearID = F, returnAutoAddSchoolPathOverride = F, returnConfigDistrictYearIDClonedFrom = F, returnCreatedTime = F, returnDistrictID = F, returnEnableNoShow = F, returnEnrolledDifferentEntityNoShowActionType = F, returnEnrolledDifferentEntityNoShowActionTypeCode = F, returnEnrolledDifferentEntityNoShowEntryDate = F, returnEnrolledDifferentEntityNoShowWithdrawalDate = F, returnModifiedTime = F, returnNoDistrictEnrollmentNoShowActionType = F, returnNoDistrictEnrollmentNoShowActionTypeCode = F, returnNoDistrictEnrollmentNoShowEntryDate = F, returnNoDistrictEnrollmentNoShowWithdrawalDate = F, returnPermitIDAutoAdd = F, returnPreviouslyEnrolledSameEntityNoShowActionType = F, returnPreviouslyEnrolledSameEntityNoShowActionTypeCode = F, returnPreviouslyEnrolledSameEntityNoShowEntryDate = F, returnPreviouslyEnrolledSameEntityNoShowWithdrawalDate = F, returnPriorNoShowRecord = F, returnPriorNoShowRecordCode = 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("Enrollment", "ConfigDistrictYear", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ConfigDistrictYear
#'
#' This function returns fields for a ConfigDistrictYear.
#'
#' @param ConfigDistrictYearID The id of the ConfigDistrictYear.\cr Run \code{\link{getAllConfigDistrictYears}} for a list of ConfigDistrictYears.
#' @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 Enrollment
#' @return Details for the ConfigDistrictYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigDistrictYearEnrollment <- function(ConfigDistrictYearID, EntityID = 1, returnConfigDistrictYearID = F, returnAutoAddSchoolPathOverride = F, returnConfigDistrictYearIDClonedFrom = F, returnCreatedTime = F, returnDistrictID = F, returnEnableNoShow = F, returnEnrolledDifferentEntityNoShowActionType = F, returnEnrolledDifferentEntityNoShowActionTypeCode = F, returnEnrolledDifferentEntityNoShowEntryDate = F, returnEnrolledDifferentEntityNoShowWithdrawalDate = F, returnModifiedTime = F, returnNoDistrictEnrollmentNoShowActionType = F, returnNoDistrictEnrollmentNoShowActionTypeCode = F, returnNoDistrictEnrollmentNoShowEntryDate = F, returnNoDistrictEnrollmentNoShowWithdrawalDate = F, returnPermitIDAutoAdd = F, returnPreviouslyEnrolledSameEntityNoShowActionType = F, returnPreviouslyEnrolledSameEntityNoShowActionTypeCode = F, returnPreviouslyEnrolledSameEntityNoShowEntryDate = F, returnPreviouslyEnrolledSameEntityNoShowWithdrawalDate = F, returnPriorNoShowRecord = F, returnPriorNoShowRecordCode = 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("Enrollment", "ConfigDistrictYear", ConfigDistrictYearID, searchFields, EntityID)
}
#' Modify a specific ConfigDistrictYear
#'
#' This function modifies fields for a ConfigDistrictYear.
#'
#' @param ConfigDistrictYearID The id of the ConfigDistrictYear to be modified.\cr Run \code{\link{getAllConfigDistrictYears}} for a list of ConfigDistrictYears.
#' @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 Enrollment
#' @return Details of the modified ConfigDistrictYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigDistrictYearEnrollment <- function(ConfigDistrictYearID, EntityID = 1, setAutoAddSchoolPathOverride = NULL, setConfigDistrictYearIDClonedFrom = NULL, setDistrictID = NULL, setEnableNoShow = NULL, setEnrolledDifferentEntityNoShowActionType = NULL, setEnrolledDifferentEntityNoShowActionTypeCode = NULL, setEnrolledDifferentEntityNoShowEntryDate = NULL, setEnrolledDifferentEntityNoShowWithdrawalDate = NULL, setNoDistrictEnrollmentNoShowActionType = NULL, setNoDistrictEnrollmentNoShowActionTypeCode = NULL, setNoDistrictEnrollmentNoShowEntryDate = NULL, setNoDistrictEnrollmentNoShowWithdrawalDate = NULL, setPermitIDAutoAdd = NULL, setPreviouslyEnrolledSameEntityNoShowActionType = NULL, setPreviouslyEnrolledSameEntityNoShowActionTypeCode = NULL, setPreviouslyEnrolledSameEntityNoShowEntryDate = NULL, setPreviouslyEnrolledSameEntityNoShowWithdrawalDate = NULL, setPriorNoShowRecord = NULL, setPriorNoShowRecordCode = 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("Enrollment", "ConfigDistrictYear", ConfigDistrictYearID, names(functionParams), functionParams, EntityID)
}
#' Create new ConfigDistrictYear.
#'
#' This function creates a new ConfigDistrictYear.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created ConfigDistrictYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createConfigDistrictYearEnrollment <- function(EntityID = 1, setAutoAddSchoolPathOverride = NULL, setConfigDistrictYearIDClonedFrom = NULL, setDistrictID = NULL, setEnableNoShow = NULL, setEnrolledDifferentEntityNoShowActionType = NULL, setEnrolledDifferentEntityNoShowActionTypeCode = NULL, setEnrolledDifferentEntityNoShowEntryDate = NULL, setEnrolledDifferentEntityNoShowWithdrawalDate = NULL, setNoDistrictEnrollmentNoShowActionType = NULL, setNoDistrictEnrollmentNoShowActionTypeCode = NULL, setNoDistrictEnrollmentNoShowEntryDate = NULL, setNoDistrictEnrollmentNoShowWithdrawalDate = NULL, setPermitIDAutoAdd = NULL, setPreviouslyEnrolledSameEntityNoShowActionType = NULL, setPreviouslyEnrolledSameEntityNoShowActionTypeCode = NULL, setPreviouslyEnrolledSameEntityNoShowEntryDate = NULL, setPreviouslyEnrolledSameEntityNoShowWithdrawalDate = NULL, setPriorNoShowRecord = NULL, setPriorNoShowRecordCode = 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("Enrollment", "ConfigDistrictYear", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ConfigDistrictYear
#'
#' This function deletes a ConfigDistrictYear.
#'
#' @param ConfigDistrictYearID The id of the ConfigDistrictYear.\cr Run \code{\link{getAllConfigDistrictYears}} for a list of ConfigDistrictYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted ConfigDistrictYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigDistrictYearEnrollment <- function(ConfigDistrictYearID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "ConfigDistrictYear", ConfigDistrictYearID, EntityID)
}
#' Get all ConfigDistrictYearWithdrawalCodes.
#'
#' This function returns a dataframe of all ConfigDistrictYearWithdrawalCodes 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 Enrollment
#' @return All ConfigDistrictYearWithdrawalCodes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigDistrictYearWithdrawalCodes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigDistrictYearWithdrawalCodeID = F, returnConfigDistrictYearID = F, returnConfigDistrictYearWithdrawalCodeIDClonedFrom = F, returnCreatedTime = F, returnModifiedTime = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalCodeID = 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("Enrollment", "ConfigDistrictYearWithdrawalCode", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ConfigDistrictYearWithdrawalCode
#'
#' This function returns fields for a ConfigDistrictYearWithdrawalCode.
#'
#' @param ConfigDistrictYearWithdrawalCodeID The id of the ConfigDistrictYearWithdrawalCode.\cr Run \code{\link{getAllConfigDistrictYearWithdrawalCodes}} for a list of ConfigDistrictYearWithdrawalCodes.
#' @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 Enrollment
#' @return Details for the ConfigDistrictYearWithdrawalCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigDistrictYearWithdrawalCode <- function(ConfigDistrictYearWithdrawalCodeID, EntityID = 1, returnConfigDistrictYearWithdrawalCodeID = F, returnConfigDistrictYearID = F, returnConfigDistrictYearWithdrawalCodeIDClonedFrom = F, returnCreatedTime = F, returnModifiedTime = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalCodeID = 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("Enrollment", "ConfigDistrictYearWithdrawalCode", ConfigDistrictYearWithdrawalCodeID, searchFields, EntityID)
}
#' Modify a specific ConfigDistrictYearWithdrawalCode
#'
#' This function modifies fields for a ConfigDistrictYearWithdrawalCode.
#'
#' @param ConfigDistrictYearWithdrawalCodeID The id of the ConfigDistrictYearWithdrawalCode to be modified.\cr Run \code{\link{getAllConfigDistrictYearWithdrawalCodes}} for a list of ConfigDistrictYearWithdrawalCodes.
#' @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 Enrollment
#' @return Details of the modified ConfigDistrictYearWithdrawalCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigDistrictYearWithdrawalCode <- function(ConfigDistrictYearWithdrawalCodeID, EntityID = 1, setConfigDistrictYearID = NULL, setConfigDistrictYearWithdrawalCodeIDClonedFrom = NULL, setType = NULL, setTypeCode = NULL, setWithdrawalCodeID = 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("Enrollment", "ConfigDistrictYearWithdrawalCode", ConfigDistrictYearWithdrawalCodeID, names(functionParams), functionParams, EntityID)
}
#' Create new ConfigDistrictYearWithdrawalCode.
#'
#' This function creates a new ConfigDistrictYearWithdrawalCode.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created ConfigDistrictYearWithdrawalCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createConfigDistrictYearWithdrawalCode <- function(EntityID = 1, setConfigDistrictYearID = NULL, setConfigDistrictYearWithdrawalCodeIDClonedFrom = NULL, setType = NULL, setTypeCode = NULL, setWithdrawalCodeID = 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("Enrollment", "ConfigDistrictYearWithdrawalCode", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ConfigDistrictYearWithdrawalCode
#'
#' This function deletes a ConfigDistrictYearWithdrawalCode.
#'
#' @param ConfigDistrictYearWithdrawalCodeID The id of the ConfigDistrictYearWithdrawalCode.\cr Run \code{\link{getAllConfigDistrictYearWithdrawalCodes}} for a list of ConfigDistrictYearWithdrawalCodes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted ConfigDistrictYearWithdrawalCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigDistrictYearWithdrawalCode <- function(ConfigDistrictYearWithdrawalCodeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "ConfigDistrictYearWithdrawalCode", ConfigDistrictYearWithdrawalCodeID, EntityID)
}
#' Get all EntitySchools.
#'
#' This function returns a dataframe of all EntitySchools 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 Enrollment
#' @return All EntitySchools in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllEntitySchools <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnEntitySchoolID = F, returnCreatedTime = F, returnEntityID = F, returnEntitySchoolIDClonedFrom = F, returnEntitySchoolIDClonedTo = F, returnIsDefaultEntityForSchool = F, returnIsDefaultSchoolForEntity = F, returnIsOnlySchoolInEntity = F, returnModifiedTime = F, returnSchoolID = 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("Enrollment", "EntitySchool", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific EntitySchool
#'
#' This function returns fields for an EntitySchool.
#'
#' @param EntitySchoolID The id of the EntitySchool.\cr Run \code{\link{getAllEntitySchools}} for a list of EntitySchools.
#' @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 Enrollment
#' @return Details for the EntitySchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getEntitySchool <- function(EntitySchoolID, EntityID = 1, returnEntitySchoolID = F, returnCreatedTime = F, returnEntityID = F, returnEntitySchoolIDClonedFrom = F, returnEntitySchoolIDClonedTo = F, returnIsDefaultEntityForSchool = F, returnIsDefaultSchoolForEntity = F, returnIsOnlySchoolInEntity = F, returnModifiedTime = F, returnSchoolID = 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("Enrollment", "EntitySchool", EntitySchoolID, searchFields, EntityID)
}
#' Modify a specific EntitySchool
#'
#' This function modifies fields for an EntitySchool.
#'
#' @param EntitySchoolID The id of the EntitySchool to be modified.\cr Run \code{\link{getAllEntitySchools}} for a list of EntitySchools.
#' @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 Enrollment
#' @return Details of the modified EntitySchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyEntitySchool <- function(EntitySchoolID, EntityID = 1, setEntityID = NULL, setEntitySchoolIDClonedFrom = NULL, setIsDefaultEntityForSchool = NULL, setIsDefaultSchoolForEntity = NULL, setSchoolID = 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("Enrollment", "EntitySchool", EntitySchoolID, names(functionParams), functionParams, EntityID)
}
#' Create new EntitySchool.
#'
#' This function creates a new EntitySchool.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created EntitySchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createEntitySchool <- function(EntityID = 1, setEntityID = NULL, setEntitySchoolIDClonedFrom = NULL, setIsDefaultEntityForSchool = NULL, setIsDefaultSchoolForEntity = NULL, setSchoolID = 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("Enrollment", "EntitySchool", names(functionParams), functionParams, EntityID)
}
#' Delete a specific EntitySchool
#'
#' This function deletes an EntitySchool.
#'
#' @param EntitySchoolID The id of the EntitySchool.\cr Run \code{\link{getAllEntitySchools}} for a list of EntitySchools.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted EntitySchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteEntitySchool <- function(EntitySchoolID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "EntitySchool", EntitySchoolID, EntityID)
}
#' Get all EntitySchoolBuildings.
#'
#' This function returns a dataframe of all EntitySchoolBuildings 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 Enrollment
#' @return All EntitySchoolBuildings in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllEntitySchoolBuildings <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnEntitySchoolBuildingID = F, returnBuildingID = F, returnCreatedTime = F, returnEntitySchoolBuildingIDClonedFrom = F, returnEntitySchoolID = F, returnIsPrimary = F, returnModifiedTime = 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("Enrollment", "EntitySchoolBuilding", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific EntitySchoolBuilding
#'
#' This function returns fields for an EntitySchoolBuilding.
#'
#' @param EntitySchoolBuildingID The id of the EntitySchoolBuilding.\cr Run \code{\link{getAllEntitySchoolBuildings}} for a list of EntitySchoolBuildings.
#' @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 Enrollment
#' @return Details for the EntitySchoolBuilding.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getEntitySchoolBuilding <- function(EntitySchoolBuildingID, EntityID = 1, returnEntitySchoolBuildingID = F, returnBuildingID = F, returnCreatedTime = F, returnEntitySchoolBuildingIDClonedFrom = F, returnEntitySchoolID = F, returnIsPrimary = F, returnModifiedTime = 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("Enrollment", "EntitySchoolBuilding", EntitySchoolBuildingID, searchFields, EntityID)
}
#' Modify a specific EntitySchoolBuilding
#'
#' This function modifies fields for an EntitySchoolBuilding.
#'
#' @param EntitySchoolBuildingID The id of the EntitySchoolBuilding to be modified.\cr Run \code{\link{getAllEntitySchoolBuildings}} for a list of EntitySchoolBuildings.
#' @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 Enrollment
#' @return Details of the modified EntitySchoolBuilding.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyEntitySchoolBuilding <- function(EntitySchoolBuildingID, EntityID = 1, setBuildingID = NULL, setEntitySchoolBuildingIDClonedFrom = NULL, setEntitySchoolID = NULL, setIsPrimary = 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("Enrollment", "EntitySchoolBuilding", EntitySchoolBuildingID, names(functionParams), functionParams, EntityID)
}
#' Create new EntitySchoolBuilding.
#'
#' This function creates a new EntitySchoolBuilding.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created EntitySchoolBuilding.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createEntitySchoolBuilding <- function(EntityID = 1, setBuildingID = NULL, setEntitySchoolBuildingIDClonedFrom = NULL, setEntitySchoolID = NULL, setIsPrimary = 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("Enrollment", "EntitySchoolBuilding", names(functionParams), functionParams, EntityID)
}
#' Delete a specific EntitySchoolBuilding
#'
#' This function deletes an EntitySchoolBuilding.
#'
#' @param EntitySchoolBuildingID The id of the EntitySchoolBuilding.\cr Run \code{\link{getAllEntitySchoolBuildings}} for a list of EntitySchoolBuildings.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted EntitySchoolBuilding.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteEntitySchoolBuilding <- function(EntitySchoolBuildingID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "EntitySchoolBuilding", EntitySchoolBuildingID, EntityID)
}
#' Get all EntryCodes.
#'
#' This function returns a dataframe of all EntryCodes 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 Enrollment
#' @return All EntryCodes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllEntryCodes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnEntryCodeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnEntryCodeIDClonedFrom = F, returnIsCrossEntityCourseEnrollment = F, returnModifiedTime = F, returnSchoolYearID = 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("Enrollment", "EntryCode", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific EntryCode
#'
#' This function returns fields for an EntryCode.
#'
#' @param EntryCodeID The id of the EntryCode.\cr Run \code{\link{getAllEntryCodes}} for a list of EntryCodes.
#' @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 Enrollment
#' @return Details for the EntryCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getEntryCode <- function(EntryCodeID, EntityID = 1, returnEntryCodeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnEntryCodeIDClonedFrom = F, returnIsCrossEntityCourseEnrollment = F, returnModifiedTime = F, returnSchoolYearID = 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("Enrollment", "EntryCode", EntryCodeID, searchFields, EntityID)
}
#' Modify a specific EntryCode
#'
#' This function modifies fields for an EntryCode.
#'
#' @param EntryCodeID The id of the EntryCode to be modified.\cr Run \code{\link{getAllEntryCodes}} for a list of EntryCodes.
#' @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 Enrollment
#' @return Details of the modified EntryCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyEntryCode <- function(EntryCodeID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setEntryCodeIDClonedFrom = NULL, setIsCrossEntityCourseEnrollment = NULL, setSchoolYearID = 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("Enrollment", "EntryCode", EntryCodeID, names(functionParams), functionParams, EntityID)
}
#' Create new EntryCode.
#'
#' This function creates a new EntryCode.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created EntryCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createEntryCode <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setEntryCodeIDClonedFrom = NULL, setIsCrossEntityCourseEnrollment = NULL, setSchoolYearID = 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("Enrollment", "EntryCode", names(functionParams), functionParams, EntityID)
}
#' Delete a specific EntryCode
#'
#' This function deletes an EntryCode.
#'
#' @param EntryCodeID The id of the EntryCode.\cr Run \code{\link{getAllEntryCodes}} for a list of EntryCodes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted EntryCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteEntryCode <- function(EntryCodeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "EntryCode", EntryCodeID, EntityID)
}
#' Get all EntryWithdrawals.
#'
#' This function returns a dataframe of all EntryWithdrawals 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 Enrollment
#' @return All EntryWithdrawals in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllEntryWithdrawals <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnEntryWithdrawalID = F, returnAttendanceDays = F, returnCalendarID = F, returnCreatedTime = F, returnEndDate = F, returnEnrolledAtLeastOneDay = F, returnEntityID = F, returnEntryCodeID = F, returnEntryComment = F, returnEntryWithdrawalIDStatusChangePrevious = F, returnEntryWithdrawalMNID = F, returnGradeReferenceID = F, returnHasMessageCenterAllowedWithdrawalCodeOverride = F, returnIsCombinedEnrollmentFullTime = F, returnIsCrossEntityCourseEnrollment = F, returnIsCurrentOrFutureEnrollment = F, returnIsDefaultEntity = F, returnIsHistoricalEnrollment = F, returnIsIndependentStudy = F, returnIsNoShow = F, returnIsPostSecondaryOption = F, returnIsPSEOConcurrentEnrollment = F, returnIsStartDateOnOrAfterFirstDayOfSchool = F, returnMembershipDays = F, returnModifiedTime = F, returnPercentEnrolled = F, returnPromotionStatus = F, returnPromotionStatusCode = F, returnPSEOHours = F, returnRenderDeleteOption = F, returnRenderNoShowOption = F, returnRenderPrintWithdrawalFormOption = F, returnRenderUndoStatusChangeOption = F, returnRenderWithdrawalAndStatusChangeOptions = F, returnSchoolID = F, returnSchoolYearID = F, returnSpecialEdServiceHours = F, returnStartDate = F, returnStateAidCategoryCodeMNID = F, returnStateDistrictMNID = F, returnStateLastAttendanceLocationCodeMNID = F, returnStatusChangeEntry = F, returnStatusChangeWithdrawal = F, returnStudentID = F, returnStudentTypeID = F, returnTotalMembershipDays = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalCodeID = F, returnWithdrawalComment = F, returnWithdrawalDate = 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("Enrollment", "EntryWithdrawal", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific EntryWithdrawal
#'
#' This function returns fields for an EntryWithdrawal.
#'
#' @param EntryWithdrawalID The id of the EntryWithdrawal.\cr Run \code{\link{getAllEntryWithdrawals}} for a list of EntryWithdrawals.
#' @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 Enrollment
#' @return Details for the EntryWithdrawal.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getEntryWithdrawal <- function(EntryWithdrawalID, EntityID = 1, returnEntryWithdrawalID = F, returnAttendanceDays = F, returnCalendarID = F, returnCreatedTime = F, returnEndDate = F, returnEnrolledAtLeastOneDay = F, returnEntityID = F, returnEntryCodeID = F, returnEntryComment = F, returnEntryWithdrawalIDStatusChangePrevious = F, returnEntryWithdrawalMNID = F, returnGradeReferenceID = F, returnHasMessageCenterAllowedWithdrawalCodeOverride = F, returnIsCombinedEnrollmentFullTime = F, returnIsCrossEntityCourseEnrollment = F, returnIsCurrentOrFutureEnrollment = F, returnIsDefaultEntity = F, returnIsHistoricalEnrollment = F, returnIsIndependentStudy = F, returnIsNoShow = F, returnIsPostSecondaryOption = F, returnIsPSEOConcurrentEnrollment = F, returnIsStartDateOnOrAfterFirstDayOfSchool = F, returnMembershipDays = F, returnModifiedTime = F, returnPercentEnrolled = F, returnPromotionStatus = F, returnPromotionStatusCode = F, returnPSEOHours = F, returnRenderDeleteOption = F, returnRenderNoShowOption = F, returnRenderPrintWithdrawalFormOption = F, returnRenderUndoStatusChangeOption = F, returnRenderWithdrawalAndStatusChangeOptions = F, returnSchoolID = F, returnSchoolYearID = F, returnSpecialEdServiceHours = F, returnStartDate = F, returnStateAidCategoryCodeMNID = F, returnStateDistrictMNID = F, returnStateLastAttendanceLocationCodeMNID = F, returnStatusChangeEntry = F, returnStatusChangeWithdrawal = F, returnStudentID = F, returnStudentTypeID = F, returnTotalMembershipDays = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalCodeID = F, returnWithdrawalComment = F, returnWithdrawalDate = 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("Enrollment", "EntryWithdrawal", EntryWithdrawalID, searchFields, EntityID)
}
#' Modify a specific EntryWithdrawal
#'
#' This function modifies fields for an EntryWithdrawal.
#'
#' @param EntryWithdrawalID The id of the EntryWithdrawal to be modified.\cr Run \code{\link{getAllEntryWithdrawals}} for a list of EntryWithdrawals.
#' @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 Enrollment
#' @return Details of the modified EntryWithdrawal.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyEntryWithdrawal <- function(EntryWithdrawalID, EntityID = 1, setAttendanceDays = NULL, setCalendarID = NULL, setEndDate = NULL, setEntityID = NULL, setEntryCodeID = NULL, setEntryComment = NULL, setEntryWithdrawalIDStatusChangePrevious = NULL, setGradeReferenceID = NULL, setIsDefaultEntity = NULL, setIsIndependentStudy = NULL, setIsNoShow = NULL, setIsPostSecondaryOption = NULL, setIsPSEOConcurrentEnrollment = NULL, setMembershipDays = NULL, setPercentEnrolled = NULL, setPromotionStatus = NULL, setPromotionStatusCode = NULL, setPSEOHours = NULL, setSchoolID = NULL, setSchoolYearID = NULL, setSpecialEdServiceHours = NULL, setStartDate = NULL, setStateAidCategoryCodeMNID = NULL, setStateDistrictMNID = NULL, setStateLastAttendanceLocationCodeMNID = NULL, setStudentID = NULL, setStudentTypeID = NULL, setWithdrawalCodeID = NULL, setWithdrawalComment = 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("Enrollment", "EntryWithdrawal", EntryWithdrawalID, names(functionParams), functionParams, EntityID)
}
#' Create new EntryWithdrawal.
#'
#' This function creates a new EntryWithdrawal.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created EntryWithdrawal.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createEntryWithdrawal <- function(EntityID = 1, setAttendanceDays = NULL, setCalendarID = NULL, setEndDate = NULL, setEntityID = NULL, setEntryCodeID = NULL, setEntryComment = NULL, setEntryWithdrawalIDStatusChangePrevious = NULL, setGradeReferenceID = NULL, setIsDefaultEntity = NULL, setIsIndependentStudy = NULL, setIsNoShow = NULL, setIsPostSecondaryOption = NULL, setIsPSEOConcurrentEnrollment = NULL, setMembershipDays = NULL, setPercentEnrolled = NULL, setPromotionStatus = NULL, setPromotionStatusCode = NULL, setPSEOHours = NULL, setSchoolID = NULL, setSchoolYearID = NULL, setSpecialEdServiceHours = NULL, setStartDate = NULL, setStateAidCategoryCodeMNID = NULL, setStateDistrictMNID = NULL, setStateLastAttendanceLocationCodeMNID = NULL, setStudentID = NULL, setStudentTypeID = NULL, setWithdrawalCodeID = NULL, setWithdrawalComment = 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("Enrollment", "EntryWithdrawal", names(functionParams), functionParams, EntityID)
}
#' Delete a specific EntryWithdrawal
#'
#' This function deletes an EntryWithdrawal.
#'
#' @param EntryWithdrawalID The id of the EntryWithdrawal.\cr Run \code{\link{getAllEntryWithdrawals}} for a list of EntryWithdrawals.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted EntryWithdrawal.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteEntryWithdrawal <- function(EntryWithdrawalID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "EntryWithdrawal", EntryWithdrawalID, EntityID)
}
#' Get all GradeLevels.
#'
#' This function returns a dataframe of all GradeLevels 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 Enrollment
#' @return All GradeLevels in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllGradeLevels <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnGradeLevelID = F, returnCode = F, returnCodeDescription = F, returnCommonEducationDataStandardsGradeLevelID = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnFederalGradeLevel = F, returnFederalGradeLevelCode = F, returnIlluminate = F, returnIlluminateCalculated = F, returnIlluminateOverride = F, returnModifiedTime = F, returnNumericValue = F, returnStateGradeLevel = 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("Enrollment", "GradeLevel", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific GradeLevel
#'
#' This function returns fields for a GradeLevel.
#'
#' @param GradeLevelID The id of the GradeLevel.\cr Run \code{\link{getAllGradeLevels}} for a list of GradeLevels.
#' @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 Enrollment
#' @return Details for the GradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getGradeLevel <- function(GradeLevelID, EntityID = 1, returnGradeLevelID = F, returnCode = F, returnCodeDescription = F, returnCommonEducationDataStandardsGradeLevelID = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnFederalGradeLevel = F, returnFederalGradeLevelCode = F, returnIlluminate = F, returnIlluminateCalculated = F, returnIlluminateOverride = F, returnModifiedTime = F, returnNumericValue = F, returnStateGradeLevel = 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("Enrollment", "GradeLevel", GradeLevelID, searchFields, EntityID)
}
#' Modify a specific GradeLevel
#'
#' This function modifies fields for a GradeLevel.
#'
#' @param GradeLevelID The id of the GradeLevel to be modified.\cr Run \code{\link{getAllGradeLevels}} for a list of GradeLevels.
#' @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 Enrollment
#' @return Details of the modified GradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyGradeLevel <- function(GradeLevelID, EntityID = 1, setCode = NULL, setCommonEducationDataStandardsGradeLevelID = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setFederalGradeLevel = NULL, setFederalGradeLevelCode = NULL, setIlluminateOverride = NULL, setNumericValue = 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("Enrollment", "GradeLevel", GradeLevelID, names(functionParams), functionParams, EntityID)
}
#' Create new GradeLevel.
#'
#' This function creates a new GradeLevel.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created GradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createGradeLevel <- function(EntityID = 1, setCode = NULL, setCommonEducationDataStandardsGradeLevelID = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setFederalGradeLevel = NULL, setFederalGradeLevelCode = NULL, setIlluminateOverride = NULL, setNumericValue = 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("Enrollment", "GradeLevel", names(functionParams), functionParams, EntityID)
}
#' Delete a specific GradeLevel
#'
#' This function deletes a GradeLevel.
#'
#' @param GradeLevelID The id of the GradeLevel.\cr Run \code{\link{getAllGradeLevels}} for a list of GradeLevels.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted GradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteGradeLevel <- function(GradeLevelID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "GradeLevel", GradeLevelID, EntityID)
}
#' Get all GradeReferences.
#'
#' This function returns a dataframe of all GradeReferences 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 Enrollment
#' @return All GradeReferences in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllGradeReferences <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnGradeReferenceID = F, returnCreatedTime = F, returnDistrictGroupKey = F, returnGradeLevelID = F, returnGradeReferenceIDClonedFrom = F, returnGradeReferenceIDClonedTo = F, returnGradeReferenceMNID = F, returnGradYear = F, returnMinutesPresentFullDay = F, returnMinutesPresentHalfDay = F, returnModifiedTime = F, returnSchoolYearID = F, returnStateGradeLevel = F, returnStateSTARGradeLevelMNID = 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("Enrollment", "GradeReference", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific GradeReference
#'
#' This function returns fields for a GradeReference.
#'
#' @param GradeReferenceID The id of the GradeReference.\cr Run \code{\link{getAllGradeReferences}} for a list of GradeReferences.
#' @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 Enrollment
#' @return Details for the GradeReference.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getGradeReference <- function(GradeReferenceID, EntityID = 1, returnGradeReferenceID = F, returnCreatedTime = F, returnDistrictGroupKey = F, returnGradeLevelID = F, returnGradeReferenceIDClonedFrom = F, returnGradeReferenceIDClonedTo = F, returnGradeReferenceMNID = F, returnGradYear = F, returnMinutesPresentFullDay = F, returnMinutesPresentHalfDay = F, returnModifiedTime = F, returnSchoolYearID = F, returnStateGradeLevel = F, returnStateSTARGradeLevelMNID = 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("Enrollment", "GradeReference", GradeReferenceID, searchFields, EntityID)
}
#' Modify a specific GradeReference
#'
#' This function modifies fields for a GradeReference.
#'
#' @param GradeReferenceID The id of the GradeReference to be modified.\cr Run \code{\link{getAllGradeReferences}} for a list of GradeReferences.
#' @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 Enrollment
#' @return Details of the modified GradeReference.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyGradeReference <- function(GradeReferenceID, EntityID = 1, setDistrictGroupKey = NULL, setGradeLevelID = NULL, setGradeReferenceIDClonedFrom = NULL, setGradYear = NULL, setMinutesPresentFullDay = NULL, setMinutesPresentHalfDay = NULL, setSchoolYearID = NULL, setStateSTARGradeLevelMNID = 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("Enrollment", "GradeReference", GradeReferenceID, names(functionParams), functionParams, EntityID)
}
#' Create new GradeReference.
#'
#' This function creates a new GradeReference.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created GradeReference.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createGradeReference <- function(EntityID = 1, setDistrictGroupKey = NULL, setGradeLevelID = NULL, setGradeReferenceIDClonedFrom = NULL, setGradYear = NULL, setMinutesPresentFullDay = NULL, setMinutesPresentHalfDay = NULL, setSchoolYearID = NULL, setStateSTARGradeLevelMNID = 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("Enrollment", "GradeReference", names(functionParams), functionParams, EntityID)
}
#' Delete a specific GradeReference
#'
#' This function deletes a GradeReference.
#'
#' @param GradeReferenceID The id of the GradeReference.\cr Run \code{\link{getAllGradeReferences}} for a list of GradeReferences.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted GradeReference.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteGradeReference <- function(GradeReferenceID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "GradeReference", GradeReferenceID, EntityID)
}
#' Get all Homerooms.
#'
#' This function returns a dataframe of all Homerooms 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 Enrollment
#' @return All Homerooms in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllHomerooms <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnHomeroomID = F, returnCode = F, returnCreatedTime = F, returnEntityID = F, returnHomeroomDetails = F, returnHomeroomIDClonedFrom = F, returnHomeroomIDClonedTo = F, returnModifiedTime = F, returnRoomID = F, returnSchoolYearID = F, returnStaffID = 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("Enrollment", "Homeroom", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Homeroom
#'
#' This function returns fields for a Homeroom.
#'
#' @param HomeroomID The id of the Homeroom.\cr Run \code{\link{getAllHomerooms}} for a list of Homerooms.
#' @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 Enrollment
#' @return Details for the Homeroom.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getHomeroom <- function(HomeroomID, EntityID = 1, returnHomeroomID = F, returnCode = F, returnCreatedTime = F, returnEntityID = F, returnHomeroomDetails = F, returnHomeroomIDClonedFrom = F, returnHomeroomIDClonedTo = F, returnModifiedTime = F, returnRoomID = F, returnSchoolYearID = F, returnStaffID = 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("Enrollment", "Homeroom", HomeroomID, searchFields, EntityID)
}
#' Modify a specific Homeroom
#'
#' This function modifies fields for a Homeroom.
#'
#' @param HomeroomID The id of the Homeroom to be modified.\cr Run \code{\link{getAllHomerooms}} for a list of Homerooms.
#' @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 Enrollment
#' @return Details of the modified Homeroom.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyHomeroom <- function(HomeroomID, EntityID = 1, setCode = NULL, setEntityID = NULL, setHomeroomIDClonedFrom = NULL, setRoomID = NULL, setSchoolYearID = NULL, setStaffID = 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("Enrollment", "Homeroom", HomeroomID, names(functionParams), functionParams, EntityID)
}
#' Create new Homeroom.
#'
#' This function creates a new Homeroom.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created Homeroom.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createHomeroom <- function(EntityID = 1, setCode = NULL, setEntityID = NULL, setHomeroomIDClonedFrom = NULL, setRoomID = NULL, setSchoolYearID = NULL, setStaffID = 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("Enrollment", "Homeroom", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Homeroom
#'
#' This function deletes a Homeroom.
#'
#' @param HomeroomID The id of the Homeroom.\cr Run \code{\link{getAllHomerooms}} for a list of Homerooms.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted Homeroom.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteHomeroom <- function(HomeroomID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "Homeroom", HomeroomID, EntityID)
}
#' Get all NumberedStudentEntityYearForDistrictAndSchoolYears.
#'
#' This function returns a dataframe of all NumberedStudentEntityYearForDistrictAndSchoolYears 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 Enrollment
#' @return All NumberedStudentEntityYearForDistrictAndSchoolYears in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllNumberedStudentEntityYearForDistrictAndSchoolYears <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentEntityYearID = F, returnDistrictID = F, returnEntityID = F, returnIsDefaultEntity = F, returnSchoolYearID = F, returnStudentDistrictRowNumber = F, returnStudentID = 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("Enrollment", "NumberedStudentEntityYearForDistrictAndSchoolYear", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific NumberedStudentEntityYearForDistrictAndSchoolYear
#'
#' This function returns fields for a NumberedStudentEntityYearForDistrictAndSchoolYear.
#'
#' @param NumberedStudentEntityYearForDistrictAndSchoolYearID The id of the NumberedStudentEntityYearForDistrictAndSchoolYear.\cr Run \code{\link{getAllNumberedStudentEntityYearForDistrictAndSchoolYears}} for a list of NumberedStudentEntityYearForDistrictAndSchoolYears.
#' @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 Enrollment
#' @return Details for the NumberedStudentEntityYearForDistrictAndSchoolYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getNumberedStudentEntityYearForDistrictAndSchoolYear <- function(NumberedStudentEntityYearForDistrictAndSchoolYearID, EntityID = 1, returnStudentEntityYearID = F, returnDistrictID = F, returnEntityID = F, returnIsDefaultEntity = F, returnSchoolYearID = F, returnStudentDistrictRowNumber = F, returnStudentID = 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("Enrollment", "NumberedStudentEntityYearForDistrictAndSchoolYear", NumberedStudentEntityYearForDistrictAndSchoolYearID, searchFields, EntityID)
}
#' Modify a specific NumberedStudentEntityYearForDistrictAndSchoolYear
#'
#' This function modifies fields for a NumberedStudentEntityYearForDistrictAndSchoolYear.
#'
#' @param NumberedStudentEntityYearForDistrictAndSchoolYearID The id of the NumberedStudentEntityYearForDistrictAndSchoolYear to be modified.\cr Run \code{\link{getAllNumberedStudentEntityYearForDistrictAndSchoolYears}} for a list of NumberedStudentEntityYearForDistrictAndSchoolYears.
#' @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 Enrollment
#' @return Details of the modified NumberedStudentEntityYearForDistrictAndSchoolYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyNumberedStudentEntityYearForDistrictAndSchoolYear <- function(NumberedStudentEntityYearForDistrictAndSchoolYearID, EntityID = 1){
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("Enrollment", "NumberedStudentEntityYearForDistrictAndSchoolYear", NumberedStudentEntityYearForDistrictAndSchoolYearID, names(functionParams), functionParams, EntityID)
}
#' Create new NumberedStudentEntityYearForDistrictAndSchoolYear.
#'
#' This function creates a new NumberedStudentEntityYearForDistrictAndSchoolYear.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created NumberedStudentEntityYearForDistrictAndSchoolYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createNumberedStudentEntityYearForDistrictAndSchoolYear <- function(EntityID = 1){
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("Enrollment", "NumberedStudentEntityYearForDistrictAndSchoolYear", names(functionParams), functionParams, EntityID)
}
#' Delete a specific NumberedStudentEntityYearForDistrictAndSchoolYear
#'
#' This function deletes a NumberedStudentEntityYearForDistrictAndSchoolYear.
#'
#' @param NumberedStudentEntityYearForDistrictAndSchoolYearID The id of the NumberedStudentEntityYearForDistrictAndSchoolYear.\cr Run \code{\link{getAllNumberedStudentEntityYearForDistrictAndSchoolYears}} for a list of NumberedStudentEntityYearForDistrictAndSchoolYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted NumberedStudentEntityYearForDistrictAndSchoolYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteNumberedStudentEntityYearForDistrictAndSchoolYear <- function(NumberedStudentEntityYearForDistrictAndSchoolYearID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "NumberedStudentEntityYearForDistrictAndSchoolYear", NumberedStudentEntityYearForDistrictAndSchoolYearID, EntityID)
}
#' Get all PaymentPlanMAs.
#'
#' This function returns a dataframe of all PaymentPlanMAs 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 Enrollment
#' @return All PaymentPlanMAs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllPaymentPlanMAs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnPaymentPlanMAID = 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("Enrollment", "PaymentPlanMA", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific PaymentPlanMA
#'
#' This function returns fields for a PaymentPlanMA.
#'
#' @param PaymentPlanMAID The id of the PaymentPlanMA.\cr Run \code{\link{getAllPaymentPlanMAs}} for a list of PaymentPlanMAs.
#' @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 Enrollment
#' @return Details for the PaymentPlanMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getPaymentPlanMA <- function(PaymentPlanMAID, EntityID = 1, returnPaymentPlanMAID = 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("Enrollment", "PaymentPlanMA", PaymentPlanMAID, searchFields, EntityID)
}
#' Modify a specific PaymentPlanMA
#'
#' This function modifies fields for a PaymentPlanMA.
#'
#' @param PaymentPlanMAID The id of the PaymentPlanMA to be modified.\cr Run \code{\link{getAllPaymentPlanMAs}} for a list of PaymentPlanMAs.
#' @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 Enrollment
#' @return Details of the modified PaymentPlanMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyPaymentPlanMA <- function(PaymentPlanMAID, 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("Enrollment", "PaymentPlanMA", PaymentPlanMAID, names(functionParams), functionParams, EntityID)
}
#' Create new PaymentPlanMA.
#'
#' This function creates a new PaymentPlanMA.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created PaymentPlanMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createPaymentPlanMA <- 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("Enrollment", "PaymentPlanMA", names(functionParams), functionParams, EntityID)
}
#' Delete a specific PaymentPlanMA
#'
#' This function deletes a PaymentPlanMA.
#'
#' @param PaymentPlanMAID The id of the PaymentPlanMA.\cr Run \code{\link{getAllPaymentPlanMAs}} for a list of PaymentPlanMAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted PaymentPlanMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deletePaymentPlanMA <- function(PaymentPlanMAID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "PaymentPlanMA", PaymentPlanMAID, EntityID)
}
#' Get all Permits.
#'
#' This function returns a dataframe of all Permits 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 Enrollment
#' @return All Permits in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllPermits <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnPermitID = F, returnAllowSchoolPathAssignment = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnModifiedTime = F, returnPermitIDClonedFrom = F, returnPermitIDClonedTo = 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("Enrollment", "Permit", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Permit
#'
#' This function returns fields for a Permit.
#'
#' @param PermitID The id of the Permit.\cr Run \code{\link{getAllPermits}} for a list of Permits.
#' @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 Enrollment
#' @return Details for the Permit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getPermit <- function(PermitID, EntityID = 1, returnPermitID = F, returnAllowSchoolPathAssignment = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnModifiedTime = F, returnPermitIDClonedFrom = F, returnPermitIDClonedTo = 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("Enrollment", "Permit", PermitID, searchFields, EntityID)
}
#' Modify a specific Permit
#'
#' This function modifies fields for a Permit.
#'
#' @param PermitID The id of the Permit to be modified.\cr Run \code{\link{getAllPermits}} for a list of Permits.
#' @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 Enrollment
#' @return Details of the modified Permit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyPermit <- function(PermitID, EntityID = 1, setAllowSchoolPathAssignment = NULL, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setPermitIDClonedFrom = 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("Enrollment", "Permit", PermitID, names(functionParams), functionParams, EntityID)
}
#' Create new Permit.
#'
#' This function creates a new Permit.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created Permit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createPermit <- function(EntityID = 1, setAllowSchoolPathAssignment = NULL, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setPermitIDClonedFrom = 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("Enrollment", "Permit", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Permit
#'
#' This function deletes a Permit.
#'
#' @param PermitID The id of the Permit.\cr Run \code{\link{getAllPermits}} for a list of Permits.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted Permit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deletePermit <- function(PermitID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "Permit", PermitID, EntityID)
}
#' Get all PMTransportations.
#'
#' This function returns a dataframe of all PMTransportations 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 Enrollment
#' @return All PMTransportations in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllPMTransportations <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnPMTransportationID = 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("Enrollment", "PMTransportation", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific PMTransportation
#'
#' This function returns fields for a PMTransportation.
#'
#' @param PMTransportationID The id of the PMTransportation.\cr Run \code{\link{getAllPMTransportations}} for a list of PMTransportations.
#' @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 Enrollment
#' @return Details for the PMTransportation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getPMTransportation <- function(PMTransportationID, EntityID = 1, returnPMTransportationID = 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("Enrollment", "PMTransportation", PMTransportationID, searchFields, EntityID)
}
#' Modify a specific PMTransportation
#'
#' This function modifies fields for a PMTransportation.
#'
#' @param PMTransportationID The id of the PMTransportation to be modified.\cr Run \code{\link{getAllPMTransportations}} for a list of PMTransportations.
#' @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 Enrollment
#' @return Details of the modified PMTransportation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyPMTransportation <- function(PMTransportationID, 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("Enrollment", "PMTransportation", PMTransportationID, names(functionParams), functionParams, EntityID)
}
#' Create new PMTransportation.
#'
#' This function creates a new PMTransportation.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created PMTransportation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createPMTransportation <- 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("Enrollment", "PMTransportation", names(functionParams), functionParams, EntityID)
}
#' Delete a specific PMTransportation
#'
#' This function deletes a PMTransportation.
#'
#' @param PMTransportationID The id of the PMTransportation.\cr Run \code{\link{getAllPMTransportations}} for a list of PMTransportations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted PMTransportation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deletePMTransportation <- function(PMTransportationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "PMTransportation", PMTransportationID, EntityID)
}
#' Get all SchoolDistricts.
#'
#' This function returns a dataframe of all SchoolDistricts 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 Enrollment
#' @return All SchoolDistricts in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSchoolDistricts <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSchoolDistrictID = 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("Enrollment", "SchoolDistrict", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SchoolDistrict
#'
#' This function returns fields for a SchoolDistrict.
#'
#' @param SchoolDistrictID The id of the SchoolDistrict.\cr Run \code{\link{getAllSchoolDistricts}} for a list of SchoolDistricts.
#' @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 Enrollment
#' @return Details for the SchoolDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSchoolDistrict <- function(SchoolDistrictID, EntityID = 1, returnSchoolDistrictID = 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("Enrollment", "SchoolDistrict", SchoolDistrictID, searchFields, EntityID)
}
#' Modify a specific SchoolDistrict
#'
#' This function modifies fields for a SchoolDistrict.
#'
#' @param SchoolDistrictID The id of the SchoolDistrict to be modified.\cr Run \code{\link{getAllSchoolDistricts}} for a list of SchoolDistricts.
#' @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 Enrollment
#' @return Details of the modified SchoolDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySchoolDistrict <- function(SchoolDistrictID, 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("Enrollment", "SchoolDistrict", SchoolDistrictID, names(functionParams), functionParams, EntityID)
}
#' Create new SchoolDistrict.
#'
#' This function creates a new SchoolDistrict.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created SchoolDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSchoolDistrict <- 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("Enrollment", "SchoolDistrict", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SchoolDistrict
#'
#' This function deletes a SchoolDistrict.
#'
#' @param SchoolDistrictID The id of the SchoolDistrict.\cr Run \code{\link{getAllSchoolDistricts}} for a list of SchoolDistricts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted SchoolDistrict.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSchoolDistrict <- function(SchoolDistrictID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "SchoolDistrict", SchoolDistrictID, EntityID)
}
#' Get all Schools.
#'
#' This function returns a dataframe of all Schools 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 Enrollment
#' @return All Schools in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSchools <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSchoolID = F, returnAllowsSchoolDevices = F, returnAllowsStudentDevices = F, returnBuildingID = F, returnCampusAccountabilityRatingID = F, returnCEEBCode = F, returnCode = F, returnCodeName = F, returnCreatedTime = F, returnDaysInRegularSchoolYear = F, returnDaysPriorForAlgebraICounts = F, returnDistrictID = F, returnEdFiSchoolCategoryID = F, returnEdFiSchoolID = F, returnEducationalProgramHoursPerWeek = F, returnExcludeFromCRDC = F, returnFaxNumber = F, returnFaxNumberIsInternational = F, returnFederalAlternativeSchoolDetailID = F, returnFederalJusticeFacilityTypeID = F, returnFederalNCESSchoolID = F, returnFormattedFaxNumber = F, returnFormattedPhoneNumber = F, returnGradeLevelIDHigh = F, returnGradeLevelIDLow = F, returnHasAlcoholDrugEducation = F, returnHasAntiBullying = F, returnHasAntiViolence = F, returnHasAPCourses = F, returnHasAPSelfSelection = F, returnHasCorporalPunishment = F, returnHasCreditRecovery = F, returnHasCrisisPlan = F, returnHasDualEnrollment = F, returnHasFiberOptic = F, returnHasGifted = F, returnHasHomicideOccurred = F, returnHasIBDiplomaProgramme = F, returnHasPreschoolNonIDEAAge3 = F, returnHasPreschoolNonIDEAAge4 = F, returnHasPreschoolNonIDEAAge5 = F, returnHasSafetyPlan = F, returnHasShootingOccurred = F, returnHasSingleSexAthletics = F, returnHasSingleSexClasses = F, returnHasUngraded = F, returnHasUngradedMainlyElementary = F, returnHasUngradedMainlyHighSchool = F, returnHasUngradedMainlyMiddleSchool = F, returnHasWiFi = F, returnHasZeroTolerance = F, returnIsALCSchool = F, returnIsAlternative = F, returnIsCEP = F, returnIsCharter = F, returnIsCRDCCollectedForSchoolYear = F, returnIsEntireSchoolMagnet = F, returnIsMagnet = F, returnIsNonLEA = F, returnIsSpecialEducation = F, returnIsTitleIII = F, returnIsTitleISchoolwide = F, returnModifiedTime = F, returnName = F, returnNameIDSafetySpecialist = F, returnNumberWiFiDevices = F, returnPhoneNumber = F, returnPhoneNumberIsInternational = F, returnSchoolIDClonedFrom = F, returnSchoolIDClonedTo = F, returnSchoolMNID = F, returnSchoolNumber = F, returnSchoolYearID = F, returnStaffIDPrincipal = F, returnStateAssignedID = F, returnStateKindergartenScheduleIndicatorCodeMNID = F, returnStateSchoolMNID = F, returnStateTitleISchoolIndicatorCodeMNID = 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("Enrollment", "School", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific School
#'
#' This function returns fields for a School.
#'
#' @param SchoolID The id of the School.\cr Run \code{\link{getAllSchools}} for a list of Schools.
#' @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 Enrollment
#' @return Details for the School.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSchool <- function(SchoolID, EntityID = 1, returnSchoolID = F, returnAllowsSchoolDevices = F, returnAllowsStudentDevices = F, returnBuildingID = F, returnCampusAccountabilityRatingID = F, returnCEEBCode = F, returnCode = F, returnCodeName = F, returnCreatedTime = F, returnDaysInRegularSchoolYear = F, returnDaysPriorForAlgebraICounts = F, returnDistrictID = F, returnEdFiSchoolCategoryID = F, returnEdFiSchoolID = F, returnEducationalProgramHoursPerWeek = F, returnExcludeFromCRDC = F, returnFaxNumber = F, returnFaxNumberIsInternational = F, returnFederalAlternativeSchoolDetailID = F, returnFederalJusticeFacilityTypeID = F, returnFederalNCESSchoolID = F, returnFormattedFaxNumber = F, returnFormattedPhoneNumber = F, returnGradeLevelIDHigh = F, returnGradeLevelIDLow = F, returnHasAlcoholDrugEducation = F, returnHasAntiBullying = F, returnHasAntiViolence = F, returnHasAPCourses = F, returnHasAPSelfSelection = F, returnHasCorporalPunishment = F, returnHasCreditRecovery = F, returnHasCrisisPlan = F, returnHasDualEnrollment = F, returnHasFiberOptic = F, returnHasGifted = F, returnHasHomicideOccurred = F, returnHasIBDiplomaProgramme = F, returnHasPreschoolNonIDEAAge3 = F, returnHasPreschoolNonIDEAAge4 = F, returnHasPreschoolNonIDEAAge5 = F, returnHasSafetyPlan = F, returnHasShootingOccurred = F, returnHasSingleSexAthletics = F, returnHasSingleSexClasses = F, returnHasUngraded = F, returnHasUngradedMainlyElementary = F, returnHasUngradedMainlyHighSchool = F, returnHasUngradedMainlyMiddleSchool = F, returnHasWiFi = F, returnHasZeroTolerance = F, returnIsALCSchool = F, returnIsAlternative = F, returnIsCEP = F, returnIsCharter = F, returnIsCRDCCollectedForSchoolYear = F, returnIsEntireSchoolMagnet = F, returnIsMagnet = F, returnIsNonLEA = F, returnIsSpecialEducation = F, returnIsTitleIII = F, returnIsTitleISchoolwide = F, returnModifiedTime = F, returnName = F, returnNameIDSafetySpecialist = F, returnNumberWiFiDevices = F, returnPhoneNumber = F, returnPhoneNumberIsInternational = F, returnSchoolIDClonedFrom = F, returnSchoolIDClonedTo = F, returnSchoolMNID = F, returnSchoolNumber = F, returnSchoolYearID = F, returnStaffIDPrincipal = F, returnStateAssignedID = F, returnStateKindergartenScheduleIndicatorCodeMNID = F, returnStateSchoolMNID = F, returnStateTitleISchoolIndicatorCodeMNID = 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("Enrollment", "School", SchoolID, searchFields, EntityID)
}
#' Modify a specific School
#'
#' This function modifies fields for a School.
#'
#' @param SchoolID The id of the School to be modified.\cr Run \code{\link{getAllSchools}} for a list of Schools.
#' @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 Enrollment
#' @return Details of the modified School.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySchool <- function(SchoolID, EntityID = 1, setAllowsSchoolDevices = NULL, setAllowsStudentDevices = NULL, setCampusAccountabilityRatingID = NULL, setCEEBCode = NULL, setCode = NULL, setDaysInRegularSchoolYear = NULL, setDaysPriorForAlgebraICounts = NULL, setDistrictID = NULL, setEdFiSchoolCategoryID = NULL, setEdFiSchoolID = NULL, setEducationalProgramHoursPerWeek = NULL, setExcludeFromCRDC = NULL, setFaxNumber = NULL, setFaxNumberIsInternational = NULL, setFederalAlternativeSchoolDetailID = NULL, setFederalJusticeFacilityTypeID = NULL, setFederalNCESSchoolID = NULL, setGradeLevelIDHigh = NULL, setGradeLevelIDLow = NULL, setHasAlcoholDrugEducation = NULL, setHasAntiBullying = NULL, setHasAntiViolence = NULL, setHasAPCourses = NULL, setHasAPSelfSelection = NULL, setHasCorporalPunishment = NULL, setHasCreditRecovery = NULL, setHasCrisisPlan = NULL, setHasDualEnrollment = NULL, setHasFiberOptic = NULL, setHasGifted = NULL, setHasHomicideOccurred = NULL, setHasIBDiplomaProgramme = NULL, setHasPreschoolNonIDEAAge3 = NULL, setHasPreschoolNonIDEAAge4 = NULL, setHasPreschoolNonIDEAAge5 = NULL, setHasSafetyPlan = NULL, setHasShootingOccurred = NULL, setHasSingleSexAthletics = NULL, setHasSingleSexClasses = NULL, setHasUngraded = NULL, setHasUngradedMainlyElementary = NULL, setHasUngradedMainlyHighSchool = NULL, setHasUngradedMainlyMiddleSchool = NULL, setHasWiFi = NULL, setHasZeroTolerance = NULL, setIsALCSchool = NULL, setIsAlternative = NULL, setIsCEP = NULL, setIsCharter = NULL, setIsEntireSchoolMagnet = NULL, setIsMagnet = NULL, setIsNonLEA = NULL, setIsSpecialEducation = NULL, setIsTitleIII = NULL, setIsTitleISchoolwide = NULL, setName = NULL, setNameIDSafetySpecialist = NULL, setNumberWiFiDevices = NULL, setPhoneNumber = NULL, setPhoneNumberIsInternational = NULL, setSchoolIDClonedFrom = NULL, setSchoolNumber = NULL, setSchoolYearID = NULL, setStaffIDPrincipal = NULL, setStateKindergartenScheduleIndicatorCodeMNID = NULL, setStateSchoolMNID = NULL, setStateTitleISchoolIndicatorCodeMNID = 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("Enrollment", "School", SchoolID, names(functionParams), functionParams, EntityID)
}
#' Create new School.
#'
#' This function creates a new School.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created School.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSchool <- function(EntityID = 1, setAllowsSchoolDevices = NULL, setAllowsStudentDevices = NULL, setCampusAccountabilityRatingID = NULL, setCEEBCode = NULL, setCode = NULL, setDaysInRegularSchoolYear = NULL, setDaysPriorForAlgebraICounts = NULL, setDistrictID = NULL, setEdFiSchoolCategoryID = NULL, setEdFiSchoolID = NULL, setEducationalProgramHoursPerWeek = NULL, setExcludeFromCRDC = NULL, setFaxNumber = NULL, setFaxNumberIsInternational = NULL, setFederalAlternativeSchoolDetailID = NULL, setFederalJusticeFacilityTypeID = NULL, setFederalNCESSchoolID = NULL, setGradeLevelIDHigh = NULL, setGradeLevelIDLow = NULL, setHasAlcoholDrugEducation = NULL, setHasAntiBullying = NULL, setHasAntiViolence = NULL, setHasAPCourses = NULL, setHasAPSelfSelection = NULL, setHasCorporalPunishment = NULL, setHasCreditRecovery = NULL, setHasCrisisPlan = NULL, setHasDualEnrollment = NULL, setHasFiberOptic = NULL, setHasGifted = NULL, setHasHomicideOccurred = NULL, setHasIBDiplomaProgramme = NULL, setHasPreschoolNonIDEAAge3 = NULL, setHasPreschoolNonIDEAAge4 = NULL, setHasPreschoolNonIDEAAge5 = NULL, setHasSafetyPlan = NULL, setHasShootingOccurred = NULL, setHasSingleSexAthletics = NULL, setHasSingleSexClasses = NULL, setHasUngraded = NULL, setHasUngradedMainlyElementary = NULL, setHasUngradedMainlyHighSchool = NULL, setHasUngradedMainlyMiddleSchool = NULL, setHasWiFi = NULL, setHasZeroTolerance = NULL, setIsALCSchool = NULL, setIsAlternative = NULL, setIsCEP = NULL, setIsCharter = NULL, setIsEntireSchoolMagnet = NULL, setIsMagnet = NULL, setIsNonLEA = NULL, setIsSpecialEducation = NULL, setIsTitleIII = NULL, setIsTitleISchoolwide = NULL, setName = NULL, setNameIDSafetySpecialist = NULL, setNumberWiFiDevices = NULL, setPhoneNumber = NULL, setPhoneNumberIsInternational = NULL, setSchoolIDClonedFrom = NULL, setSchoolNumber = NULL, setSchoolYearID = NULL, setStaffIDPrincipal = NULL, setStateKindergartenScheduleIndicatorCodeMNID = NULL, setStateSchoolMNID = NULL, setStateTitleISchoolIndicatorCodeMNID = 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("Enrollment", "School", names(functionParams), functionParams, EntityID)
}
#' Delete a specific School
#'
#' This function deletes a School.
#'
#' @param SchoolID The id of the School.\cr Run \code{\link{getAllSchools}} for a list of Schools.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted School.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSchool <- function(SchoolID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "School", SchoolID, EntityID)
}
#' Get all SchoolPaths.
#'
#' This function returns a dataframe of all SchoolPaths 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 Enrollment
#' @return All SchoolPaths in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSchoolPaths <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSchoolPathID = F, returnCreatedTime = F, returnDistrictID = F, returnModifiedTime = F, returnName = F, returnSchoolPathIDClonedFrom = F, returnSchoolPathIDClonedTo = F, returnSchoolPathTypeID = 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("Enrollment", "SchoolPath", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SchoolPath
#'
#' This function returns fields for a SchoolPath.
#'
#' @param SchoolPathID The id of the SchoolPath.\cr Run \code{\link{getAllSchoolPaths}} for a list of SchoolPaths.
#' @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 Enrollment
#' @return Details for the SchoolPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSchoolPath <- function(SchoolPathID, EntityID = 1, returnSchoolPathID = F, returnCreatedTime = F, returnDistrictID = F, returnModifiedTime = F, returnName = F, returnSchoolPathIDClonedFrom = F, returnSchoolPathIDClonedTo = F, returnSchoolPathTypeID = 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("Enrollment", "SchoolPath", SchoolPathID, searchFields, EntityID)
}
#' Modify a specific SchoolPath
#'
#' This function modifies fields for a SchoolPath.
#'
#' @param SchoolPathID The id of the SchoolPath to be modified.\cr Run \code{\link{getAllSchoolPaths}} for a list of SchoolPaths.
#' @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 Enrollment
#' @return Details of the modified SchoolPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySchoolPath <- function(SchoolPathID, EntityID = 1, setDistrictID = NULL, setName = NULL, setSchoolPathIDClonedFrom = NULL, setSchoolPathTypeID = 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("Enrollment", "SchoolPath", SchoolPathID, names(functionParams), functionParams, EntityID)
}
#' Create new SchoolPath.
#'
#' This function creates a new SchoolPath.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created SchoolPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSchoolPath <- function(EntityID = 1, setDistrictID = NULL, setName = NULL, setSchoolPathIDClonedFrom = NULL, setSchoolPathTypeID = 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("Enrollment", "SchoolPath", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SchoolPath
#'
#' This function deletes a SchoolPath.
#'
#' @param SchoolPathID The id of the SchoolPath.\cr Run \code{\link{getAllSchoolPaths}} for a list of SchoolPaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted SchoolPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSchoolPath <- function(SchoolPathID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "SchoolPath", SchoolPathID, EntityID)
}
#' Get all SchoolPathSchools.
#'
#' This function returns a dataframe of all SchoolPathSchools 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 Enrollment
#' @return All SchoolPathSchools in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSchoolPathSchools <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSchoolPathSchoolID = F, returnCodeDescription = F, returnCreatedTime = F, returnDistrictID = F, returnIsOverriddenForStudent = F, returnModifiedTime = F, returnOrder = F, returnOverriddenSchoolName = F, returnSchoolID = F, returnSchoolPathID = F, returnSchoolPathSchoolIDClonedFrom = F, returnSchoolPathSchoolIDClonedTo = F, returnSchoolYearID = F, returnStudentHasPermit = 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("Enrollment", "SchoolPathSchool", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SchoolPathSchool
#'
#' This function returns fields for a SchoolPathSchool.
#'
#' @param SchoolPathSchoolID The id of the SchoolPathSchool.\cr Run \code{\link{getAllSchoolPathSchools}} for a list of SchoolPathSchools.
#' @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 Enrollment
#' @return Details for the SchoolPathSchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSchoolPathSchool <- function(SchoolPathSchoolID, EntityID = 1, returnSchoolPathSchoolID = F, returnCodeDescription = F, returnCreatedTime = F, returnDistrictID = F, returnIsOverriddenForStudent = F, returnModifiedTime = F, returnOrder = F, returnOverriddenSchoolName = F, returnSchoolID = F, returnSchoolPathID = F, returnSchoolPathSchoolIDClonedFrom = F, returnSchoolPathSchoolIDClonedTo = F, returnSchoolYearID = F, returnStudentHasPermit = 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("Enrollment", "SchoolPathSchool", SchoolPathSchoolID, searchFields, EntityID)
}
#' Modify a specific SchoolPathSchool
#'
#' This function modifies fields for a SchoolPathSchool.
#'
#' @param SchoolPathSchoolID The id of the SchoolPathSchool to be modified.\cr Run \code{\link{getAllSchoolPathSchools}} for a list of SchoolPathSchools.
#' @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 Enrollment
#' @return Details of the modified SchoolPathSchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySchoolPathSchool <- function(SchoolPathSchoolID, EntityID = 1, setDistrictID = NULL, setOrder = NULL, setSchoolID = NULL, setSchoolPathID = NULL, setSchoolPathSchoolIDClonedFrom = 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("Enrollment", "SchoolPathSchool", SchoolPathSchoolID, names(functionParams), functionParams, EntityID)
}
#' Create new SchoolPathSchool.
#'
#' This function creates a new SchoolPathSchool.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created SchoolPathSchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSchoolPathSchool <- function(EntityID = 1, setDistrictID = NULL, setOrder = NULL, setSchoolID = NULL, setSchoolPathID = NULL, setSchoolPathSchoolIDClonedFrom = 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("Enrollment", "SchoolPathSchool", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SchoolPathSchool
#'
#' This function deletes a SchoolPathSchool.
#'
#' @param SchoolPathSchoolID The id of the SchoolPathSchool.\cr Run \code{\link{getAllSchoolPathSchools}} for a list of SchoolPathSchools.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted SchoolPathSchool.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSchoolPathSchool <- function(SchoolPathSchoolID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "SchoolPathSchool", SchoolPathSchoolID, EntityID)
}
#' Get all SchoolPathSchoolOverrides.
#'
#' This function returns a dataframe of all SchoolPathSchoolOverrides 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 Enrollment
#' @return All SchoolPathSchoolOverrides in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSchoolPathSchoolOverrides <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSchoolPathSchoolOverrideID = F, returnCreatedTime = F, returnModifiedTime = F, returnOrder = F, returnSchoolID = 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("Enrollment", "SchoolPathSchoolOverride", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SchoolPathSchoolOverride
#'
#' This function returns fields for a SchoolPathSchoolOverride.
#'
#' @param SchoolPathSchoolOverrideID The id of the SchoolPathSchoolOverride.\cr Run \code{\link{getAllSchoolPathSchoolOverrides}} for a list of SchoolPathSchoolOverrides.
#' @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 Enrollment
#' @return Details for the SchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSchoolPathSchoolOverride <- function(SchoolPathSchoolOverrideID, EntityID = 1, returnSchoolPathSchoolOverrideID = F, returnCreatedTime = F, returnModifiedTime = F, returnOrder = F, returnSchoolID = 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("Enrollment", "SchoolPathSchoolOverride", SchoolPathSchoolOverrideID, searchFields, EntityID)
}
#' Modify a specific SchoolPathSchoolOverride
#'
#' This function modifies fields for a SchoolPathSchoolOverride.
#'
#' @param SchoolPathSchoolOverrideID The id of the SchoolPathSchoolOverride to be modified.\cr Run \code{\link{getAllSchoolPathSchoolOverrides}} for a list of SchoolPathSchoolOverrides.
#' @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 Enrollment
#' @return Details of the modified SchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySchoolPathSchoolOverride <- function(SchoolPathSchoolOverrideID, EntityID = 1, setOrder = NULL, setSchoolID = 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("Enrollment", "SchoolPathSchoolOverride", SchoolPathSchoolOverrideID, names(functionParams), functionParams, EntityID)
}
#' Create new SchoolPathSchoolOverride.
#'
#' This function creates a new SchoolPathSchoolOverride.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created SchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSchoolPathSchoolOverride <- function(EntityID = 1, setOrder = NULL, setSchoolID = 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("Enrollment", "SchoolPathSchoolOverride", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SchoolPathSchoolOverride
#'
#' This function deletes a SchoolPathSchoolOverride.
#'
#' @param SchoolPathSchoolOverrideID The id of the SchoolPathSchoolOverride.\cr Run \code{\link{getAllSchoolPathSchoolOverrides}} for a list of SchoolPathSchoolOverrides.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted SchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSchoolPathSchoolOverride <- function(SchoolPathSchoolOverrideID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "SchoolPathSchoolOverride", SchoolPathSchoolOverrideID, EntityID)
}
#' Get all SchoolPathStudents.
#'
#' This function returns a dataframe of all SchoolPathStudents 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 Enrollment
#' @return All SchoolPathStudents in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSchoolPathStudents <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSchoolPathStudentID = F, returnCreatedTime = F, returnDistrictID = F, returnModifiedTime = F, returnSchoolPathID = 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("Enrollment", "SchoolPathStudent", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SchoolPathStudent
#'
#' This function returns fields for a SchoolPathStudent.
#'
#' @param SchoolPathStudentID The id of the SchoolPathStudent.\cr Run \code{\link{getAllSchoolPathStudents}} for a list of SchoolPathStudents.
#' @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 Enrollment
#' @return Details for the SchoolPathStudent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSchoolPathStudent <- function(SchoolPathStudentID, EntityID = 1, returnSchoolPathStudentID = F, returnCreatedTime = F, returnDistrictID = F, returnModifiedTime = F, returnSchoolPathID = 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("Enrollment", "SchoolPathStudent", SchoolPathStudentID, searchFields, EntityID)
}
#' Modify a specific SchoolPathStudent
#'
#' This function modifies fields for a SchoolPathStudent.
#'
#' @param SchoolPathStudentID The id of the SchoolPathStudent to be modified.\cr Run \code{\link{getAllSchoolPathStudents}} for a list of SchoolPathStudents.
#' @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 Enrollment
#' @return Details of the modified SchoolPathStudent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySchoolPathStudent <- function(SchoolPathStudentID, EntityID = 1, setDistrictID = NULL, setSchoolPathID = 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("Enrollment", "SchoolPathStudent", SchoolPathStudentID, names(functionParams), functionParams, EntityID)
}
#' Create new SchoolPathStudent.
#'
#' This function creates a new SchoolPathStudent.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created SchoolPathStudent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSchoolPathStudent <- function(EntityID = 1, setDistrictID = NULL, setSchoolPathID = 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("Enrollment", "SchoolPathStudent", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SchoolPathStudent
#'
#' This function deletes a SchoolPathStudent.
#'
#' @param SchoolPathStudentID The id of the SchoolPathStudent.\cr Run \code{\link{getAllSchoolPathStudents}} for a list of SchoolPathStudents.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted SchoolPathStudent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSchoolPathStudent <- function(SchoolPathStudentID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "SchoolPathStudent", SchoolPathStudentID, EntityID)
}
#' Get all SchoolPathTypes.
#'
#' This function returns a dataframe of all SchoolPathTypes 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 Enrollment
#' @return All SchoolPathTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSchoolPathTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSchoolPathTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = 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("Enrollment", "SchoolPathType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SchoolPathType
#'
#' This function returns fields for a SchoolPathType.
#'
#' @param SchoolPathTypeID The id of the SchoolPathType.\cr Run \code{\link{getAllSchoolPathTypes}} for a list of SchoolPathTypes.
#' @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 Enrollment
#' @return Details for the SchoolPathType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSchoolPathType <- function(SchoolPathTypeID, EntityID = 1, returnSchoolPathTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = 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("Enrollment", "SchoolPathType", SchoolPathTypeID, searchFields, EntityID)
}
#' Modify a specific SchoolPathType
#'
#' This function modifies fields for a SchoolPathType.
#'
#' @param SchoolPathTypeID The id of the SchoolPathType to be modified.\cr Run \code{\link{getAllSchoolPathTypes}} for a list of SchoolPathTypes.
#' @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 Enrollment
#' @return Details of the modified SchoolPathType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySchoolPathType <- function(SchoolPathTypeID, EntityID = 1, setCode = NULL, setDescription = 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("Enrollment", "SchoolPathType", SchoolPathTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new SchoolPathType.
#'
#' This function creates a new SchoolPathType.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created SchoolPathType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSchoolPathType <- function(EntityID = 1, setCode = NULL, setDescription = 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("Enrollment", "SchoolPathType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SchoolPathType
#'
#' This function deletes a SchoolPathType.
#'
#' @param SchoolPathTypeID The id of the SchoolPathType.\cr Run \code{\link{getAllSchoolPathTypes}} for a list of SchoolPathTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted SchoolPathType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSchoolPathType <- function(SchoolPathTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "SchoolPathType", SchoolPathTypeID, EntityID)
}
#' Get all StudentAccountsMAs.
#'
#' This function returns a dataframe of all StudentAccountsMAs 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 Enrollment
#' @return All StudentAccountsMAs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentAccountsMAs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentAccountsMAID = F, returnAMTransportationID = F, returnCreatedTime = F, returnEthnicityMAID = F, returnFacultyStaffChild = F, returnFinancialAid = F, returniPadLease = F, returnModifiedTime = F, returnNYDepositPaid = F, returnPaymentPlanMAID = F, returnPlaceofWorship = F, returnPMTransportationID = F, returnReligionID = F, returnSchoolDistrictID = 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("Enrollment", "StudentAccountsMA", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentAccountsMA
#'
#' This function returns fields for a StudentAccountsMA.
#'
#' @param StudentAccountsMAID The id of the StudentAccountsMA.\cr Run \code{\link{getAllStudentAccountsMAs}} for a list of StudentAccountsMAs.
#' @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 Enrollment
#' @return Details for the StudentAccountsMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentAccountsMA <- function(StudentAccountsMAID, EntityID = 1, returnStudentAccountsMAID = F, returnAMTransportationID = F, returnCreatedTime = F, returnEthnicityMAID = F, returnFacultyStaffChild = F, returnFinancialAid = F, returniPadLease = F, returnModifiedTime = F, returnNYDepositPaid = F, returnPaymentPlanMAID = F, returnPlaceofWorship = F, returnPMTransportationID = F, returnReligionID = F, returnSchoolDistrictID = 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("Enrollment", "StudentAccountsMA", StudentAccountsMAID, searchFields, EntityID)
}
#' Modify a specific StudentAccountsMA
#'
#' This function modifies fields for a StudentAccountsMA.
#'
#' @param StudentAccountsMAID The id of the StudentAccountsMA to be modified.\cr Run \code{\link{getAllStudentAccountsMAs}} for a list of StudentAccountsMAs.
#' @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 Enrollment
#' @return Details of the modified StudentAccountsMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentAccountsMA <- function(StudentAccountsMAID, EntityID = 1, setAMTransportationID = NULL, setEthnicityMAID = NULL, setFacultyStaffChild = NULL, setFinancialAid = NULL, setiPadLease = NULL, setNYDepositPaid = NULL, setPaymentPlanMAID = NULL, setPlaceofWorship = NULL, setPMTransportationID = NULL, setReligionID = NULL, setSchoolDistrictID = 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("Enrollment", "StudentAccountsMA", StudentAccountsMAID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentAccountsMA.
#'
#' This function creates a new StudentAccountsMA.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created StudentAccountsMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentAccountsMA <- function(EntityID = 1, setAMTransportationID = NULL, setEthnicityMAID = NULL, setFacultyStaffChild = NULL, setFinancialAid = NULL, setiPadLease = NULL, setNYDepositPaid = NULL, setPaymentPlanMAID = NULL, setPlaceofWorship = NULL, setPMTransportationID = NULL, setReligionID = NULL, setSchoolDistrictID = 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("Enrollment", "StudentAccountsMA", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentAccountsMA
#'
#' This function deletes a StudentAccountsMA.
#'
#' @param StudentAccountsMAID The id of the StudentAccountsMA.\cr Run \code{\link{getAllStudentAccountsMAs}} for a list of StudentAccountsMAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted StudentAccountsMA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentAccountsMA <- function(StudentAccountsMAID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "StudentAccountsMA", StudentAccountsMAID, EntityID)
}
#' Get all StudentEntityYears.
#'
#' This function returns a dataframe of all StudentEntityYears 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 Enrollment
#' @return All StudentEntityYears in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentEntityYears <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentEntityYearID = F, returnChromebookDocumentsReturned = F, returnCreatedTime = F, returnCurrentPercentEnrolled = F, returnDaysAbsentYTD = F, returnDaysEnrolledYTD = F, returnDaysExcusedYTD = F, returnDaysOtherYTD = F, returnDaysUnexcusedYTD = F, returnEntityID = F, returnEntryWithdrawalIDLatest = F, returnExcludeFromHonorRoll = F, returnExcludeFromRank = F, returnExistsConflictedStudentCourseRequests = F, returnExistsUnscheduleableStudentSections = F, returnFeeAmountDue = F, returnFeeChargeAmount = F, returnFeePaidAmount = F, returnFeePaidAndWaivedAmount = F, returnFeeUnappliedAmount = F, returnFeeWaivedAmount = F, returnFirstName = F, returnFlaggedMissingAssignmentsCount = F, returnGrade = F, returnHandbookSigned = F, returnHasActiveCareerPlanDeclarationTimePeriod = F, returnHasActiveEndorsementDeclarationTimePeriod = F, returnHasConflictedStudentCourseRequest = F, returnHasFlaggedMissingAssignments = F, returnHasMissingAssignments = F, returnHasNoAttendanceToday = F, returnHasNonCrossEntityCourseSchedulingEntryWithdrawal = F, returnHasOpenDisplayPeriodsInRegularSchoolDay = F, returnHasOverscheduledPeriod = F, returnHasValidStudentPlan = F, returnHomeroomCodeFollettDestiny = F, returnHomeroomID = F, returnHomeroomPeriodFollettDestiny = F, returnHomeroomStaffNameFollettDestiny = F, returnIncludeAsProspectiveRank = F, returnIsActive = F, returnIsCrossEntityCourseEnrollment = F, returnIsDefaultEntity = F, returnIsTransportationRequested = F, returnLastName = F, returnMiddleName = F, returnModifiedTime = F, returnNameID = F, returnNumberOfStudentCourseRequests = F, returnNumberOfStudentSections = F, returnOptOutOfMedia = F, returnSchedulingCategories = F, returnSchedulingTeamID = F, returnSchoolIDPathExpectedSchool = F, returnSchoolYearID = F, returnSectionLengthAbsent = F, returnSectionLengthEnrolled = F, returnSemester2Absent = F, returnSemester2Enrolled = F, returnSignedAcceptableUsePolicy = F, returnStaffIDAdvisor = F, returnStaffIDDisciplineOfficer = F, returnStudentID = F, returnStudentNumber = F, returnTardyCountYTD = F, returnTardyKioskTotals = F, returnTotalEarnedCreditsPossibleAnticipatedNonTransferStudentSectionsNonAlternateRequestCredits = F, returnTotalMissedAssignmentCount = F, returnUILFeeReceived = F, returnUnscheduleableStudentSectionCount = F, returnUnscheduledStudentCourseRequestCount = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalDate = 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("Enrollment", "StudentEntityYear", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentEntityYear
#'
#' This function returns fields for a StudentEntityYear.
#'
#' @param StudentEntityYearID The id of the StudentEntityYear.\cr Run \code{\link{getAllStudentEntityYears}} for a list of StudentEntityYears.
#' @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 Enrollment
#' @return Details for the StudentEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentEntityYear <- function(StudentEntityYearID, EntityID = 1, returnStudentEntityYearID = F, returnChromebookDocumentsReturned = F, returnCreatedTime = F, returnCurrentPercentEnrolled = F, returnDaysAbsentYTD = F, returnDaysEnrolledYTD = F, returnDaysExcusedYTD = F, returnDaysOtherYTD = F, returnDaysUnexcusedYTD = F, returnEntityID = F, returnEntryWithdrawalIDLatest = F, returnExcludeFromHonorRoll = F, returnExcludeFromRank = F, returnExistsConflictedStudentCourseRequests = F, returnExistsUnscheduleableStudentSections = F, returnFeeAmountDue = F, returnFeeChargeAmount = F, returnFeePaidAmount = F, returnFeePaidAndWaivedAmount = F, returnFeeUnappliedAmount = F, returnFeeWaivedAmount = F, returnFirstName = F, returnFlaggedMissingAssignmentsCount = F, returnGrade = F, returnHandbookSigned = F, returnHasActiveCareerPlanDeclarationTimePeriod = F, returnHasActiveEndorsementDeclarationTimePeriod = F, returnHasConflictedStudentCourseRequest = F, returnHasFlaggedMissingAssignments = F, returnHasMissingAssignments = F, returnHasNoAttendanceToday = F, returnHasNonCrossEntityCourseSchedulingEntryWithdrawal = F, returnHasOpenDisplayPeriodsInRegularSchoolDay = F, returnHasOverscheduledPeriod = F, returnHasValidStudentPlan = F, returnHomeroomCodeFollettDestiny = F, returnHomeroomID = F, returnHomeroomPeriodFollettDestiny = F, returnHomeroomStaffNameFollettDestiny = F, returnIncludeAsProspectiveRank = F, returnIsActive = F, returnIsCrossEntityCourseEnrollment = F, returnIsDefaultEntity = F, returnIsTransportationRequested = F, returnLastName = F, returnMiddleName = F, returnModifiedTime = F, returnNameID = F, returnNumberOfStudentCourseRequests = F, returnNumberOfStudentSections = F, returnOptOutOfMedia = F, returnSchedulingCategories = F, returnSchedulingTeamID = F, returnSchoolIDPathExpectedSchool = F, returnSchoolYearID = F, returnSectionLengthAbsent = F, returnSectionLengthEnrolled = F, returnSemester2Absent = F, returnSemester2Enrolled = F, returnSignedAcceptableUsePolicy = F, returnStaffIDAdvisor = F, returnStaffIDDisciplineOfficer = F, returnStudentID = F, returnStudentNumber = F, returnTardyCountYTD = F, returnTardyKioskTotals = F, returnTotalEarnedCreditsPossibleAnticipatedNonTransferStudentSectionsNonAlternateRequestCredits = F, returnTotalMissedAssignmentCount = F, returnUILFeeReceived = F, returnUnscheduleableStudentSectionCount = F, returnUnscheduledStudentCourseRequestCount = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalDate = 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("Enrollment", "StudentEntityYear", StudentEntityYearID, searchFields, EntityID)
}
#' Modify a specific StudentEntityYear
#'
#' This function modifies fields for a StudentEntityYear.
#'
#' @param StudentEntityYearID The id of the StudentEntityYear to be modified.\cr Run \code{\link{getAllStudentEntityYears}} for a list of StudentEntityYears.
#' @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 Enrollment
#' @return Details of the modified StudentEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentEntityYear <- function(StudentEntityYearID, EntityID = 1, setChromebookDocumentsReturned = NULL, setCurrentPercentEnrolled = NULL, setEntityID = NULL, setEntryWithdrawalIDLatest = NULL, setExcludeFromHonorRoll = NULL, setExcludeFromRank = NULL, setGrade = NULL, setHandbookSigned = NULL, setHomeroomID = NULL, setIncludeAsProspectiveRank = NULL, setIsActive = NULL, setIsCrossEntityCourseEnrollment = NULL, setIsDefaultEntity = NULL, setIsTransportationRequested = NULL, setNameID = NULL, setOptOutOfMedia = NULL, setSchedulingTeamID = NULL, setSchoolIDPathExpectedSchool = NULL, setSchoolYearID = NULL, setSignedAcceptableUsePolicy = NULL, setStaffIDAdvisor = NULL, setStaffIDDisciplineOfficer = NULL, setStudentID = NULL, setStudentNumber = NULL, setUILFeeReceived = 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("Enrollment", "StudentEntityYear", StudentEntityYearID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentEntityYear.
#'
#' This function creates a new StudentEntityYear.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created StudentEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentEntityYear <- function(EntityID = 1, setChromebookDocumentsReturned = NULL, setCurrentPercentEnrolled = NULL, setEntityID = NULL, setEntryWithdrawalIDLatest = NULL, setExcludeFromHonorRoll = NULL, setExcludeFromRank = NULL, setGrade = NULL, setHandbookSigned = NULL, setHomeroomID = NULL, setIncludeAsProspectiveRank = NULL, setIsActive = NULL, setIsCrossEntityCourseEnrollment = NULL, setIsDefaultEntity = NULL, setIsTransportationRequested = NULL, setNameID = NULL, setOptOutOfMedia = NULL, setSchedulingTeamID = NULL, setSchoolIDPathExpectedSchool = NULL, setSchoolYearID = NULL, setSignedAcceptableUsePolicy = NULL, setStaffIDAdvisor = NULL, setStaffIDDisciplineOfficer = NULL, setStudentID = NULL, setStudentNumber = NULL, setUILFeeReceived = 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("Enrollment", "StudentEntityYear", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentEntityYear
#'
#' This function deletes a StudentEntityYear.
#'
#' @param StudentEntityYearID The id of the StudentEntityYear.\cr Run \code{\link{getAllStudentEntityYears}} for a list of StudentEntityYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted StudentEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentEntityYear <- function(StudentEntityYearID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "StudentEntityYear", StudentEntityYearID, EntityID)
}
#' Get all StudentPermits.
#'
#' This function returns a dataframe of all StudentPermits 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 Enrollment
#' @return All StudentPermits in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentPermits <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentPermitID = F, returnCreatedTime = F, returnDistrictID = F, returnModifiedTime = F, returnPermitID = 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("Enrollment", "StudentPermit", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentPermit
#'
#' This function returns fields for a StudentPermit.
#'
#' @param StudentPermitID The id of the StudentPermit.\cr Run \code{\link{getAllStudentPermits}} for a list of StudentPermits.
#' @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 Enrollment
#' @return Details for the StudentPermit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentPermit <- function(StudentPermitID, EntityID = 1, returnStudentPermitID = F, returnCreatedTime = F, returnDistrictID = F, returnModifiedTime = F, returnPermitID = 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("Enrollment", "StudentPermit", StudentPermitID, searchFields, EntityID)
}
#' Modify a specific StudentPermit
#'
#' This function modifies fields for a StudentPermit.
#'
#' @param StudentPermitID The id of the StudentPermit to be modified.\cr Run \code{\link{getAllStudentPermits}} for a list of StudentPermits.
#' @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 Enrollment
#' @return Details of the modified StudentPermit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentPermit <- function(StudentPermitID, EntityID = 1, setDistrictID = NULL, setPermitID = 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("Enrollment", "StudentPermit", StudentPermitID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentPermit.
#'
#' This function creates a new StudentPermit.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created StudentPermit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentPermit <- function(EntityID = 1, setDistrictID = NULL, setPermitID = 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("Enrollment", "StudentPermit", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentPermit
#'
#' This function deletes a StudentPermit.
#'
#' @param StudentPermitID The id of the StudentPermit.\cr Run \code{\link{getAllStudentPermits}} for a list of StudentPermits.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted StudentPermit.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentPermit <- function(StudentPermitID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "StudentPermit", StudentPermitID, EntityID)
}
#' Get all StudentTypes.
#'
#' This function returns a dataframe of all StudentTypes 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 Enrollment
#' @return All StudentTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStudentTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStudentTypeID = 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("Enrollment", "StudentType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StudentType
#'
#' This function returns fields for a StudentType.
#'
#' @param StudentTypeID The id of the StudentType.\cr Run \code{\link{getAllStudentTypes}} for a list of StudentTypes.
#' @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 Enrollment
#' @return Details for the StudentType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStudentType <- function(StudentTypeID, EntityID = 1, returnStudentTypeID = 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("Enrollment", "StudentType", StudentTypeID, searchFields, EntityID)
}
#' Modify a specific StudentType
#'
#' This function modifies fields for a StudentType.
#'
#' @param StudentTypeID The id of the StudentType to be modified.\cr Run \code{\link{getAllStudentTypes}} for a list of StudentTypes.
#' @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 Enrollment
#' @return Details of the modified StudentType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStudentType <- function(StudentTypeID, 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("Enrollment", "StudentType", StudentTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new StudentType.
#'
#' This function creates a new StudentType.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created StudentType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStudentType <- 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("Enrollment", "StudentType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StudentType
#'
#' This function deletes a StudentType.
#'
#' @param StudentTypeID The id of the StudentType.\cr Run \code{\link{getAllStudentTypes}} for a list of StudentTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted StudentType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStudentType <- function(StudentTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "StudentType", StudentTypeID, EntityID)
}
#' Get all TempAffectedWithdrawalRecords.
#'
#' This function returns a dataframe of all TempAffectedWithdrawalRecords 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 Enrollment
#' @return All TempAffectedWithdrawalRecords in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempAffectedWithdrawalRecords <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempAffectedWithdrawalRecordID = F, returnAction = F, returnActionCode = F, returnActionMessage = F, returnAffectedPrimaryKey = F, returnCourseID = F, returnCreatedTime = F, returnDescription = F, returnEndDate = F, returnEntityID = F, returnHasAttendance = F, returnHasFutureAttendance = F, returnHasFutureGrades = F, returnHasGrades = F, returnHasPartiallyPaidFees = F, returnHasTransactionPreventingStudentSectionDelete = F, returnIsFutureEntryWithdrawal = F, returnModifiedTime = F, returnMostFutureGradeStartDate = F, returnNameIDRequestedBy = F, returnNewEndDate = F, returnParentPrimaryKey = F, returnRecordType = F, returnRecordTypeCode = F, returnSchoolYearID = F, returnSection = F, returnSectionID = 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("Enrollment", "TempAffectedWithdrawalRecord", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempAffectedWithdrawalRecord
#'
#' This function returns fields for a TempAffectedWithdrawalRecord.
#'
#' @param TempAffectedWithdrawalRecordID The id of the TempAffectedWithdrawalRecord.\cr Run \code{\link{getAllTempAffectedWithdrawalRecords}} for a list of TempAffectedWithdrawalRecords.
#' @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 Enrollment
#' @return Details for the TempAffectedWithdrawalRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempAffectedWithdrawalRecord <- function(TempAffectedWithdrawalRecordID, EntityID = 1, returnTempAffectedWithdrawalRecordID = F, returnAction = F, returnActionCode = F, returnActionMessage = F, returnAffectedPrimaryKey = F, returnCourseID = F, returnCreatedTime = F, returnDescription = F, returnEndDate = F, returnEntityID = F, returnHasAttendance = F, returnHasFutureAttendance = F, returnHasFutureGrades = F, returnHasGrades = F, returnHasPartiallyPaidFees = F, returnHasTransactionPreventingStudentSectionDelete = F, returnIsFutureEntryWithdrawal = F, returnModifiedTime = F, returnMostFutureGradeStartDate = F, returnNameIDRequestedBy = F, returnNewEndDate = F, returnParentPrimaryKey = F, returnRecordType = F, returnRecordTypeCode = F, returnSchoolYearID = F, returnSection = F, returnSectionID = 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("Enrollment", "TempAffectedWithdrawalRecord", TempAffectedWithdrawalRecordID, searchFields, EntityID)
}
#' Modify a specific TempAffectedWithdrawalRecord
#'
#' This function modifies fields for a TempAffectedWithdrawalRecord.
#'
#' @param TempAffectedWithdrawalRecordID The id of the TempAffectedWithdrawalRecord to be modified.\cr Run \code{\link{getAllTempAffectedWithdrawalRecords}} for a list of TempAffectedWithdrawalRecords.
#' @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 Enrollment
#' @return Details of the modified TempAffectedWithdrawalRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempAffectedWithdrawalRecord <- function(TempAffectedWithdrawalRecordID, EntityID = 1, setAction = NULL, setActionCode = NULL, setActionMessage = NULL, setAffectedPrimaryKey = NULL, setCourseID = NULL, setDescription = NULL, setEndDate = NULL, setEntityID = NULL, setHasAttendance = NULL, setHasFutureAttendance = NULL, setHasFutureGrades = NULL, setHasGrades = NULL, setHasPartiallyPaidFees = NULL, setHasTransactionPreventingStudentSectionDelete = NULL, setIsFutureEntryWithdrawal = NULL, setMostFutureGradeStartDate = NULL, setNameIDRequestedBy = NULL, setNewEndDate = NULL, setParentPrimaryKey = NULL, setRecordType = NULL, setRecordTypeCode = NULL, setSchoolYearID = NULL, setSection = NULL, setSectionID = 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("Enrollment", "TempAffectedWithdrawalRecord", TempAffectedWithdrawalRecordID, names(functionParams), functionParams, EntityID)
}
#' Create new TempAffectedWithdrawalRecord.
#'
#' This function creates a new TempAffectedWithdrawalRecord.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created TempAffectedWithdrawalRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempAffectedWithdrawalRecord <- function(EntityID = 1, setAction = NULL, setActionCode = NULL, setActionMessage = NULL, setAffectedPrimaryKey = NULL, setCourseID = NULL, setDescription = NULL, setEndDate = NULL, setEntityID = NULL, setHasAttendance = NULL, setHasFutureAttendance = NULL, setHasFutureGrades = NULL, setHasGrades = NULL, setHasPartiallyPaidFees = NULL, setHasTransactionPreventingStudentSectionDelete = NULL, setIsFutureEntryWithdrawal = NULL, setMostFutureGradeStartDate = NULL, setNameIDRequestedBy = NULL, setNewEndDate = NULL, setParentPrimaryKey = NULL, setRecordType = NULL, setRecordTypeCode = NULL, setSchoolYearID = NULL, setSection = NULL, setSectionID = 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("Enrollment", "TempAffectedWithdrawalRecord", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempAffectedWithdrawalRecord
#'
#' This function deletes a TempAffectedWithdrawalRecord.
#'
#' @param TempAffectedWithdrawalRecordID The id of the TempAffectedWithdrawalRecord.\cr Run \code{\link{getAllTempAffectedWithdrawalRecords}} for a list of TempAffectedWithdrawalRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted TempAffectedWithdrawalRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempAffectedWithdrawalRecord <- function(TempAffectedWithdrawalRecordID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "TempAffectedWithdrawalRecord", TempAffectedWithdrawalRecordID, EntityID)
}
#' Get all TempHomeroomErrors.
#'
#' This function returns a dataframe of all TempHomeroomErrors 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 Enrollment
#' @return All TempHomeroomErrors in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempHomeroomErrors <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempHomeroomErrorID = F, returnCode = F, returnCreatedTime = F, returnFailureReason = F, returnModifiedTime = F, returnTempHomeroomRecordID = 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("Enrollment", "TempHomeroomError", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempHomeroomError
#'
#' This function returns fields for a TempHomeroomError.
#'
#' @param TempHomeroomErrorID The id of the TempHomeroomError.\cr Run \code{\link{getAllTempHomeroomErrors}} for a list of TempHomeroomErrors.
#' @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 Enrollment
#' @return Details for the TempHomeroomError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempHomeroomError <- function(TempHomeroomErrorID, EntityID = 1, returnTempHomeroomErrorID = F, returnCode = F, returnCreatedTime = F, returnFailureReason = F, returnModifiedTime = F, returnTempHomeroomRecordID = 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("Enrollment", "TempHomeroomError", TempHomeroomErrorID, searchFields, EntityID)
}
#' Modify a specific TempHomeroomError
#'
#' This function modifies fields for a TempHomeroomError.
#'
#' @param TempHomeroomErrorID The id of the TempHomeroomError to be modified.\cr Run \code{\link{getAllTempHomeroomErrors}} for a list of TempHomeroomErrors.
#' @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 Enrollment
#' @return Details of the modified TempHomeroomError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempHomeroomError <- function(TempHomeroomErrorID, EntityID = 1, setCode = NULL, setFailureReason = NULL, setTempHomeroomRecordID = 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("Enrollment", "TempHomeroomError", TempHomeroomErrorID, names(functionParams), functionParams, EntityID)
}
#' Create new TempHomeroomError.
#'
#' This function creates a new TempHomeroomError.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created TempHomeroomError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempHomeroomError <- function(EntityID = 1, setCode = NULL, setFailureReason = NULL, setTempHomeroomRecordID = 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("Enrollment", "TempHomeroomError", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempHomeroomError
#'
#' This function deletes a TempHomeroomError.
#'
#' @param TempHomeroomErrorID The id of the TempHomeroomError.\cr Run \code{\link{getAllTempHomeroomErrors}} for a list of TempHomeroomErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted TempHomeroomError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempHomeroomError <- function(TempHomeroomErrorID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "TempHomeroomError", TempHomeroomErrorID, EntityID)
}
#' Get all TempHomeroomRecords.
#'
#' This function returns a dataframe of all TempHomeroomRecords 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 Enrollment
#' @return All TempHomeroomRecords in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempHomeroomRecords <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempHomeroomRecordID = F, returnBuilding = F, returnBuildingID = F, returnCode = F, returnColumnIndex = F, returnCreatedTime = F, returnHasSaveError = F, returnHomeroomID = F, returnIsOverwrite = F, returnModifiedTime = F, returnRoom = F, returnRoomID = F, returnSchoolYear = F, returnSchoolYearID = F, returnStaff = F, returnStaffID = 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("Enrollment", "TempHomeroomRecord", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempHomeroomRecord
#'
#' This function returns fields for a TempHomeroomRecord.
#'
#' @param TempHomeroomRecordID The id of the TempHomeroomRecord.\cr Run \code{\link{getAllTempHomeroomRecords}} for a list of TempHomeroomRecords.
#' @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 Enrollment
#' @return Details for the TempHomeroomRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempHomeroomRecord <- function(TempHomeroomRecordID, EntityID = 1, returnTempHomeroomRecordID = F, returnBuilding = F, returnBuildingID = F, returnCode = F, returnColumnIndex = F, returnCreatedTime = F, returnHasSaveError = F, returnHomeroomID = F, returnIsOverwrite = F, returnModifiedTime = F, returnRoom = F, returnRoomID = F, returnSchoolYear = F, returnSchoolYearID = F, returnStaff = F, returnStaffID = 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("Enrollment", "TempHomeroomRecord", TempHomeroomRecordID, searchFields, EntityID)
}
#' Modify a specific TempHomeroomRecord
#'
#' This function modifies fields for a TempHomeroomRecord.
#'
#' @param TempHomeroomRecordID The id of the TempHomeroomRecord to be modified.\cr Run \code{\link{getAllTempHomeroomRecords}} for a list of TempHomeroomRecords.
#' @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 Enrollment
#' @return Details of the modified TempHomeroomRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempHomeroomRecord <- function(TempHomeroomRecordID, EntityID = 1, setBuilding = NULL, setBuildingID = NULL, setCode = NULL, setColumnIndex = NULL, setHasSaveError = NULL, setHomeroomID = NULL, setIsOverwrite = NULL, setRoom = NULL, setRoomID = NULL, setSchoolYear = NULL, setSchoolYearID = NULL, setStaff = NULL, setStaffID = 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("Enrollment", "TempHomeroomRecord", TempHomeroomRecordID, names(functionParams), functionParams, EntityID)
}
#' Create new TempHomeroomRecord.
#'
#' This function creates a new TempHomeroomRecord.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created TempHomeroomRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempHomeroomRecord <- function(EntityID = 1, setBuilding = NULL, setBuildingID = NULL, setCode = NULL, setColumnIndex = NULL, setHasSaveError = NULL, setHomeroomID = NULL, setIsOverwrite = NULL, setRoom = NULL, setRoomID = NULL, setSchoolYear = NULL, setSchoolYearID = NULL, setStaff = NULL, setStaffID = 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("Enrollment", "TempHomeroomRecord", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempHomeroomRecord
#'
#' This function deletes a TempHomeroomRecord.
#'
#' @param TempHomeroomRecordID The id of the TempHomeroomRecord.\cr Run \code{\link{getAllTempHomeroomRecords}} for a list of TempHomeroomRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted TempHomeroomRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempHomeroomRecord <- function(TempHomeroomRecordID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "TempHomeroomRecord", TempHomeroomRecordID, EntityID)
}
#' Get all TempNameAddressMoveSchoolPathSchoolOverrides.
#'
#' This function returns a dataframe of all TempNameAddressMoveSchoolPathSchoolOverrides 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 Enrollment
#' @return All TempNameAddressMoveSchoolPathSchoolOverrides in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempNameAddressMoveSchoolPathSchoolOverrides <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempNameAddressMoveSchoolPathSchoolOverrideID = F, returnCreatedTime = F, returnIsCreateOverride = F, returnIsOverrideExists = F, returnIsRemoveOverride = F, returnIsRemovePermit = F, returnIsUpdateOverride = F, returnModifiedTime = F, returnOrder = F, returnPermitID = F, returnPermitSchoolYearID = F, returnSchoolID = F, returnSchoolNameOverriddingTo = F, returnSchoolNameToOverride = F, returnSchoolPathSchoolOverrideID = F, returnSchoolYearDescription = F, returnStudentFullNameLFM = 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("Enrollment", "TempNameAddressMoveSchoolPathSchoolOverride", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempNameAddressMoveSchoolPathSchoolOverride
#'
#' This function returns fields for a TempNameAddressMoveSchoolPathSchoolOverride.
#'
#' @param TempNameAddressMoveSchoolPathSchoolOverrideID The id of the TempNameAddressMoveSchoolPathSchoolOverride.\cr Run \code{\link{getAllTempNameAddressMoveSchoolPathSchoolOverrides}} for a list of TempNameAddressMoveSchoolPathSchoolOverrides.
#' @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 Enrollment
#' @return Details for the TempNameAddressMoveSchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempNameAddressMoveSchoolPathSchoolOverride <- function(TempNameAddressMoveSchoolPathSchoolOverrideID, EntityID = 1, returnTempNameAddressMoveSchoolPathSchoolOverrideID = F, returnCreatedTime = F, returnIsCreateOverride = F, returnIsOverrideExists = F, returnIsRemoveOverride = F, returnIsRemovePermit = F, returnIsUpdateOverride = F, returnModifiedTime = F, returnOrder = F, returnPermitID = F, returnPermitSchoolYearID = F, returnSchoolID = F, returnSchoolNameOverriddingTo = F, returnSchoolNameToOverride = F, returnSchoolPathSchoolOverrideID = F, returnSchoolYearDescription = F, returnStudentFullNameLFM = 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("Enrollment", "TempNameAddressMoveSchoolPathSchoolOverride", TempNameAddressMoveSchoolPathSchoolOverrideID, searchFields, EntityID)
}
#' Modify a specific TempNameAddressMoveSchoolPathSchoolOverride
#'
#' This function modifies fields for a TempNameAddressMoveSchoolPathSchoolOverride.
#'
#' @param TempNameAddressMoveSchoolPathSchoolOverrideID The id of the TempNameAddressMoveSchoolPathSchoolOverride to be modified.\cr Run \code{\link{getAllTempNameAddressMoveSchoolPathSchoolOverrides}} for a list of TempNameAddressMoveSchoolPathSchoolOverrides.
#' @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 Enrollment
#' @return Details of the modified TempNameAddressMoveSchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempNameAddressMoveSchoolPathSchoolOverride <- function(TempNameAddressMoveSchoolPathSchoolOverrideID, EntityID = 1, setIsCreateOverride = NULL, setIsOverrideExists = NULL, setIsRemoveOverride = NULL, setIsRemovePermit = NULL, setIsUpdateOverride = NULL, setOrder = NULL, setPermitID = NULL, setPermitSchoolYearID = NULL, setSchoolID = NULL, setSchoolNameOverriddingTo = NULL, setSchoolNameToOverride = NULL, setSchoolPathSchoolOverrideID = NULL, setSchoolYearDescription = NULL, setStudentFullNameLFM = 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("Enrollment", "TempNameAddressMoveSchoolPathSchoolOverride", TempNameAddressMoveSchoolPathSchoolOverrideID, names(functionParams), functionParams, EntityID)
}
#' Create new TempNameAddressMoveSchoolPathSchoolOverride.
#'
#' This function creates a new TempNameAddressMoveSchoolPathSchoolOverride.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created TempNameAddressMoveSchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempNameAddressMoveSchoolPathSchoolOverride <- function(EntityID = 1, setIsCreateOverride = NULL, setIsOverrideExists = NULL, setIsRemoveOverride = NULL, setIsRemovePermit = NULL, setIsUpdateOverride = NULL, setOrder = NULL, setPermitID = NULL, setPermitSchoolYearID = NULL, setSchoolID = NULL, setSchoolNameOverriddingTo = NULL, setSchoolNameToOverride = NULL, setSchoolPathSchoolOverrideID = NULL, setSchoolYearDescription = NULL, setStudentFullNameLFM = 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("Enrollment", "TempNameAddressMoveSchoolPathSchoolOverride", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempNameAddressMoveSchoolPathSchoolOverride
#'
#' This function deletes a TempNameAddressMoveSchoolPathSchoolOverride.
#'
#' @param TempNameAddressMoveSchoolPathSchoolOverrideID The id of the TempNameAddressMoveSchoolPathSchoolOverride.\cr Run \code{\link{getAllTempNameAddressMoveSchoolPathSchoolOverrides}} for a list of TempNameAddressMoveSchoolPathSchoolOverrides.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted TempNameAddressMoveSchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempNameAddressMoveSchoolPathSchoolOverride <- function(TempNameAddressMoveSchoolPathSchoolOverrideID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "TempNameAddressMoveSchoolPathSchoolOverride", TempNameAddressMoveSchoolPathSchoolOverrideID, EntityID)
}
#' Get all TempNoShowEntryWithdrawals.
#'
#' This function returns a dataframe of all TempNoShowEntryWithdrawals 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 Enrollment
#' @return All TempNoShowEntryWithdrawals in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempNoShowEntryWithdrawals <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempNoShowEntryWithdrawalID = F, returnAttemptToUpdateWithdrawalCode = F, returnCreatedTime = F, returnDisplayAction = F, returnDisplayActionCode = F, returnEndDate = F, returnEntity = F, returnEntryCode = F, returnEntryWithdrawalID = F, returnFailureReason = F, returnGradeLevel = F, returnModifiedTime = F, returnNoShowAction = F, returnNoShowActionCode = F, returnNoShowEntryWithdrawalType = F, returnNoShowEntryWithdrawalTypeCode = F, returnNoShowTypeOfNoShow = F, returnNoShowTypeOfNoShowCode = F, returnSchoolYear = F, returnSchoolYearID = F, returnStartDate = F, returnStudent = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalCode = F, returnWithdrawalCodeID = 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("Enrollment", "TempNoShowEntryWithdrawal", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempNoShowEntryWithdrawal
#'
#' This function returns fields for a TempNoShowEntryWithdrawal.
#'
#' @param TempNoShowEntryWithdrawalID The id of the TempNoShowEntryWithdrawal.\cr Run \code{\link{getAllTempNoShowEntryWithdrawals}} for a list of TempNoShowEntryWithdrawals.
#' @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 Enrollment
#' @return Details for the TempNoShowEntryWithdrawal.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempNoShowEntryWithdrawal <- function(TempNoShowEntryWithdrawalID, EntityID = 1, returnTempNoShowEntryWithdrawalID = F, returnAttemptToUpdateWithdrawalCode = F, returnCreatedTime = F, returnDisplayAction = F, returnDisplayActionCode = F, returnEndDate = F, returnEntity = F, returnEntryCode = F, returnEntryWithdrawalID = F, returnFailureReason = F, returnGradeLevel = F, returnModifiedTime = F, returnNoShowAction = F, returnNoShowActionCode = F, returnNoShowEntryWithdrawalType = F, returnNoShowEntryWithdrawalTypeCode = F, returnNoShowTypeOfNoShow = F, returnNoShowTypeOfNoShowCode = F, returnSchoolYear = F, returnSchoolYearID = F, returnStartDate = F, returnStudent = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalCode = F, returnWithdrawalCodeID = 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("Enrollment", "TempNoShowEntryWithdrawal", TempNoShowEntryWithdrawalID, searchFields, EntityID)
}
#' Modify a specific TempNoShowEntryWithdrawal
#'
#' This function modifies fields for a TempNoShowEntryWithdrawal.
#'
#' @param TempNoShowEntryWithdrawalID The id of the TempNoShowEntryWithdrawal to be modified.\cr Run \code{\link{getAllTempNoShowEntryWithdrawals}} for a list of TempNoShowEntryWithdrawals.
#' @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 Enrollment
#' @return Details of the modified TempNoShowEntryWithdrawal.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempNoShowEntryWithdrawal <- function(TempNoShowEntryWithdrawalID, EntityID = 1, setAttemptToUpdateWithdrawalCode = NULL, setDisplayAction = NULL, setDisplayActionCode = NULL, setEndDate = NULL, setEntity = NULL, setEntryCode = NULL, setEntryWithdrawalID = NULL, setFailureReason = NULL, setGradeLevel = NULL, setNoShowAction = NULL, setNoShowActionCode = NULL, setNoShowEntryWithdrawalType = NULL, setNoShowEntryWithdrawalTypeCode = NULL, setNoShowTypeOfNoShow = NULL, setNoShowTypeOfNoShowCode = NULL, setSchoolYear = NULL, setSchoolYearID = NULL, setStartDate = NULL, setStudent = NULL, setStudentID = NULL, setStudentNumber = NULL, setWithdrawalCode = NULL, setWithdrawalCodeID = 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("Enrollment", "TempNoShowEntryWithdrawal", TempNoShowEntryWithdrawalID, names(functionParams), functionParams, EntityID)
}
#' Create new TempNoShowEntryWithdrawal.
#'
#' This function creates a new TempNoShowEntryWithdrawal.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created TempNoShowEntryWithdrawal.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempNoShowEntryWithdrawal <- function(EntityID = 1, setAttemptToUpdateWithdrawalCode = NULL, setDisplayAction = NULL, setDisplayActionCode = NULL, setEndDate = NULL, setEntity = NULL, setEntryCode = NULL, setEntryWithdrawalID = NULL, setFailureReason = NULL, setGradeLevel = NULL, setNoShowAction = NULL, setNoShowActionCode = NULL, setNoShowEntryWithdrawalType = NULL, setNoShowEntryWithdrawalTypeCode = NULL, setNoShowTypeOfNoShow = NULL, setNoShowTypeOfNoShowCode = NULL, setSchoolYear = NULL, setSchoolYearID = NULL, setStartDate = NULL, setStudent = NULL, setStudentID = NULL, setStudentNumber = NULL, setWithdrawalCode = NULL, setWithdrawalCodeID = 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("Enrollment", "TempNoShowEntryWithdrawal", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempNoShowEntryWithdrawal
#'
#' This function deletes a TempNoShowEntryWithdrawal.
#'
#' @param TempNoShowEntryWithdrawalID The id of the TempNoShowEntryWithdrawal.\cr Run \code{\link{getAllTempNoShowEntryWithdrawals}} for a list of TempNoShowEntryWithdrawals.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted TempNoShowEntryWithdrawal.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempNoShowEntryWithdrawal <- function(TempNoShowEntryWithdrawalID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "TempNoShowEntryWithdrawal", TempNoShowEntryWithdrawalID, EntityID)
}
#' Get all TempSchoolPathSchoolOverrides.
#'
#' This function returns a dataframe of all TempSchoolPathSchoolOverrides 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 Enrollment
#' @return All TempSchoolPathSchoolOverrides in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempSchoolPathSchoolOverrides <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempSchoolPathSchoolOverrideID = F, returnCreatedTime = F, returnDistrictID = F, returnExceptionNote = F, returnHasExceptions = F, returnModifiedTime = F, returnOrder = F, returnPermitCodeDescription = F, returnPermitID = F, returnSchoolCodeName = F, returnSchoolID = F, returnSchoolIDClonedTo = F, returnSchoolYearID = F, returnStudentID = F, returnStudentName = 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("Enrollment", "TempSchoolPathSchoolOverride", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempSchoolPathSchoolOverride
#'
#' This function returns fields for a TempSchoolPathSchoolOverride.
#'
#' @param TempSchoolPathSchoolOverrideID The id of the TempSchoolPathSchoolOverride.\cr Run \code{\link{getAllTempSchoolPathSchoolOverrides}} for a list of TempSchoolPathSchoolOverrides.
#' @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 Enrollment
#' @return Details for the TempSchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempSchoolPathSchoolOverride <- function(TempSchoolPathSchoolOverrideID, EntityID = 1, returnTempSchoolPathSchoolOverrideID = F, returnCreatedTime = F, returnDistrictID = F, returnExceptionNote = F, returnHasExceptions = F, returnModifiedTime = F, returnOrder = F, returnPermitCodeDescription = F, returnPermitID = F, returnSchoolCodeName = F, returnSchoolID = F, returnSchoolIDClonedTo = F, returnSchoolYearID = F, returnStudentID = F, returnStudentName = 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("Enrollment", "TempSchoolPathSchoolOverride", TempSchoolPathSchoolOverrideID, searchFields, EntityID)
}
#' Modify a specific TempSchoolPathSchoolOverride
#'
#' This function modifies fields for a TempSchoolPathSchoolOverride.
#'
#' @param TempSchoolPathSchoolOverrideID The id of the TempSchoolPathSchoolOverride to be modified.\cr Run \code{\link{getAllTempSchoolPathSchoolOverrides}} for a list of TempSchoolPathSchoolOverrides.
#' @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 Enrollment
#' @return Details of the modified TempSchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempSchoolPathSchoolOverride <- function(TempSchoolPathSchoolOverrideID, EntityID = 1, setDistrictID = NULL, setExceptionNote = NULL, setHasExceptions = NULL, setOrder = NULL, setPermitCodeDescription = NULL, setPermitID = NULL, setSchoolCodeName = NULL, setSchoolID = NULL, setSchoolIDClonedTo = NULL, setSchoolYearID = NULL, setStudentID = NULL, setStudentName = 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("Enrollment", "TempSchoolPathSchoolOverride", TempSchoolPathSchoolOverrideID, names(functionParams), functionParams, EntityID)
}
#' Create new TempSchoolPathSchoolOverride.
#'
#' This function creates a new TempSchoolPathSchoolOverride.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created TempSchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempSchoolPathSchoolOverride <- function(EntityID = 1, setDistrictID = NULL, setExceptionNote = NULL, setHasExceptions = NULL, setOrder = NULL, setPermitCodeDescription = NULL, setPermitID = NULL, setSchoolCodeName = NULL, setSchoolID = NULL, setSchoolIDClonedTo = NULL, setSchoolYearID = NULL, setStudentID = NULL, setStudentName = 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("Enrollment", "TempSchoolPathSchoolOverride", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempSchoolPathSchoolOverride
#'
#' This function deletes a TempSchoolPathSchoolOverride.
#'
#' @param TempSchoolPathSchoolOverrideID The id of the TempSchoolPathSchoolOverride.\cr Run \code{\link{getAllTempSchoolPathSchoolOverrides}} for a list of TempSchoolPathSchoolOverrides.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted TempSchoolPathSchoolOverride.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempSchoolPathSchoolOverride <- function(TempSchoolPathSchoolOverrideID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "TempSchoolPathSchoolOverride", TempSchoolPathSchoolOverrideID, EntityID)
}
#' Get all TempStudentEnrollmentErrors.
#'
#' This function returns a dataframe of all TempStudentEnrollmentErrors 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 Enrollment
#' @return All TempStudentEnrollmentErrors in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentEnrollmentErrors <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentEnrollmentErrorID = F, returnCreatedTime = F, returnError = F, returnErrorCount = F, returnErrorDetail = F, returnModifiedTime = F, returnTempStudentEnrollmentRecordID = 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("Enrollment", "TempStudentEnrollmentError", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentEnrollmentError
#'
#' This function returns fields for a TempStudentEnrollmentError.
#'
#' @param TempStudentEnrollmentErrorID The id of the TempStudentEnrollmentError.\cr Run \code{\link{getAllTempStudentEnrollmentErrors}} for a list of TempStudentEnrollmentErrors.
#' @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 Enrollment
#' @return Details for the TempStudentEnrollmentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentEnrollmentError <- function(TempStudentEnrollmentErrorID, EntityID = 1, returnTempStudentEnrollmentErrorID = F, returnCreatedTime = F, returnError = F, returnErrorCount = F, returnErrorDetail = F, returnModifiedTime = F, returnTempStudentEnrollmentRecordID = 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("Enrollment", "TempStudentEnrollmentError", TempStudentEnrollmentErrorID, searchFields, EntityID)
}
#' Modify a specific TempStudentEnrollmentError
#'
#' This function modifies fields for a TempStudentEnrollmentError.
#'
#' @param TempStudentEnrollmentErrorID The id of the TempStudentEnrollmentError to be modified.\cr Run \code{\link{getAllTempStudentEnrollmentErrors}} for a list of TempStudentEnrollmentErrors.
#' @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 Enrollment
#' @return Details of the modified TempStudentEnrollmentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentEnrollmentError <- function(TempStudentEnrollmentErrorID, EntityID = 1, setError = NULL, setErrorCount = NULL, setErrorDetail = NULL, setTempStudentEnrollmentRecordID = 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("Enrollment", "TempStudentEnrollmentError", TempStudentEnrollmentErrorID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentEnrollmentError.
#'
#' This function creates a new TempStudentEnrollmentError.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created TempStudentEnrollmentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentEnrollmentError <- function(EntityID = 1, setError = NULL, setErrorCount = NULL, setErrorDetail = NULL, setTempStudentEnrollmentRecordID = 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("Enrollment", "TempStudentEnrollmentError", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentEnrollmentError
#'
#' This function deletes a TempStudentEnrollmentError.
#'
#' @param TempStudentEnrollmentErrorID The id of the TempStudentEnrollmentError.\cr Run \code{\link{getAllTempStudentEnrollmentErrors}} for a list of TempStudentEnrollmentErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted TempStudentEnrollmentError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentEnrollmentError <- function(TempStudentEnrollmentErrorID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "TempStudentEnrollmentError", TempStudentEnrollmentErrorID, EntityID)
}
#' Get all TempStudentEnrollmentRecords.
#'
#' This function returns a dataframe of all TempStudentEnrollmentRecords 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 Enrollment
#' @return All TempStudentEnrollmentRecords in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentEnrollmentRecords <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentEnrollmentRecordID = F, returnAdvisorFullName = F, returnCalendarCode = F, returnCalendarID = F, returnCompletedSchoolYearOverride = F, returnCreatedTime = F, returnCreateFeeManagementCustomer = F, returnCreateFeeManagementCustomerEntityYear = F, returnDisciplineOfficerFullName = F, returnEdFiDistrictIDResidence = F, returnEdFiDistrictIDTransfer = F, returnEdFiDistrictResidenceCodeDescription = F, returnEdFiSchoolIDTransfer = F, returnEndDate = F, returnEnrollIntoEntityCode = F, returnEnrollmentMoveable = F, returnEntityCode = F, returnEntityID = F, returnEntryCode = F, returnEntryCodeID = F, returnEntryComment = F, returnEntryWithdrawalID = F, returnError = F, returnErrorCount = F, returnExcludeFromHonorRoll = F, returnExcludeFromRank = F, returnExcludeFromThirdFridaySeptemberCount = F, returnFailureReason = F, returnFeeManagementCustomerID = F, returnGradeLevelCode = F, returnGradeReferenceID = F, returnGradYear = F, returnGSAADAClaimableOverrideCode = F, returnGSAADAClaimableOverrideCodeDisplayName = F, returnHomeroomCode = F, returnHomeroomID = F, returnIncludeAsProspectiveRank = F, returnIsCurrentActive = F, returnIsDefaultEntityForEntryWithdrawal = F, returnIsDefaultEntityForStudentEntityYear = F, returnIsPermanentExit = F, returnIsPrivateSchoolChoiceStudent = F, returnIsTuitionPaidOutOfDistrict = F, returnModifiedTime = F, returnNumericYear = F, returnOutgoingStudent = F, returnPercentEnrolled = F, returnProcessEntryWithdrawal = F, returnPromotionStatus = F, returnPromotionStatusCode = F, returnScheduledSectionCount = F, returnSchoolCode = F, returnSchoolID = F, returnSchoolYearID = F, returnServingRCDTSOverrideCode = F, returnServingRCDTSOverrideCodeDisplayName = F, returnServingRCDTSOverrideID = F, returnSourceEntryWithdrawalID = F, returnStaffIDAdvisor = F, returnStaffIDDisciplineOfficer = F, returnStartDate = F, returnStateAidCategoryMNID = F, returnStateDistrictMNCodeName = F, returnStateDistrictMNID = F, returnStateLastAttendanceLocationCodeMNID = F, returnStudentCourseRequestNotMoveableCount = F, returnStudentCourseRequestToDeleteCount = F, returnStudentFullName = F, returnStudentID = F, returnStudentNumber = F, returnStudentTypeCode = F, returnStudentTypeID = F, returnTestingSchoolCode = F, returnTestingSchoolCodeDisplayName = F, returnTestingSchoolRCDTSOverrideCode = F, returnTestingSchoolRCDTSOverrideCodeDisplayName = F, returnTestingSchoolRCDTSOverrideID = F, returnTotalStudentCourseRequestCount = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalCode = F, returnWithdrawalCodeID = F, returnWithdrawalComment = 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("Enrollment", "TempStudentEnrollmentRecord", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentEnrollmentRecord
#'
#' This function returns fields for a TempStudentEnrollmentRecord.
#'
#' @param TempStudentEnrollmentRecordID The id of the TempStudentEnrollmentRecord.\cr Run \code{\link{getAllTempStudentEnrollmentRecords}} for a list of TempStudentEnrollmentRecords.
#' @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 Enrollment
#' @return Details for the TempStudentEnrollmentRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentEnrollmentRecord <- function(TempStudentEnrollmentRecordID, EntityID = 1, returnTempStudentEnrollmentRecordID = F, returnAdvisorFullName = F, returnCalendarCode = F, returnCalendarID = F, returnCompletedSchoolYearOverride = F, returnCreatedTime = F, returnCreateFeeManagementCustomer = F, returnCreateFeeManagementCustomerEntityYear = F, returnDisciplineOfficerFullName = F, returnEdFiDistrictIDResidence = F, returnEdFiDistrictIDTransfer = F, returnEdFiDistrictResidenceCodeDescription = F, returnEdFiSchoolIDTransfer = F, returnEndDate = F, returnEnrollIntoEntityCode = F, returnEnrollmentMoveable = F, returnEntityCode = F, returnEntityID = F, returnEntryCode = F, returnEntryCodeID = F, returnEntryComment = F, returnEntryWithdrawalID = F, returnError = F, returnErrorCount = F, returnExcludeFromHonorRoll = F, returnExcludeFromRank = F, returnExcludeFromThirdFridaySeptemberCount = F, returnFailureReason = F, returnFeeManagementCustomerID = F, returnGradeLevelCode = F, returnGradeReferenceID = F, returnGradYear = F, returnGSAADAClaimableOverrideCode = F, returnGSAADAClaimableOverrideCodeDisplayName = F, returnHomeroomCode = F, returnHomeroomID = F, returnIncludeAsProspectiveRank = F, returnIsCurrentActive = F, returnIsDefaultEntityForEntryWithdrawal = F, returnIsDefaultEntityForStudentEntityYear = F, returnIsPermanentExit = F, returnIsPrivateSchoolChoiceStudent = F, returnIsTuitionPaidOutOfDistrict = F, returnModifiedTime = F, returnNumericYear = F, returnOutgoingStudent = F, returnPercentEnrolled = F, returnProcessEntryWithdrawal = F, returnPromotionStatus = F, returnPromotionStatusCode = F, returnScheduledSectionCount = F, returnSchoolCode = F, returnSchoolID = F, returnSchoolYearID = F, returnServingRCDTSOverrideCode = F, returnServingRCDTSOverrideCodeDisplayName = F, returnServingRCDTSOverrideID = F, returnSourceEntryWithdrawalID = F, returnStaffIDAdvisor = F, returnStaffIDDisciplineOfficer = F, returnStartDate = F, returnStateAidCategoryMNID = F, returnStateDistrictMNCodeName = F, returnStateDistrictMNID = F, returnStateLastAttendanceLocationCodeMNID = F, returnStudentCourseRequestNotMoveableCount = F, returnStudentCourseRequestToDeleteCount = F, returnStudentFullName = F, returnStudentID = F, returnStudentNumber = F, returnStudentTypeCode = F, returnStudentTypeID = F, returnTestingSchoolCode = F, returnTestingSchoolCodeDisplayName = F, returnTestingSchoolRCDTSOverrideCode = F, returnTestingSchoolRCDTSOverrideCodeDisplayName = F, returnTestingSchoolRCDTSOverrideID = F, returnTotalStudentCourseRequestCount = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalCode = F, returnWithdrawalCodeID = F, returnWithdrawalComment = 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("Enrollment", "TempStudentEnrollmentRecord", TempStudentEnrollmentRecordID, searchFields, EntityID)
}
#' Modify a specific TempStudentEnrollmentRecord
#'
#' This function modifies fields for a TempStudentEnrollmentRecord.
#'
#' @param TempStudentEnrollmentRecordID The id of the TempStudentEnrollmentRecord to be modified.\cr Run \code{\link{getAllTempStudentEnrollmentRecords}} for a list of TempStudentEnrollmentRecords.
#' @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 Enrollment
#' @return Details of the modified TempStudentEnrollmentRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentEnrollmentRecord <- function(TempStudentEnrollmentRecordID, EntityID = 1, setAdvisorFullName = NULL, setCalendarCode = NULL, setCalendarID = NULL, setCompletedSchoolYearOverride = NULL, setCreateFeeManagementCustomer = NULL, setCreateFeeManagementCustomerEntityYear = NULL, setDisciplineOfficerFullName = NULL, setEdFiDistrictIDResidence = NULL, setEdFiDistrictIDTransfer = NULL, setEdFiDistrictResidenceCodeDescription = NULL, setEdFiSchoolIDTransfer = NULL, setEndDate = NULL, setEnrollIntoEntityCode = NULL, setEnrollmentMoveable = NULL, setEntityCode = NULL, setEntityID = NULL, setEntryCode = NULL, setEntryCodeID = NULL, setEntryComment = NULL, setEntryWithdrawalID = NULL, setError = NULL, setErrorCount = NULL, setExcludeFromHonorRoll = NULL, setExcludeFromRank = NULL, setExcludeFromThirdFridaySeptemberCount = NULL, setFailureReason = NULL, setFeeManagementCustomerID = NULL, setGradeLevelCode = NULL, setGradeReferenceID = NULL, setGradYear = NULL, setGSAADAClaimableOverrideCode = NULL, setGSAADAClaimableOverrideCodeDisplayName = NULL, setHomeroomCode = NULL, setHomeroomID = NULL, setIncludeAsProspectiveRank = NULL, setIsCurrentActive = NULL, setIsDefaultEntityForEntryWithdrawal = NULL, setIsDefaultEntityForStudentEntityYear = NULL, setIsPermanentExit = NULL, setIsPrivateSchoolChoiceStudent = NULL, setIsTuitionPaidOutOfDistrict = NULL, setNumericYear = NULL, setOutgoingStudent = NULL, setPercentEnrolled = NULL, setProcessEntryWithdrawal = NULL, setPromotionStatus = NULL, setPromotionStatusCode = NULL, setScheduledSectionCount = NULL, setSchoolCode = NULL, setSchoolID = NULL, setSchoolYearID = NULL, setServingRCDTSOverrideCode = NULL, setServingRCDTSOverrideCodeDisplayName = NULL, setServingRCDTSOverrideID = NULL, setSourceEntryWithdrawalID = NULL, setStaffIDAdvisor = NULL, setStaffIDDisciplineOfficer = NULL, setStartDate = NULL, setStateAidCategoryMNID = NULL, setStateDistrictMNCodeName = NULL, setStateDistrictMNID = NULL, setStateLastAttendanceLocationCodeMNID = NULL, setStudentCourseRequestNotMoveableCount = NULL, setStudentCourseRequestToDeleteCount = NULL, setStudentFullName = NULL, setStudentID = NULL, setStudentNumber = NULL, setStudentTypeCode = NULL, setStudentTypeID = NULL, setTestingSchoolCode = NULL, setTestingSchoolCodeDisplayName = NULL, setTestingSchoolRCDTSOverrideCode = NULL, setTestingSchoolRCDTSOverrideCodeDisplayName = NULL, setTestingSchoolRCDTSOverrideID = NULL, setTotalStudentCourseRequestCount = NULL, setWithdrawalCode = NULL, setWithdrawalCodeID = NULL, setWithdrawalComment = 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("Enrollment", "TempStudentEnrollmentRecord", TempStudentEnrollmentRecordID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentEnrollmentRecord.
#'
#' This function creates a new TempStudentEnrollmentRecord.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created TempStudentEnrollmentRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentEnrollmentRecord <- function(EntityID = 1, setAdvisorFullName = NULL, setCalendarCode = NULL, setCalendarID = NULL, setCompletedSchoolYearOverride = NULL, setCreateFeeManagementCustomer = NULL, setCreateFeeManagementCustomerEntityYear = NULL, setDisciplineOfficerFullName = NULL, setEdFiDistrictIDResidence = NULL, setEdFiDistrictIDTransfer = NULL, setEdFiDistrictResidenceCodeDescription = NULL, setEdFiSchoolIDTransfer = NULL, setEndDate = NULL, setEnrollIntoEntityCode = NULL, setEnrollmentMoveable = NULL, setEntityCode = NULL, setEntityID = NULL, setEntryCode = NULL, setEntryCodeID = NULL, setEntryComment = NULL, setEntryWithdrawalID = NULL, setError = NULL, setErrorCount = NULL, setExcludeFromHonorRoll = NULL, setExcludeFromRank = NULL, setExcludeFromThirdFridaySeptemberCount = NULL, setFailureReason = NULL, setFeeManagementCustomerID = NULL, setGradeLevelCode = NULL, setGradeReferenceID = NULL, setGradYear = NULL, setGSAADAClaimableOverrideCode = NULL, setGSAADAClaimableOverrideCodeDisplayName = NULL, setHomeroomCode = NULL, setHomeroomID = NULL, setIncludeAsProspectiveRank = NULL, setIsCurrentActive = NULL, setIsDefaultEntityForEntryWithdrawal = NULL, setIsDefaultEntityForStudentEntityYear = NULL, setIsPermanentExit = NULL, setIsPrivateSchoolChoiceStudent = NULL, setIsTuitionPaidOutOfDistrict = NULL, setNumericYear = NULL, setOutgoingStudent = NULL, setPercentEnrolled = NULL, setProcessEntryWithdrawal = NULL, setPromotionStatus = NULL, setPromotionStatusCode = NULL, setScheduledSectionCount = NULL, setSchoolCode = NULL, setSchoolID = NULL, setSchoolYearID = NULL, setServingRCDTSOverrideCode = NULL, setServingRCDTSOverrideCodeDisplayName = NULL, setServingRCDTSOverrideID = NULL, setSourceEntryWithdrawalID = NULL, setStaffIDAdvisor = NULL, setStaffIDDisciplineOfficer = NULL, setStartDate = NULL, setStateAidCategoryMNID = NULL, setStateDistrictMNCodeName = NULL, setStateDistrictMNID = NULL, setStateLastAttendanceLocationCodeMNID = NULL, setStudentCourseRequestNotMoveableCount = NULL, setStudentCourseRequestToDeleteCount = NULL, setStudentFullName = NULL, setStudentID = NULL, setStudentNumber = NULL, setStudentTypeCode = NULL, setStudentTypeID = NULL, setTestingSchoolCode = NULL, setTestingSchoolCodeDisplayName = NULL, setTestingSchoolRCDTSOverrideCode = NULL, setTestingSchoolRCDTSOverrideCodeDisplayName = NULL, setTestingSchoolRCDTSOverrideID = NULL, setTotalStudentCourseRequestCount = NULL, setWithdrawalCode = NULL, setWithdrawalCodeID = NULL, setWithdrawalComment = 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("Enrollment", "TempStudentEnrollmentRecord", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentEnrollmentRecord
#'
#' This function deletes a TempStudentEnrollmentRecord.
#'
#' @param TempStudentEnrollmentRecordID The id of the TempStudentEnrollmentRecord.\cr Run \code{\link{getAllTempStudentEnrollmentRecords}} for a list of TempStudentEnrollmentRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted TempStudentEnrollmentRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentEnrollmentRecord <- function(TempStudentEnrollmentRecordID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "TempStudentEnrollmentRecord", TempStudentEnrollmentRecordID, EntityID)
}
#' Get all TempStudentEntityYears.
#'
#' This function returns a dataframe of all TempStudentEntityYears 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 Enrollment
#' @return All TempStudentEntityYears in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentEntityYears <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentEntityYearID = F, returnAdvisorDetails = F, returnCreatedTime = F, returnCurrentAdvisorDetails = F, returnCurrentHomeroomDetails = F, returnGenderCode = F, returnGradeLevelCodeDescription = F, returnHomeroomDetails = F, returnHomeroomID = F, returnIsActive = F, returnMessage = F, returnModifiedTime = F, returnStaffIDAdvisor = F, returnStudentEntityYearID = F, returnStudentFullName = 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("Enrollment", "TempStudentEntityYear", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentEntityYear
#'
#' This function returns fields for a TempStudentEntityYear.
#'
#' @param TempStudentEntityYearID The id of the TempStudentEntityYear.\cr Run \code{\link{getAllTempStudentEntityYears}} for a list of TempStudentEntityYears.
#' @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 Enrollment
#' @return Details for the TempStudentEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentEntityYear <- function(TempStudentEntityYearID, EntityID = 1, returnTempStudentEntityYearID = F, returnAdvisorDetails = F, returnCreatedTime = F, returnCurrentAdvisorDetails = F, returnCurrentHomeroomDetails = F, returnGenderCode = F, returnGradeLevelCodeDescription = F, returnHomeroomDetails = F, returnHomeroomID = F, returnIsActive = F, returnMessage = F, returnModifiedTime = F, returnStaffIDAdvisor = F, returnStudentEntityYearID = F, returnStudentFullName = 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("Enrollment", "TempStudentEntityYear", TempStudentEntityYearID, searchFields, EntityID)
}
#' Modify a specific TempStudentEntityYear
#'
#' This function modifies fields for a TempStudentEntityYear.
#'
#' @param TempStudentEntityYearID The id of the TempStudentEntityYear to be modified.\cr Run \code{\link{getAllTempStudentEntityYears}} for a list of TempStudentEntityYears.
#' @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 Enrollment
#' @return Details of the modified TempStudentEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentEntityYear <- function(TempStudentEntityYearID, EntityID = 1, setAdvisorDetails = NULL, setCurrentAdvisorDetails = NULL, setCurrentHomeroomDetails = NULL, setGenderCode = NULL, setGradeLevelCodeDescription = NULL, setHomeroomDetails = NULL, setHomeroomID = NULL, setIsActive = NULL, setMessage = NULL, setStaffIDAdvisor = NULL, setStudentEntityYearID = NULL, setStudentFullName = 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("Enrollment", "TempStudentEntityYear", TempStudentEntityYearID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentEntityYear.
#'
#' This function creates a new TempStudentEntityYear.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created TempStudentEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentEntityYear <- function(EntityID = 1, setAdvisorDetails = NULL, setCurrentAdvisorDetails = NULL, setCurrentHomeroomDetails = NULL, setGenderCode = NULL, setGradeLevelCodeDescription = NULL, setHomeroomDetails = NULL, setHomeroomID = NULL, setIsActive = NULL, setMessage = NULL, setStaffIDAdvisor = NULL, setStudentEntityYearID = NULL, setStudentFullName = 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("Enrollment", "TempStudentEntityYear", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentEntityYear
#'
#' This function deletes a TempStudentEntityYear.
#'
#' @param TempStudentEntityYearID The id of the TempStudentEntityYear.\cr Run \code{\link{getAllTempStudentEntityYears}} for a list of TempStudentEntityYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted TempStudentEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentEntityYear <- function(TempStudentEntityYearID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "TempStudentEntityYear", TempStudentEntityYearID, EntityID)
}
#' Get all WithdrawalCodes.
#'
#' This function returns a dataframe of all WithdrawalCodes 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 Enrollment
#' @return All WithdrawalCodes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllWithdrawalCodes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnWithdrawalCodeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnEdFiExitWithdrawID = F, returnIsCrossEntityCourseEnrollment = F, returnModifiedTime = F, returnSchoolYearID = F, returnStateStatusEndCodeMNID = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalCodeIDClonedFrom = F, returnWithdrawalCodeMNID = 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("Enrollment", "WithdrawalCode", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific WithdrawalCode
#'
#' This function returns fields for a WithdrawalCode.
#'
#' @param WithdrawalCodeID The id of the WithdrawalCode.\cr Run \code{\link{getAllWithdrawalCodes}} for a list of WithdrawalCodes.
#' @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 Enrollment
#' @return Details for the WithdrawalCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getWithdrawalCode <- function(WithdrawalCodeID, EntityID = 1, returnWithdrawalCodeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnEdFiExitWithdrawID = F, returnIsCrossEntityCourseEnrollment = F, returnModifiedTime = F, returnSchoolYearID = F, returnStateStatusEndCodeMNID = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithdrawalCodeIDClonedFrom = F, returnWithdrawalCodeMNID = 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("Enrollment", "WithdrawalCode", WithdrawalCodeID, searchFields, EntityID)
}
#' Modify a specific WithdrawalCode
#'
#' This function modifies fields for a WithdrawalCode.
#'
#' @param WithdrawalCodeID The id of the WithdrawalCode to be modified.\cr Run \code{\link{getAllWithdrawalCodes}} for a list of WithdrawalCodes.
#' @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 Enrollment
#' @return Details of the modified WithdrawalCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyWithdrawalCode <- function(WithdrawalCodeID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setEdFiExitWithdrawID = NULL, setIsCrossEntityCourseEnrollment = NULL, setSchoolYearID = NULL, setStateStatusEndCodeMNID = NULL, setType = NULL, setTypeCode = NULL, setWithdrawalCodeIDClonedFrom = 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("Enrollment", "WithdrawalCode", WithdrawalCodeID, names(functionParams), functionParams, EntityID)
}
#' Create new WithdrawalCode.
#'
#' This function creates a new WithdrawalCode.
#'
#' @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 Enrollment
#' @return The fields used to define the newly created WithdrawalCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createWithdrawalCode <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setEdFiExitWithdrawID = NULL, setIsCrossEntityCourseEnrollment = NULL, setSchoolYearID = NULL, setStateStatusEndCodeMNID = NULL, setType = NULL, setTypeCode = NULL, setWithdrawalCodeIDClonedFrom = 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("Enrollment", "WithdrawalCode", names(functionParams), functionParams, EntityID)
}
#' Delete a specific WithdrawalCode
#'
#' This function deletes a WithdrawalCode.
#'
#' @param WithdrawalCodeID The id of the WithdrawalCode.\cr Run \code{\link{getAllWithdrawalCodes}} for a list of WithdrawalCodes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Enrollment
#' @return The id of the deleted WithdrawalCode.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteWithdrawalCode <- function(WithdrawalCodeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Enrollment", "WithdrawalCode", WithdrawalCodeID, EntityID)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.