#' Get all AcademicStandards.
#'
#' This function returns a dataframe of all AcademicStandards 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 Curriculum
#' @return All AcademicStandards in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAcademicStandards <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAcademicStandardID = F, returnAcademicStandardDefaultID = F, returnAcademicStandardGradeRangeID = F, returnAcademicStandardIDParent = F, returnBackgroundColor = F, returnChildAcademicStandardCount = F, returnCreatedTime = F, returnDescription = F, returnDescriptionToUse = F, returnDisplayAs = F, returnDistrictGroupKey = F, returnEnteredByDistrict = F, returnExtendedDescription = F, returnFullKey = F, returnFullKeyPrefix = F, returnGrandChildLevelHierarchyDepthDescription = F, returnGuid = F, returnHierarchyDepthDescription = F, returnIsAttachedToASubject = F, returnIsHighFrequencyWord = F, returnIsLettersAndSounds = F, returnIsPlaceHolder = F, returnKey = F, returnLabel = F, returnLetterAndSoundType = F, returnLetterAndSoundTypeCode = F, returnLetterType = F, returnLetterTypeCode = F, returnLevel = F, returnModifiedTime = F, returnNextLevelHierarchyDepthDescription = F, returnParentGuid = F, returnSequence = F, returnStateNumber = F, returnTextColor = 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("Curriculum", "AcademicStandard", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AcademicStandard
#'
#' This function returns fields for an AcademicStandard.
#'
#' @param AcademicStandardID The id of the AcademicStandard.\cr Run \code{\link{getAllAcademicStandards}} for a list of AcademicStandards.
#' @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 Curriculum
#' @return Details for the AcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAcademicStandard <- function(AcademicStandardID, EntityID = 1, returnAcademicStandardID = F, returnAcademicStandardDefaultID = F, returnAcademicStandardGradeRangeID = F, returnAcademicStandardIDParent = F, returnBackgroundColor = F, returnChildAcademicStandardCount = F, returnCreatedTime = F, returnDescription = F, returnDescriptionToUse = F, returnDisplayAs = F, returnDistrictGroupKey = F, returnEnteredByDistrict = F, returnExtendedDescription = F, returnFullKey = F, returnFullKeyPrefix = F, returnGrandChildLevelHierarchyDepthDescription = F, returnGuid = F, returnHierarchyDepthDescription = F, returnIsAttachedToASubject = F, returnIsHighFrequencyWord = F, returnIsLettersAndSounds = F, returnIsPlaceHolder = F, returnKey = F, returnLabel = F, returnLetterAndSoundType = F, returnLetterAndSoundTypeCode = F, returnLetterType = F, returnLetterTypeCode = F, returnLevel = F, returnModifiedTime = F, returnNextLevelHierarchyDepthDescription = F, returnParentGuid = F, returnSequence = F, returnStateNumber = F, returnTextColor = 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("Curriculum", "AcademicStandard", AcademicStandardID, searchFields, EntityID)
}
#' Modify a specific AcademicStandard
#'
#' This function modifies fields for an AcademicStandard.
#'
#' @param AcademicStandardID The id of the AcademicStandard to be modified.\cr Run \code{\link{getAllAcademicStandards}} for a list of AcademicStandards.
#' @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 Curriculum
#' @return Details of the modified AcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAcademicStandard <- function(AcademicStandardID, EntityID = 1, setAcademicStandardDefaultID = NULL, setAcademicStandardGradeRangeID = NULL, setAcademicStandardIDParent = NULL, setBackgroundColor = NULL, setDescription = NULL, setDescriptionToUse = NULL, setDisplayAs = NULL, setDistrictGroupKey = NULL, setEnteredByDistrict = NULL, setExtendedDescription = NULL, setGuid = NULL, setIsHighFrequencyWord = NULL, setIsLettersAndSounds = NULL, setIsPlaceHolder = NULL, setKey = NULL, setLabel = NULL, setLetterAndSoundType = NULL, setLetterAndSoundTypeCode = NULL, setLetterType = NULL, setLetterTypeCode = NULL, setLevel = NULL, setParentGuid = NULL, setSequence = NULL, setStateNumber = NULL, setTextColor = 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("Curriculum", "AcademicStandard", AcademicStandardID, names(functionParams), functionParams, EntityID)
}
#' Create new AcademicStandard.
#'
#' This function creates a new AcademicStandard.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created AcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAcademicStandard <- function(EntityID = 1, setAcademicStandardDefaultID = NULL, setAcademicStandardGradeRangeID = NULL, setAcademicStandardIDParent = NULL, setBackgroundColor = NULL, setDescription = NULL, setDescriptionToUse = NULL, setDisplayAs = NULL, setDistrictGroupKey = NULL, setEnteredByDistrict = NULL, setExtendedDescription = NULL, setGuid = NULL, setIsHighFrequencyWord = NULL, setIsLettersAndSounds = NULL, setIsPlaceHolder = NULL, setKey = NULL, setLabel = NULL, setLetterAndSoundType = NULL, setLetterAndSoundTypeCode = NULL, setLetterType = NULL, setLetterTypeCode = NULL, setLevel = NULL, setParentGuid = NULL, setSequence = NULL, setStateNumber = NULL, setTextColor = 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("Curriculum", "AcademicStandard", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AcademicStandard
#'
#' This function deletes an AcademicStandard.
#'
#' @param AcademicStandardID The id of the AcademicStandard.\cr Run \code{\link{getAllAcademicStandards}} for a list of AcademicStandards.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted AcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAcademicStandard <- function(AcademicStandardID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "AcademicStandard", AcademicStandardID, EntityID)
}
#' Get all AcademicStandardDefaults.
#'
#' This function returns a dataframe of all AcademicStandardDefaults 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 Curriculum
#' @return All AcademicStandardDefaults in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAcademicStandardDefaults <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAcademicStandardDefaultID = F, returnAcademicStandardDefaultIDParent = F, returnAcademicStandardGradeRangeDefaultID = F, returnCreatedTime = F, returnDescription = F, returnIsHighFrequencyWord = F, returnKey = F, returnLetterAndSoundType = F, returnLetterAndSoundTypeCode = F, returnLetterType = F, returnLetterTypeCode = F, returnLevel = F, returnModifiedTime = F, returnParentGuid = 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("Curriculum", "AcademicStandardDefault", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AcademicStandardDefault
#'
#' This function returns fields for an AcademicStandardDefault.
#'
#' @param AcademicStandardDefaultID The id of the AcademicStandardDefault.\cr Run \code{\link{getAllAcademicStandardDefaults}} for a list of AcademicStandardDefaults.
#' @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 Curriculum
#' @return Details for the AcademicStandardDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAcademicStandardDefault <- function(AcademicStandardDefaultID, EntityID = 1, returnAcademicStandardDefaultID = F, returnAcademicStandardDefaultIDParent = F, returnAcademicStandardGradeRangeDefaultID = F, returnCreatedTime = F, returnDescription = F, returnIsHighFrequencyWord = F, returnKey = F, returnLetterAndSoundType = F, returnLetterAndSoundTypeCode = F, returnLetterType = F, returnLetterTypeCode = F, returnLevel = F, returnModifiedTime = F, returnParentGuid = 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("Curriculum", "AcademicStandardDefault", AcademicStandardDefaultID, searchFields, EntityID)
}
#' Modify a specific AcademicStandardDefault
#'
#' This function modifies fields for an AcademicStandardDefault.
#'
#' @param AcademicStandardDefaultID The id of the AcademicStandardDefault to be modified.\cr Run \code{\link{getAllAcademicStandardDefaults}} for a list of AcademicStandardDefaults.
#' @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 Curriculum
#' @return Details of the modified AcademicStandardDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAcademicStandardDefault <- function(AcademicStandardDefaultID, EntityID = 1, setAcademicStandardDefaultIDParent = NULL, setAcademicStandardGradeRangeDefaultID = NULL, setDescription = NULL, setIsHighFrequencyWord = NULL, setKey = NULL, setLetterAndSoundType = NULL, setLetterAndSoundTypeCode = NULL, setLetterType = NULL, setLetterTypeCode = NULL, setLevel = NULL, setParentGuid = 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("Curriculum", "AcademicStandardDefault", AcademicStandardDefaultID, names(functionParams), functionParams, EntityID)
}
#' Create new AcademicStandardDefault.
#'
#' This function creates a new AcademicStandardDefault.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created AcademicStandardDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAcademicStandardDefault <- function(EntityID = 1, setAcademicStandardDefaultIDParent = NULL, setAcademicStandardGradeRangeDefaultID = NULL, setDescription = NULL, setIsHighFrequencyWord = NULL, setKey = NULL, setLetterAndSoundType = NULL, setLetterAndSoundTypeCode = NULL, setLetterType = NULL, setLetterTypeCode = NULL, setLevel = NULL, setParentGuid = 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("Curriculum", "AcademicStandardDefault", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AcademicStandardDefault
#'
#' This function deletes an AcademicStandardDefault.
#'
#' @param AcademicStandardDefaultID The id of the AcademicStandardDefault.\cr Run \code{\link{getAllAcademicStandardDefaults}} for a list of AcademicStandardDefaults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted AcademicStandardDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAcademicStandardDefault <- function(AcademicStandardDefaultID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "AcademicStandardDefault", AcademicStandardDefaultID, EntityID)
}
#' Get all AcademicStandardGradeRanges.
#'
#' This function returns a dataframe of all AcademicStandardGradeRanges 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 Curriculum
#' @return All AcademicStandardGradeRanges in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAcademicStandardGradeRanges <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAcademicStandardGradeRangeID = F, returnAcademicStandardGradeRangeDefaultID = F, returnAcademicStandardSubjectID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnEnteredByDistrict = F, returnFullKey = F, returnFullKeyPrefix = F, returnGradeRangeHigh = F, returnGradeRangeLow = F, returnGuid = F, returnKey = F, returnModifiedTime = F, returnSequence = 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("Curriculum", "AcademicStandardGradeRange", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AcademicStandardGradeRange
#'
#' This function returns fields for an AcademicStandardGradeRange.
#'
#' @param AcademicStandardGradeRangeID The id of the AcademicStandardGradeRange.\cr Run \code{\link{getAllAcademicStandardGradeRanges}} for a list of AcademicStandardGradeRanges.
#' @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 Curriculum
#' @return Details for the AcademicStandardGradeRange.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAcademicStandardGradeRange <- function(AcademicStandardGradeRangeID, EntityID = 1, returnAcademicStandardGradeRangeID = F, returnAcademicStandardGradeRangeDefaultID = F, returnAcademicStandardSubjectID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnEnteredByDistrict = F, returnFullKey = F, returnFullKeyPrefix = F, returnGradeRangeHigh = F, returnGradeRangeLow = F, returnGuid = F, returnKey = F, returnModifiedTime = F, returnSequence = 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("Curriculum", "AcademicStandardGradeRange", AcademicStandardGradeRangeID, searchFields, EntityID)
}
#' Modify a specific AcademicStandardGradeRange
#'
#' This function modifies fields for an AcademicStandardGradeRange.
#'
#' @param AcademicStandardGradeRangeID The id of the AcademicStandardGradeRange to be modified.\cr Run \code{\link{getAllAcademicStandardGradeRanges}} for a list of AcademicStandardGradeRanges.
#' @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 Curriculum
#' @return Details of the modified AcademicStandardGradeRange.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAcademicStandardGradeRange <- function(AcademicStandardGradeRangeID, EntityID = 1, setAcademicStandardGradeRangeDefaultID = NULL, setAcademicStandardSubjectID = NULL, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setEnteredByDistrict = NULL, setGradeRangeHigh = NULL, setGradeRangeLow = NULL, setGuid = NULL, setKey = NULL, setSequence = 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("Curriculum", "AcademicStandardGradeRange", AcademicStandardGradeRangeID, names(functionParams), functionParams, EntityID)
}
#' Create new AcademicStandardGradeRange.
#'
#' This function creates a new AcademicStandardGradeRange.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created AcademicStandardGradeRange.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAcademicStandardGradeRange <- function(EntityID = 1, setAcademicStandardGradeRangeDefaultID = NULL, setAcademicStandardSubjectID = NULL, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setEnteredByDistrict = NULL, setGradeRangeHigh = NULL, setGradeRangeLow = NULL, setGuid = NULL, setKey = NULL, setSequence = 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("Curriculum", "AcademicStandardGradeRange", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AcademicStandardGradeRange
#'
#' This function deletes an AcademicStandardGradeRange.
#'
#' @param AcademicStandardGradeRangeID The id of the AcademicStandardGradeRange.\cr Run \code{\link{getAllAcademicStandardGradeRanges}} for a list of AcademicStandardGradeRanges.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted AcademicStandardGradeRange.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAcademicStandardGradeRange <- function(AcademicStandardGradeRangeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "AcademicStandardGradeRange", AcademicStandardGradeRangeID, EntityID)
}
#' Get all AcademicStandardGradeRangeDefaults.
#'
#' This function returns a dataframe of all AcademicStandardGradeRangeDefaults 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 Curriculum
#' @return All AcademicStandardGradeRangeDefaults in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAcademicStandardGradeRangeDefaults <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAcademicStandardGradeRangeDefaultID = F, returnAcademicStandardSubjectDefaultID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnKey = 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("Curriculum", "AcademicStandardGradeRangeDefault", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AcademicStandardGradeRangeDefault
#'
#' This function returns fields for an AcademicStandardGradeRangeDefault.
#'
#' @param AcademicStandardGradeRangeDefaultID The id of the AcademicStandardGradeRangeDefault.\cr Run \code{\link{getAllAcademicStandardGradeRangeDefaults}} for a list of AcademicStandardGradeRangeDefaults.
#' @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 Curriculum
#' @return Details for the AcademicStandardGradeRangeDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAcademicStandardGradeRangeDefault <- function(AcademicStandardGradeRangeDefaultID, EntityID = 1, returnAcademicStandardGradeRangeDefaultID = F, returnAcademicStandardSubjectDefaultID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnKey = 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("Curriculum", "AcademicStandardGradeRangeDefault", AcademicStandardGradeRangeDefaultID, searchFields, EntityID)
}
#' Modify a specific AcademicStandardGradeRangeDefault
#'
#' This function modifies fields for an AcademicStandardGradeRangeDefault.
#'
#' @param AcademicStandardGradeRangeDefaultID The id of the AcademicStandardGradeRangeDefault to be modified.\cr Run \code{\link{getAllAcademicStandardGradeRangeDefaults}} for a list of AcademicStandardGradeRangeDefaults.
#' @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 Curriculum
#' @return Details of the modified AcademicStandardGradeRangeDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAcademicStandardGradeRangeDefault <- function(AcademicStandardGradeRangeDefaultID, EntityID = 1, setAcademicStandardSubjectDefaultID = NULL, setCode = NULL, setDescription = NULL, setKey = 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("Curriculum", "AcademicStandardGradeRangeDefault", AcademicStandardGradeRangeDefaultID, names(functionParams), functionParams, EntityID)
}
#' Create new AcademicStandardGradeRangeDefault.
#'
#' This function creates a new AcademicStandardGradeRangeDefault.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created AcademicStandardGradeRangeDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAcademicStandardGradeRangeDefault <- function(EntityID = 1, setAcademicStandardSubjectDefaultID = NULL, setCode = NULL, setDescription = NULL, setKey = 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("Curriculum", "AcademicStandardGradeRangeDefault", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AcademicStandardGradeRangeDefault
#'
#' This function deletes an AcademicStandardGradeRangeDefault.
#'
#' @param AcademicStandardGradeRangeDefaultID The id of the AcademicStandardGradeRangeDefault.\cr Run \code{\link{getAllAcademicStandardGradeRangeDefaults}} for a list of AcademicStandardGradeRangeDefaults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted AcademicStandardGradeRangeDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAcademicStandardGradeRangeDefault <- function(AcademicStandardGradeRangeDefaultID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "AcademicStandardGradeRangeDefault", AcademicStandardGradeRangeDefaultID, EntityID)
}
#' Get all AcademicStandardHierarchyDepths.
#'
#' This function returns a dataframe of all AcademicStandardHierarchyDepths 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 Curriculum
#' @return All AcademicStandardHierarchyDepths in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAcademicStandardHierarchyDepths <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAcademicStandardHierarchyDepthID = F, returnAcademicStandardID = F, returnAcademicStandardIDAtLevel = F, returnCreatedTime = F, returnDistrictGroupKey = F, returnHierarchyDepthID = 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("Curriculum", "AcademicStandardHierarchyDepth", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AcademicStandardHierarchyDepth
#'
#' This function returns fields for an AcademicStandardHierarchyDepth.
#'
#' @param AcademicStandardHierarchyDepthID The id of the AcademicStandardHierarchyDepth.\cr Run \code{\link{getAllAcademicStandardHierarchyDepths}} for a list of AcademicStandardHierarchyDepths.
#' @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 Curriculum
#' @return Details for the AcademicStandardHierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAcademicStandardHierarchyDepth <- function(AcademicStandardHierarchyDepthID, EntityID = 1, returnAcademicStandardHierarchyDepthID = F, returnAcademicStandardID = F, returnAcademicStandardIDAtLevel = F, returnCreatedTime = F, returnDistrictGroupKey = F, returnHierarchyDepthID = 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("Curriculum", "AcademicStandardHierarchyDepth", AcademicStandardHierarchyDepthID, searchFields, EntityID)
}
#' Modify a specific AcademicStandardHierarchyDepth
#'
#' This function modifies fields for an AcademicStandardHierarchyDepth.
#'
#' @param AcademicStandardHierarchyDepthID The id of the AcademicStandardHierarchyDepth to be modified.\cr Run \code{\link{getAllAcademicStandardHierarchyDepths}} for a list of AcademicStandardHierarchyDepths.
#' @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 Curriculum
#' @return Details of the modified AcademicStandardHierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAcademicStandardHierarchyDepth <- function(AcademicStandardHierarchyDepthID, EntityID = 1, setAcademicStandardID = NULL, setAcademicStandardIDAtLevel = NULL, setDistrictGroupKey = NULL, setHierarchyDepthID = 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("Curriculum", "AcademicStandardHierarchyDepth", AcademicStandardHierarchyDepthID, names(functionParams), functionParams, EntityID)
}
#' Create new AcademicStandardHierarchyDepth.
#'
#' This function creates a new AcademicStandardHierarchyDepth.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created AcademicStandardHierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAcademicStandardHierarchyDepth <- function(EntityID = 1, setAcademicStandardID = NULL, setAcademicStandardIDAtLevel = NULL, setDistrictGroupKey = NULL, setHierarchyDepthID = 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("Curriculum", "AcademicStandardHierarchyDepth", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AcademicStandardHierarchyDepth
#'
#' This function deletes an AcademicStandardHierarchyDepth.
#'
#' @param AcademicStandardHierarchyDepthID The id of the AcademicStandardHierarchyDepth.\cr Run \code{\link{getAllAcademicStandardHierarchyDepths}} for a list of AcademicStandardHierarchyDepths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted AcademicStandardHierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAcademicStandardHierarchyDepth <- function(AcademicStandardHierarchyDepthID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "AcademicStandardHierarchyDepth", AcademicStandardHierarchyDepthID, EntityID)
}
#' Get all AcademicStandardSets.
#'
#' This function returns a dataframe of all AcademicStandardSets 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 Curriculum
#' @return All AcademicStandardSets in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAcademicStandardSets <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAcademicStandardSetID = F, returnAcademicStandardSetDefaultID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnEnteredByDistrict = F, returnIsActive = F, returnKey = F, returnModifiedTime = F, returnStateCode = 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("Curriculum", "AcademicStandardSet", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AcademicStandardSet
#'
#' This function returns fields for an AcademicStandardSet.
#'
#' @param AcademicStandardSetID The id of the AcademicStandardSet.\cr Run \code{\link{getAllAcademicStandardSets}} for a list of AcademicStandardSets.
#' @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 Curriculum
#' @return Details for the AcademicStandardSet.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAcademicStandardSet <- function(AcademicStandardSetID, EntityID = 1, returnAcademicStandardSetID = F, returnAcademicStandardSetDefaultID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnEnteredByDistrict = F, returnIsActive = F, returnKey = F, returnModifiedTime = F, returnStateCode = 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("Curriculum", "AcademicStandardSet", AcademicStandardSetID, searchFields, EntityID)
}
#' Modify a specific AcademicStandardSet
#'
#' This function modifies fields for an AcademicStandardSet.
#'
#' @param AcademicStandardSetID The id of the AcademicStandardSet to be modified.\cr Run \code{\link{getAllAcademicStandardSets}} for a list of AcademicStandardSets.
#' @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 Curriculum
#' @return Details of the modified AcademicStandardSet.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAcademicStandardSet <- function(AcademicStandardSetID, EntityID = 1, setAcademicStandardSetDefaultID = NULL, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setEnteredByDistrict = NULL, setIsActive = NULL, setKey = NULL, setStateCode = 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("Curriculum", "AcademicStandardSet", AcademicStandardSetID, names(functionParams), functionParams, EntityID)
}
#' Create new AcademicStandardSet.
#'
#' This function creates a new AcademicStandardSet.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created AcademicStandardSet.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAcademicStandardSet <- function(EntityID = 1, setAcademicStandardSetDefaultID = NULL, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setEnteredByDistrict = NULL, setIsActive = NULL, setKey = NULL, setStateCode = 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("Curriculum", "AcademicStandardSet", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AcademicStandardSet
#'
#' This function deletes an AcademicStandardSet.
#'
#' @param AcademicStandardSetID The id of the AcademicStandardSet.\cr Run \code{\link{getAllAcademicStandardSets}} for a list of AcademicStandardSets.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted AcademicStandardSet.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAcademicStandardSet <- function(AcademicStandardSetID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "AcademicStandardSet", AcademicStandardSetID, EntityID)
}
#' Get all AcademicStandardSetDefaults.
#'
#' This function returns a dataframe of all AcademicStandardSetDefaults 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 Curriculum
#' @return All AcademicStandardSetDefaults in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAcademicStandardSetDefaults <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAcademicStandardSetDefaultID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnKey = 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("Curriculum", "AcademicStandardSetDefault", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AcademicStandardSetDefault
#'
#' This function returns fields for an AcademicStandardSetDefault.
#'
#' @param AcademicStandardSetDefaultID The id of the AcademicStandardSetDefault.\cr Run \code{\link{getAllAcademicStandardSetDefaults}} for a list of AcademicStandardSetDefaults.
#' @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 Curriculum
#' @return Details for the AcademicStandardSetDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAcademicStandardSetDefault <- function(AcademicStandardSetDefaultID, EntityID = 1, returnAcademicStandardSetDefaultID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnKey = 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("Curriculum", "AcademicStandardSetDefault", AcademicStandardSetDefaultID, searchFields, EntityID)
}
#' Modify a specific AcademicStandardSetDefault
#'
#' This function modifies fields for an AcademicStandardSetDefault.
#'
#' @param AcademicStandardSetDefaultID The id of the AcademicStandardSetDefault to be modified.\cr Run \code{\link{getAllAcademicStandardSetDefaults}} for a list of AcademicStandardSetDefaults.
#' @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 Curriculum
#' @return Details of the modified AcademicStandardSetDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAcademicStandardSetDefault <- function(AcademicStandardSetDefaultID, EntityID = 1, setCode = NULL, setDescription = NULL, setKey = 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("Curriculum", "AcademicStandardSetDefault", AcademicStandardSetDefaultID, names(functionParams), functionParams, EntityID)
}
#' Create new AcademicStandardSetDefault.
#'
#' This function creates a new AcademicStandardSetDefault.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created AcademicStandardSetDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAcademicStandardSetDefault <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setKey = 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("Curriculum", "AcademicStandardSetDefault", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AcademicStandardSetDefault
#'
#' This function deletes an AcademicStandardSetDefault.
#'
#' @param AcademicStandardSetDefaultID The id of the AcademicStandardSetDefault.\cr Run \code{\link{getAllAcademicStandardSetDefaults}} for a list of AcademicStandardSetDefaults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted AcademicStandardSetDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAcademicStandardSetDefault <- function(AcademicStandardSetDefaultID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "AcademicStandardSetDefault", AcademicStandardSetDefaultID, EntityID)
}
#' Get all AcademicStandardSubjects.
#'
#' This function returns a dataframe of all AcademicStandardSubjects 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 Curriculum
#' @return All AcademicStandardSubjects in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAcademicStandardSubjects <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAcademicStandardSubjectID = F, returnAcademicStandardSetID = F, returnAcademicStandardSubjectDefaultID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnEnteredByDistrict = F, returnFullKey = F, returnFullKeyPrefix = F, returnKey = F, returnModifiedTime = F, returnSequence = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnYear = 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("Curriculum", "AcademicStandardSubject", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AcademicStandardSubject
#'
#' This function returns fields for an AcademicStandardSubject.
#'
#' @param AcademicStandardSubjectID The id of the AcademicStandardSubject.\cr Run \code{\link{getAllAcademicStandardSubjects}} for a list of AcademicStandardSubjects.
#' @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 Curriculum
#' @return Details for the AcademicStandardSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAcademicStandardSubject <- function(AcademicStandardSubjectID, EntityID = 1, returnAcademicStandardSubjectID = F, returnAcademicStandardSetID = F, returnAcademicStandardSubjectDefaultID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnEnteredByDistrict = F, returnFullKey = F, returnFullKeyPrefix = F, returnKey = F, returnModifiedTime = F, returnSequence = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnYear = 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("Curriculum", "AcademicStandardSubject", AcademicStandardSubjectID, searchFields, EntityID)
}
#' Modify a specific AcademicStandardSubject
#'
#' This function modifies fields for an AcademicStandardSubject.
#'
#' @param AcademicStandardSubjectID The id of the AcademicStandardSubject to be modified.\cr Run \code{\link{getAllAcademicStandardSubjects}} for a list of AcademicStandardSubjects.
#' @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 Curriculum
#' @return Details of the modified AcademicStandardSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAcademicStandardSubject <- function(AcademicStandardSubjectID, EntityID = 1, setAcademicStandardSetID = NULL, setAcademicStandardSubjectDefaultID = NULL, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setEnteredByDistrict = NULL, setKey = NULL, setSequence = NULL, setYear = 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("Curriculum", "AcademicStandardSubject", AcademicStandardSubjectID, names(functionParams), functionParams, EntityID)
}
#' Create new AcademicStandardSubject.
#'
#' This function creates a new AcademicStandardSubject.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created AcademicStandardSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAcademicStandardSubject <- function(EntityID = 1, setAcademicStandardSetID = NULL, setAcademicStandardSubjectDefaultID = NULL, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setEnteredByDistrict = NULL, setKey = NULL, setSequence = NULL, setYear = 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("Curriculum", "AcademicStandardSubject", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AcademicStandardSubject
#'
#' This function deletes an AcademicStandardSubject.
#'
#' @param AcademicStandardSubjectID The id of the AcademicStandardSubject.\cr Run \code{\link{getAllAcademicStandardSubjects}} for a list of AcademicStandardSubjects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted AcademicStandardSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAcademicStandardSubject <- function(AcademicStandardSubjectID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "AcademicStandardSubject", AcademicStandardSubjectID, EntityID)
}
#' Get all AcademicStandardSubjectDefaults.
#'
#' This function returns a dataframe of all AcademicStandardSubjectDefaults 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 Curriculum
#' @return All AcademicStandardSubjectDefaults in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAcademicStandardSubjectDefaults <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAcademicStandardSubjectDefaultID = F, returnAcademicStandardSetDefaultID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnKey = 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("Curriculum", "AcademicStandardSubjectDefault", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AcademicStandardSubjectDefault
#'
#' This function returns fields for an AcademicStandardSubjectDefault.
#'
#' @param AcademicStandardSubjectDefaultID The id of the AcademicStandardSubjectDefault.\cr Run \code{\link{getAllAcademicStandardSubjectDefaults}} for a list of AcademicStandardSubjectDefaults.
#' @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 Curriculum
#' @return Details for the AcademicStandardSubjectDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAcademicStandardSubjectDefault <- function(AcademicStandardSubjectDefaultID, EntityID = 1, returnAcademicStandardSubjectDefaultID = F, returnAcademicStandardSetDefaultID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnKey = 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("Curriculum", "AcademicStandardSubjectDefault", AcademicStandardSubjectDefaultID, searchFields, EntityID)
}
#' Modify a specific AcademicStandardSubjectDefault
#'
#' This function modifies fields for an AcademicStandardSubjectDefault.
#'
#' @param AcademicStandardSubjectDefaultID The id of the AcademicStandardSubjectDefault to be modified.\cr Run \code{\link{getAllAcademicStandardSubjectDefaults}} for a list of AcademicStandardSubjectDefaults.
#' @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 Curriculum
#' @return Details of the modified AcademicStandardSubjectDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAcademicStandardSubjectDefault <- function(AcademicStandardSubjectDefaultID, EntityID = 1, setAcademicStandardSetDefaultID = NULL, setCode = NULL, setDescription = NULL, setKey = 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("Curriculum", "AcademicStandardSubjectDefault", AcademicStandardSubjectDefaultID, names(functionParams), functionParams, EntityID)
}
#' Create new AcademicStandardSubjectDefault.
#'
#' This function creates a new AcademicStandardSubjectDefault.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created AcademicStandardSubjectDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAcademicStandardSubjectDefault <- function(EntityID = 1, setAcademicStandardSetDefaultID = NULL, setCode = NULL, setDescription = NULL, setKey = 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("Curriculum", "AcademicStandardSubjectDefault", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AcademicStandardSubjectDefault
#'
#' This function deletes an AcademicStandardSubjectDefault.
#'
#' @param AcademicStandardSubjectDefaultID The id of the AcademicStandardSubjectDefault.\cr Run \code{\link{getAllAcademicStandardSubjectDefaults}} for a list of AcademicStandardSubjectDefaults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted AcademicStandardSubjectDefault.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAcademicStandardSubjectDefault <- function(AcademicStandardSubjectDefaultID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "AcademicStandardSubjectDefault", AcademicStandardSubjectDefaultID, EntityID)
}
#' Get all AssessmentToolMNs.
#'
#' This function returns a dataframe of all AssessmentToolMNs 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 Curriculum
#' @return All AssessmentToolMNs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllAssessmentToolMNs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnAssessmentToolMNID = F, returnAssessmentToolMNIDClonedFrom = F, returnCreatedTime = F, returnCurriculumYearID = F, returnModifiedTime = F, returnStateAssessmentToolMNID = F, returnStateImplementationStatusMNID = 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("Curriculum", "AssessmentToolMN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific AssessmentToolMN
#'
#' This function returns fields for an AssessmentToolMN.
#'
#' @param AssessmentToolMNID The id of the AssessmentToolMN.\cr Run \code{\link{getAllAssessmentToolMNs}} for a list of AssessmentToolMNs.
#' @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 Curriculum
#' @return Details for the AssessmentToolMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAssessmentToolMN <- function(AssessmentToolMNID, EntityID = 1, returnAssessmentToolMNID = F, returnAssessmentToolMNIDClonedFrom = F, returnCreatedTime = F, returnCurriculumYearID = F, returnModifiedTime = F, returnStateAssessmentToolMNID = F, returnStateImplementationStatusMNID = 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("Curriculum", "AssessmentToolMN", AssessmentToolMNID, searchFields, EntityID)
}
#' Modify a specific AssessmentToolMN
#'
#' This function modifies fields for an AssessmentToolMN.
#'
#' @param AssessmentToolMNID The id of the AssessmentToolMN to be modified.\cr Run \code{\link{getAllAssessmentToolMNs}} for a list of AssessmentToolMNs.
#' @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 Curriculum
#' @return Details of the modified AssessmentToolMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAssessmentToolMN <- function(AssessmentToolMNID, EntityID = 1, setAssessmentToolMNIDClonedFrom = NULL, setCurriculumYearID = NULL, setStateAssessmentToolMNID = NULL, setStateImplementationStatusMNID = 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("Curriculum", "AssessmentToolMN", AssessmentToolMNID, names(functionParams), functionParams, EntityID)
}
#' Create new AssessmentToolMN.
#'
#' This function creates a new AssessmentToolMN.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created AssessmentToolMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAssessmentToolMN <- function(EntityID = 1, setAssessmentToolMNIDClonedFrom = NULL, setCurriculumYearID = NULL, setStateAssessmentToolMNID = NULL, setStateImplementationStatusMNID = 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("Curriculum", "AssessmentToolMN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific AssessmentToolMN
#'
#' This function deletes an AssessmentToolMN.
#'
#' @param AssessmentToolMNID The id of the AssessmentToolMN.\cr Run \code{\link{getAllAssessmentToolMNs}} for a list of AssessmentToolMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted AssessmentToolMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAssessmentToolMN <- function(AssessmentToolMNID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "AssessmentToolMN", AssessmentToolMNID, EntityID)
}
#' Get all Curriculums.
#'
#' This function returns a dataframe of all Curriculums 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 Curriculum
#' @return All Curriculums in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCurriculums <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCurriculumID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnCurriculumSubAreaExistsForStudentAndSubArea = F, returnCurriculumSubAreaExistsForSubAreaWithoutStudent = F, returnCurriculumSubjectSummary = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnEarnedCredits = F, returnGradeLevelSummary = F, returnGradReqRankGPAIgnoreDuplicateCheck = F, returnGradReqSubjectTypeID = F, returnHasPrerequisiteCurriculums = F, returnHasPrerequisites = F, returnIsActive = F, returnIsAllowedToBeSelectedInCareerPlan = F, returnIsFederalDistanceEducation = F, returnIsFederalDualEnrollment = F, returnModifiedTime = F, returnNumberOfActiveCurrentOrFutureCourses = F, returnNumberOfAttachedSubjects = F, returnPrerequisiteCurriculumExistsForPrerequisite = 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("Curriculum", "Curriculum", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Curriculum
#'
#' This function returns fields for a Curriculum.
#'
#' @param CurriculumID The id of the Curriculum.\cr Run \code{\link{getAllCurriculums}} for a list of Curriculums.
#' @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 Curriculum
#' @return Details for the Curriculum.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCurriculum <- function(CurriculumID, EntityID = 1, returnCurriculumID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnCurriculumSubAreaExistsForStudentAndSubArea = F, returnCurriculumSubAreaExistsForSubAreaWithoutStudent = F, returnCurriculumSubjectSummary = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnEarnedCredits = F, returnGradeLevelSummary = F, returnGradReqRankGPAIgnoreDuplicateCheck = F, returnGradReqSubjectTypeID = F, returnHasPrerequisiteCurriculums = F, returnHasPrerequisites = F, returnIsActive = F, returnIsAllowedToBeSelectedInCareerPlan = F, returnIsFederalDistanceEducation = F, returnIsFederalDualEnrollment = F, returnModifiedTime = F, returnNumberOfActiveCurrentOrFutureCourses = F, returnNumberOfAttachedSubjects = F, returnPrerequisiteCurriculumExistsForPrerequisite = 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("Curriculum", "Curriculum", CurriculumID, searchFields, EntityID)
}
#' Modify a specific Curriculum
#'
#' This function modifies fields for a Curriculum.
#'
#' @param CurriculumID The id of the Curriculum to be modified.\cr Run \code{\link{getAllCurriculums}} for a list of Curriculums.
#' @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 Curriculum
#' @return Details of the modified Curriculum.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCurriculum <- function(CurriculumID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setEarnedCredits = NULL, setGradReqRankGPAIgnoreDuplicateCheck = NULL, setGradReqSubjectTypeID = NULL, setIsActive = NULL, setIsAllowedToBeSelectedInCareerPlan = 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("Curriculum", "Curriculum", CurriculumID, names(functionParams), functionParams, EntityID)
}
#' Create new Curriculum.
#'
#' This function creates a new Curriculum.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created Curriculum.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCurriculum <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setEarnedCredits = NULL, setGradReqRankGPAIgnoreDuplicateCheck = NULL, setGradReqSubjectTypeID = NULL, setIsActive = NULL, setIsAllowedToBeSelectedInCareerPlan = 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("Curriculum", "Curriculum", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Curriculum
#'
#' This function deletes a Curriculum.
#'
#' @param CurriculumID The id of the Curriculum.\cr Run \code{\link{getAllCurriculums}} for a list of Curriculums.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted Curriculum.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCurriculum <- function(CurriculumID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "Curriculum", CurriculumID, EntityID)
}
#' Get all CurriculumAcademicStandards.
#'
#' This function returns a dataframe of all CurriculumAcademicStandards 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 Curriculum
#' @return All CurriculumAcademicStandards in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCurriculumAcademicStandards <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCurriculumAcademicStandardID = F, returnAcademicStandardID = F, returnCreatedTime = F, returnCurriculumID = F, returnDistrictGroupKey = F, returnIsGraded = 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("Curriculum", "CurriculumAcademicStandard", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CurriculumAcademicStandard
#'
#' This function returns fields for a CurriculumAcademicStandard.
#'
#' @param CurriculumAcademicStandardID The id of the CurriculumAcademicStandard.\cr Run \code{\link{getAllCurriculumAcademicStandards}} for a list of CurriculumAcademicStandards.
#' @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 Curriculum
#' @return Details for the CurriculumAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCurriculumAcademicStandard <- function(CurriculumAcademicStandardID, EntityID = 1, returnCurriculumAcademicStandardID = F, returnAcademicStandardID = F, returnCreatedTime = F, returnCurriculumID = F, returnDistrictGroupKey = F, returnIsGraded = 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("Curriculum", "CurriculumAcademicStandard", CurriculumAcademicStandardID, searchFields, EntityID)
}
#' Modify a specific CurriculumAcademicStandard
#'
#' This function modifies fields for a CurriculumAcademicStandard.
#'
#' @param CurriculumAcademicStandardID The id of the CurriculumAcademicStandard to be modified.\cr Run \code{\link{getAllCurriculumAcademicStandards}} for a list of CurriculumAcademicStandards.
#' @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 Curriculum
#' @return Details of the modified CurriculumAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCurriculumAcademicStandard <- function(CurriculumAcademicStandardID, EntityID = 1, setAcademicStandardID = NULL, setCurriculumID = NULL, setDistrictGroupKey = NULL, setIsGraded = 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("Curriculum", "CurriculumAcademicStandard", CurriculumAcademicStandardID, names(functionParams), functionParams, EntityID)
}
#' Create new CurriculumAcademicStandard.
#'
#' This function creates a new CurriculumAcademicStandard.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created CurriculumAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCurriculumAcademicStandard <- function(EntityID = 1, setAcademicStandardID = NULL, setCurriculumID = NULL, setDistrictGroupKey = NULL, setIsGraded = 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("Curriculum", "CurriculumAcademicStandard", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CurriculumAcademicStandard
#'
#' This function deletes a CurriculumAcademicStandard.
#'
#' @param CurriculumAcademicStandardID The id of the CurriculumAcademicStandard.\cr Run \code{\link{getAllCurriculumAcademicStandards}} for a list of CurriculumAcademicStandards.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted CurriculumAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCurriculumAcademicStandard <- function(CurriculumAcademicStandardID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "CurriculumAcademicStandard", CurriculumAcademicStandardID, EntityID)
}
#' Get all CurriculumCustomRequirements.
#'
#' This function returns a dataframe of all CurriculumCustomRequirements 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 Curriculum
#' @return All CurriculumCustomRequirements in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCurriculumCustomRequirements <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCurriculumCustomRequirementID = F, returnCreatedTime = F, returnCurriculumID = F, returnCustomRequirementID = F, returnDistrictGroupKey = F, returnModifiedTime = F, returnSchoolYearHigh = F, returnSchoolYearLow = 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("Curriculum", "CurriculumCustomRequirement", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CurriculumCustomRequirement
#'
#' This function returns fields for a CurriculumCustomRequirement.
#'
#' @param CurriculumCustomRequirementID The id of the CurriculumCustomRequirement.\cr Run \code{\link{getAllCurriculumCustomRequirements}} for a list of CurriculumCustomRequirements.
#' @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 Curriculum
#' @return Details for the CurriculumCustomRequirement.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCurriculumCustomRequirement <- function(CurriculumCustomRequirementID, EntityID = 1, returnCurriculumCustomRequirementID = F, returnCreatedTime = F, returnCurriculumID = F, returnCustomRequirementID = F, returnDistrictGroupKey = F, returnModifiedTime = F, returnSchoolYearHigh = F, returnSchoolYearLow = 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("Curriculum", "CurriculumCustomRequirement", CurriculumCustomRequirementID, searchFields, EntityID)
}
#' Modify a specific CurriculumCustomRequirement
#'
#' This function modifies fields for a CurriculumCustomRequirement.
#'
#' @param CurriculumCustomRequirementID The id of the CurriculumCustomRequirement to be modified.\cr Run \code{\link{getAllCurriculumCustomRequirements}} for a list of CurriculumCustomRequirements.
#' @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 Curriculum
#' @return Details of the modified CurriculumCustomRequirement.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCurriculumCustomRequirement <- function(CurriculumCustomRequirementID, EntityID = 1, setCurriculumID = NULL, setCustomRequirementID = NULL, setDistrictGroupKey = NULL, setSchoolYearHigh = NULL, setSchoolYearLow = 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("Curriculum", "CurriculumCustomRequirement", CurriculumCustomRequirementID, names(functionParams), functionParams, EntityID)
}
#' Create new CurriculumCustomRequirement.
#'
#' This function creates a new CurriculumCustomRequirement.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created CurriculumCustomRequirement.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCurriculumCustomRequirement <- function(EntityID = 1, setCurriculumID = NULL, setCustomRequirementID = NULL, setDistrictGroupKey = NULL, setSchoolYearHigh = NULL, setSchoolYearLow = 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("Curriculum", "CurriculumCustomRequirement", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CurriculumCustomRequirement
#'
#' This function deletes a CurriculumCustomRequirement.
#'
#' @param CurriculumCustomRequirementID The id of the CurriculumCustomRequirement.\cr Run \code{\link{getAllCurriculumCustomRequirements}} for a list of CurriculumCustomRequirements.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted CurriculumCustomRequirement.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCurriculumCustomRequirement <- function(CurriculumCustomRequirementID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "CurriculumCustomRequirement", CurriculumCustomRequirementID, EntityID)
}
#' Get all CurriculumGradeLevels.
#'
#' This function returns a dataframe of all CurriculumGradeLevels 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 Curriculum
#' @return All CurriculumGradeLevels in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCurriculumGradeLevels <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCurriculumGradeLevelID = F, returnCreatedTime = F, returnCurriculumID = F, returnDistrictGroupKey = F, returnGradeLevelID = 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("Curriculum", "CurriculumGradeLevel", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CurriculumGradeLevel
#'
#' This function returns fields for a CurriculumGradeLevel.
#'
#' @param CurriculumGradeLevelID The id of the CurriculumGradeLevel.\cr Run \code{\link{getAllCurriculumGradeLevels}} for a list of CurriculumGradeLevels.
#' @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 Curriculum
#' @return Details for the CurriculumGradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCurriculumGradeLevel <- function(CurriculumGradeLevelID, EntityID = 1, returnCurriculumGradeLevelID = F, returnCreatedTime = F, returnCurriculumID = F, returnDistrictGroupKey = F, returnGradeLevelID = 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("Curriculum", "CurriculumGradeLevel", CurriculumGradeLevelID, searchFields, EntityID)
}
#' Modify a specific CurriculumGradeLevel
#'
#' This function modifies fields for a CurriculumGradeLevel.
#'
#' @param CurriculumGradeLevelID The id of the CurriculumGradeLevel to be modified.\cr Run \code{\link{getAllCurriculumGradeLevels}} for a list of CurriculumGradeLevels.
#' @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 Curriculum
#' @return Details of the modified CurriculumGradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCurriculumGradeLevel <- function(CurriculumGradeLevelID, EntityID = 1, setCurriculumID = NULL, setDistrictGroupKey = NULL, setGradeLevelID = 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("Curriculum", "CurriculumGradeLevel", CurriculumGradeLevelID, names(functionParams), functionParams, EntityID)
}
#' Create new CurriculumGradeLevel.
#'
#' This function creates a new CurriculumGradeLevel.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created CurriculumGradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCurriculumGradeLevel <- function(EntityID = 1, setCurriculumID = NULL, setDistrictGroupKey = NULL, setGradeLevelID = 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("Curriculum", "CurriculumGradeLevel", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CurriculumGradeLevel
#'
#' This function deletes a CurriculumGradeLevel.
#'
#' @param CurriculumGradeLevelID The id of the CurriculumGradeLevel.\cr Run \code{\link{getAllCurriculumGradeLevels}} for a list of CurriculumGradeLevels.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted CurriculumGradeLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCurriculumGradeLevel <- function(CurriculumGradeLevelID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "CurriculumGradeLevel", CurriculumGradeLevelID, EntityID)
}
#' Get all CurriculumProgramMNs.
#'
#' This function returns a dataframe of all CurriculumProgramMNs 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 Curriculum
#' @return All CurriculumProgramMNs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCurriculumProgramMNs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCurriculumProgramMNID = F, returnCreatedTime = F, returnCurriculumProgramMNIDClonedFrom = F, returnCurriculumYearID = F, returnModifiedTime = F, returnStateCurriculumProgramMNID = F, returnStateImplementationStatusMNID = 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("Curriculum", "CurriculumProgramMN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CurriculumProgramMN
#'
#' This function returns fields for a CurriculumProgramMN.
#'
#' @param CurriculumProgramMNID The id of the CurriculumProgramMN.\cr Run \code{\link{getAllCurriculumProgramMNs}} for a list of CurriculumProgramMNs.
#' @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 Curriculum
#' @return Details for the CurriculumProgramMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCurriculumProgramMN <- function(CurriculumProgramMNID, EntityID = 1, returnCurriculumProgramMNID = F, returnCreatedTime = F, returnCurriculumProgramMNIDClonedFrom = F, returnCurriculumYearID = F, returnModifiedTime = F, returnStateCurriculumProgramMNID = F, returnStateImplementationStatusMNID = 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("Curriculum", "CurriculumProgramMN", CurriculumProgramMNID, searchFields, EntityID)
}
#' Modify a specific CurriculumProgramMN
#'
#' This function modifies fields for a CurriculumProgramMN.
#'
#' @param CurriculumProgramMNID The id of the CurriculumProgramMN to be modified.\cr Run \code{\link{getAllCurriculumProgramMNs}} for a list of CurriculumProgramMNs.
#' @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 Curriculum
#' @return Details of the modified CurriculumProgramMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCurriculumProgramMN <- function(CurriculumProgramMNID, EntityID = 1, setCurriculumProgramMNIDClonedFrom = NULL, setCurriculumYearID = NULL, setStateCurriculumProgramMNID = NULL, setStateImplementationStatusMNID = 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("Curriculum", "CurriculumProgramMN", CurriculumProgramMNID, names(functionParams), functionParams, EntityID)
}
#' Create new CurriculumProgramMN.
#'
#' This function creates a new CurriculumProgramMN.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created CurriculumProgramMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCurriculumProgramMN <- function(EntityID = 1, setCurriculumProgramMNIDClonedFrom = NULL, setCurriculumYearID = NULL, setStateCurriculumProgramMNID = NULL, setStateImplementationStatusMNID = 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("Curriculum", "CurriculumProgramMN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CurriculumProgramMN
#'
#' This function deletes a CurriculumProgramMN.
#'
#' @param CurriculumProgramMNID The id of the CurriculumProgramMN.\cr Run \code{\link{getAllCurriculumProgramMNs}} for a list of CurriculumProgramMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted CurriculumProgramMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCurriculumProgramMN <- function(CurriculumProgramMNID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "CurriculumProgramMN", CurriculumProgramMNID, EntityID)
}
#' Get all CurriculumSubjects.
#'
#' This function returns a dataframe of all CurriculumSubjects 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 Curriculum
#' @return All CurriculumSubjects in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCurriculumSubjects <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCurriculumSubjectID = F, returnCreatedTime = F, returnCurriculumID = F, returnCurriculumSubjectIDClonedFrom = F, returnCurriculumSubjectIDClonedTo = F, returnDistrictGroupKey = F, returnIsDefault = F, returnModifiedTime = F, returnNumberOfAttachedCurriculumAcademicStandards = F, returnSubjectID = 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("Curriculum", "CurriculumSubject", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CurriculumSubject
#'
#' This function returns fields for a CurriculumSubject.
#'
#' @param CurriculumSubjectID The id of the CurriculumSubject.\cr Run \code{\link{getAllCurriculumSubjects}} for a list of CurriculumSubjects.
#' @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 Curriculum
#' @return Details for the CurriculumSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCurriculumSubject <- function(CurriculumSubjectID, EntityID = 1, returnCurriculumSubjectID = F, returnCreatedTime = F, returnCurriculumID = F, returnCurriculumSubjectIDClonedFrom = F, returnCurriculumSubjectIDClonedTo = F, returnDistrictGroupKey = F, returnIsDefault = F, returnModifiedTime = F, returnNumberOfAttachedCurriculumAcademicStandards = F, returnSubjectID = 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("Curriculum", "CurriculumSubject", CurriculumSubjectID, searchFields, EntityID)
}
#' Modify a specific CurriculumSubject
#'
#' This function modifies fields for a CurriculumSubject.
#'
#' @param CurriculumSubjectID The id of the CurriculumSubject to be modified.\cr Run \code{\link{getAllCurriculumSubjects}} for a list of CurriculumSubjects.
#' @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 Curriculum
#' @return Details of the modified CurriculumSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCurriculumSubject <- function(CurriculumSubjectID, EntityID = 1, setCurriculumID = NULL, setCurriculumSubjectIDClonedFrom = NULL, setDistrictGroupKey = NULL, setIsDefault = NULL, setSubjectID = 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("Curriculum", "CurriculumSubject", CurriculumSubjectID, names(functionParams), functionParams, EntityID)
}
#' Create new CurriculumSubject.
#'
#' This function creates a new CurriculumSubject.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created CurriculumSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCurriculumSubject <- function(EntityID = 1, setCurriculumID = NULL, setCurriculumSubjectIDClonedFrom = NULL, setDistrictGroupKey = NULL, setIsDefault = NULL, setSubjectID = 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("Curriculum", "CurriculumSubject", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CurriculumSubject
#'
#' This function deletes a CurriculumSubject.
#'
#' @param CurriculumSubjectID The id of the CurriculumSubject.\cr Run \code{\link{getAllCurriculumSubjects}} for a list of CurriculumSubjects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted CurriculumSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCurriculumSubject <- function(CurriculumSubjectID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "CurriculumSubject", CurriculumSubjectID, EntityID)
}
#' Get all CurriculumSubjectAcademicStandards.
#'
#' This function returns a dataframe of all CurriculumSubjectAcademicStandards 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 Curriculum
#' @return All CurriculumSubjectAcademicStandards in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCurriculumSubjectAcademicStandards <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCurriculumSubjectAcademicStandardID = F, returnCreatedTime = F, returnCurriculumAcademicStandardID = F, returnCurriculumSubjectID = 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("Curriculum", "CurriculumSubjectAcademicStandard", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CurriculumSubjectAcademicStandard
#'
#' This function returns fields for a CurriculumSubjectAcademicStandard.
#'
#' @param CurriculumSubjectAcademicStandardID The id of the CurriculumSubjectAcademicStandard.\cr Run \code{\link{getAllCurriculumSubjectAcademicStandards}} for a list of CurriculumSubjectAcademicStandards.
#' @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 Curriculum
#' @return Details for the CurriculumSubjectAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCurriculumSubjectAcademicStandard <- function(CurriculumSubjectAcademicStandardID, EntityID = 1, returnCurriculumSubjectAcademicStandardID = F, returnCreatedTime = F, returnCurriculumAcademicStandardID = F, returnCurriculumSubjectID = 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("Curriculum", "CurriculumSubjectAcademicStandard", CurriculumSubjectAcademicStandardID, searchFields, EntityID)
}
#' Modify a specific CurriculumSubjectAcademicStandard
#'
#' This function modifies fields for a CurriculumSubjectAcademicStandard.
#'
#' @param CurriculumSubjectAcademicStandardID The id of the CurriculumSubjectAcademicStandard to be modified.\cr Run \code{\link{getAllCurriculumSubjectAcademicStandards}} for a list of CurriculumSubjectAcademicStandards.
#' @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 Curriculum
#' @return Details of the modified CurriculumSubjectAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCurriculumSubjectAcademicStandard <- function(CurriculumSubjectAcademicStandardID, EntityID = 1, setCurriculumAcademicStandardID = NULL, setCurriculumSubjectID = 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("Curriculum", "CurriculumSubjectAcademicStandard", CurriculumSubjectAcademicStandardID, names(functionParams), functionParams, EntityID)
}
#' Create new CurriculumSubjectAcademicStandard.
#'
#' This function creates a new CurriculumSubjectAcademicStandard.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created CurriculumSubjectAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCurriculumSubjectAcademicStandard <- function(EntityID = 1, setCurriculumAcademicStandardID = NULL, setCurriculumSubjectID = 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("Curriculum", "CurriculumSubjectAcademicStandard", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CurriculumSubjectAcademicStandard
#'
#' This function deletes a CurriculumSubjectAcademicStandard.
#'
#' @param CurriculumSubjectAcademicStandardID The id of the CurriculumSubjectAcademicStandard.\cr Run \code{\link{getAllCurriculumSubjectAcademicStandards}} for a list of CurriculumSubjectAcademicStandards.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted CurriculumSubjectAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCurriculumSubjectAcademicStandard <- function(CurriculumSubjectAcademicStandardID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "CurriculumSubjectAcademicStandard", CurriculumSubjectAcademicStandardID, EntityID)
}
#' Get all CurriculumYears.
#'
#' This function returns a dataframe of all CurriculumYears 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 Curriculum
#' @return All CurriculumYears in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllCurriculumYears <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnCurriculumYearID = F, returnCreatedTime = F, returnCurriculumID = F, returnCurriculumYearIDClonedFrom = F, returnCurriculumYearIDClonedTo = F, returnCurriculumYearMNID = F, returnDescription = F, returnDistrictGroupKey = F, returnFederalAdvancedPlacementCourseTypeID = F, returnFederalSubjectTypeID = F, returnHasCourseLevels = F, returnIsAdultBasicEducation = F, returnIsEndOfCourse = F, returnIsFederalDistanceEducation = F, returnIsFederalDualEnrollment = F, returnIsFederalProgram = F, returnIsGraduationRequirement = F, returnIsStateProgram = F, returnModifiedTime = F, returnReportToFitnessGram = F, returnSchoolYearID = F, returnStateCourseCodeMNID = F, returnStateEarlyEducationLocationMNID = F, returnStateStandardAddressedCodeMNID = F, returnStateSTARAssignmentCodeMNID = F, returnStateSubjectAreaCodeMNID = 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("Curriculum", "CurriculumYear", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific CurriculumYear
#'
#' This function returns fields for a CurriculumYear.
#'
#' @param CurriculumYearID The id of the CurriculumYear.\cr Run \code{\link{getAllCurriculumYears}} for a list of CurriculumYears.
#' @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 Curriculum
#' @return Details for the CurriculumYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getCurriculumYear <- function(CurriculumYearID, EntityID = 1, returnCurriculumYearID = F, returnCreatedTime = F, returnCurriculumID = F, returnCurriculumYearIDClonedFrom = F, returnCurriculumYearIDClonedTo = F, returnCurriculumYearMNID = F, returnDescription = F, returnDistrictGroupKey = F, returnFederalAdvancedPlacementCourseTypeID = F, returnFederalSubjectTypeID = F, returnHasCourseLevels = F, returnIsAdultBasicEducation = F, returnIsEndOfCourse = F, returnIsFederalDistanceEducation = F, returnIsFederalDualEnrollment = F, returnIsFederalProgram = F, returnIsGraduationRequirement = F, returnIsStateProgram = F, returnModifiedTime = F, returnReportToFitnessGram = F, returnSchoolYearID = F, returnStateCourseCodeMNID = F, returnStateEarlyEducationLocationMNID = F, returnStateStandardAddressedCodeMNID = F, returnStateSTARAssignmentCodeMNID = F, returnStateSubjectAreaCodeMNID = 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("Curriculum", "CurriculumYear", CurriculumYearID, searchFields, EntityID)
}
#' Modify a specific CurriculumYear
#'
#' This function modifies fields for a CurriculumYear.
#'
#' @param CurriculumYearID The id of the CurriculumYear to be modified.\cr Run \code{\link{getAllCurriculumYears}} for a list of CurriculumYears.
#' @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 Curriculum
#' @return Details of the modified CurriculumYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyCurriculumYear <- function(CurriculumYearID, EntityID = 1, setCurriculumID = NULL, setCurriculumYearIDClonedFrom = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setFederalAdvancedPlacementCourseTypeID = NULL, setFederalSubjectTypeID = NULL, setIsAdultBasicEducation = NULL, setIsEndOfCourse = NULL, setIsFederalDistanceEducation = NULL, setIsFederalDualEnrollment = NULL, setIsFederalProgram = NULL, setIsGraduationRequirement = NULL, setIsStateProgram = NULL, setReportToFitnessGram = NULL, setSchoolYearID = NULL, setStateCourseCodeMNID = NULL, setStateEarlyEducationLocationMNID = NULL, setStateStandardAddressedCodeMNID = NULL, setStateSTARAssignmentCodeMNID = NULL, setStateSubjectAreaCodeMNID = 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("Curriculum", "CurriculumYear", CurriculumYearID, names(functionParams), functionParams, EntityID)
}
#' Create new CurriculumYear.
#'
#' This function creates a new CurriculumYear.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created CurriculumYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createCurriculumYear <- function(EntityID = 1, setCurriculumID = NULL, setCurriculumYearIDClonedFrom = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setFederalAdvancedPlacementCourseTypeID = NULL, setFederalSubjectTypeID = NULL, setIsAdultBasicEducation = NULL, setIsEndOfCourse = NULL, setIsFederalDistanceEducation = NULL, setIsFederalDualEnrollment = NULL, setIsFederalProgram = NULL, setIsGraduationRequirement = NULL, setIsStateProgram = NULL, setReportToFitnessGram = NULL, setSchoolYearID = NULL, setStateCourseCodeMNID = NULL, setStateEarlyEducationLocationMNID = NULL, setStateStandardAddressedCodeMNID = NULL, setStateSTARAssignmentCodeMNID = NULL, setStateSubjectAreaCodeMNID = 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("Curriculum", "CurriculumYear", names(functionParams), functionParams, EntityID)
}
#' Delete a specific CurriculumYear
#'
#' This function deletes a CurriculumYear.
#'
#' @param CurriculumYearID The id of the CurriculumYear.\cr Run \code{\link{getAllCurriculumYears}} for a list of CurriculumYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted CurriculumYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteCurriculumYear <- function(CurriculumYearID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "CurriculumYear", CurriculumYearID, EntityID)
}
#' Get all EarlyEducationInstructionalApproachMNs.
#'
#' This function returns a dataframe of all EarlyEducationInstructionalApproachMNs 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 Curriculum
#' @return All EarlyEducationInstructionalApproachMNs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllEarlyEducationInstructionalApproachMNs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnEarlyEducationInstructionalApproachMNID = F, returnCreatedTime = F, returnCurriculumYearID = F, returnEarlyEducationInstructionalApproachMNIDClonedFrom = F, returnModifiedTime = F, returnStateEarlyEducationInstructionalApproachMNID = F, returnStateImplementationStatusMNID = 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("Curriculum", "EarlyEducationInstructionalApproachMN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific EarlyEducationInstructionalApproachMN
#'
#' This function returns fields for an EarlyEducationInstructionalApproachMN.
#'
#' @param EarlyEducationInstructionalApproachMNID The id of the EarlyEducationInstructionalApproachMN.\cr Run \code{\link{getAllEarlyEducationInstructionalApproachMNs}} for a list of EarlyEducationInstructionalApproachMNs.
#' @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 Curriculum
#' @return Details for the EarlyEducationInstructionalApproachMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getEarlyEducationInstructionalApproachMN <- function(EarlyEducationInstructionalApproachMNID, EntityID = 1, returnEarlyEducationInstructionalApproachMNID = F, returnCreatedTime = F, returnCurriculumYearID = F, returnEarlyEducationInstructionalApproachMNIDClonedFrom = F, returnModifiedTime = F, returnStateEarlyEducationInstructionalApproachMNID = F, returnStateImplementationStatusMNID = 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("Curriculum", "EarlyEducationInstructionalApproachMN", EarlyEducationInstructionalApproachMNID, searchFields, EntityID)
}
#' Modify a specific EarlyEducationInstructionalApproachMN
#'
#' This function modifies fields for an EarlyEducationInstructionalApproachMN.
#'
#' @param EarlyEducationInstructionalApproachMNID The id of the EarlyEducationInstructionalApproachMN to be modified.\cr Run \code{\link{getAllEarlyEducationInstructionalApproachMNs}} for a list of EarlyEducationInstructionalApproachMNs.
#' @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 Curriculum
#' @return Details of the modified EarlyEducationInstructionalApproachMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyEarlyEducationInstructionalApproachMN <- function(EarlyEducationInstructionalApproachMNID, EntityID = 1, setCurriculumYearID = NULL, setEarlyEducationInstructionalApproachMNIDClonedFrom = NULL, setStateEarlyEducationInstructionalApproachMNID = NULL, setStateImplementationStatusMNID = 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("Curriculum", "EarlyEducationInstructionalApproachMN", EarlyEducationInstructionalApproachMNID, names(functionParams), functionParams, EntityID)
}
#' Create new EarlyEducationInstructionalApproachMN.
#'
#' This function creates a new EarlyEducationInstructionalApproachMN.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created EarlyEducationInstructionalApproachMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createEarlyEducationInstructionalApproachMN <- function(EntityID = 1, setCurriculumYearID = NULL, setEarlyEducationInstructionalApproachMNIDClonedFrom = NULL, setStateEarlyEducationInstructionalApproachMNID = NULL, setStateImplementationStatusMNID = 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("Curriculum", "EarlyEducationInstructionalApproachMN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific EarlyEducationInstructionalApproachMN
#'
#' This function deletes an EarlyEducationInstructionalApproachMN.
#'
#' @param EarlyEducationInstructionalApproachMNID The id of the EarlyEducationInstructionalApproachMN.\cr Run \code{\link{getAllEarlyEducationInstructionalApproachMNs}} for a list of EarlyEducationInstructionalApproachMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted EarlyEducationInstructionalApproachMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteEarlyEducationInstructionalApproachMN <- function(EarlyEducationInstructionalApproachMNID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "EarlyEducationInstructionalApproachMN", EarlyEducationInstructionalApproachMNID, EntityID)
}
#' Get all EarlyEducationProgramMNs.
#'
#' This function returns a dataframe of all EarlyEducationProgramMNs 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 Curriculum
#' @return All EarlyEducationProgramMNs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllEarlyEducationProgramMNs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnEarlyEducationProgramMNID = F, returnCreatedTime = F, returnCurriculumYearID = F, returnEarlyEducationProgramMNIDClonedFrom = F, returnModifiedTime = F, returnStateEarlyEducationProgramMNID = 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("Curriculum", "EarlyEducationProgramMN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific EarlyEducationProgramMN
#'
#' This function returns fields for an EarlyEducationProgramMN.
#'
#' @param EarlyEducationProgramMNID The id of the EarlyEducationProgramMN.\cr Run \code{\link{getAllEarlyEducationProgramMNs}} for a list of EarlyEducationProgramMNs.
#' @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 Curriculum
#' @return Details for the EarlyEducationProgramMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getEarlyEducationProgramMN <- function(EarlyEducationProgramMNID, EntityID = 1, returnEarlyEducationProgramMNID = F, returnCreatedTime = F, returnCurriculumYearID = F, returnEarlyEducationProgramMNIDClonedFrom = F, returnModifiedTime = F, returnStateEarlyEducationProgramMNID = 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("Curriculum", "EarlyEducationProgramMN", EarlyEducationProgramMNID, searchFields, EntityID)
}
#' Modify a specific EarlyEducationProgramMN
#'
#' This function modifies fields for an EarlyEducationProgramMN.
#'
#' @param EarlyEducationProgramMNID The id of the EarlyEducationProgramMN to be modified.\cr Run \code{\link{getAllEarlyEducationProgramMNs}} for a list of EarlyEducationProgramMNs.
#' @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 Curriculum
#' @return Details of the modified EarlyEducationProgramMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyEarlyEducationProgramMN <- function(EarlyEducationProgramMNID, EntityID = 1, setCurriculumYearID = NULL, setEarlyEducationProgramMNIDClonedFrom = NULL, setStateEarlyEducationProgramMNID = 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("Curriculum", "EarlyEducationProgramMN", EarlyEducationProgramMNID, names(functionParams), functionParams, EntityID)
}
#' Create new EarlyEducationProgramMN.
#'
#' This function creates a new EarlyEducationProgramMN.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created EarlyEducationProgramMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createEarlyEducationProgramMN <- function(EntityID = 1, setCurriculumYearID = NULL, setEarlyEducationProgramMNIDClonedFrom = NULL, setStateEarlyEducationProgramMNID = 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("Curriculum", "EarlyEducationProgramMN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific EarlyEducationProgramMN
#'
#' This function deletes an EarlyEducationProgramMN.
#'
#' @param EarlyEducationProgramMNID The id of the EarlyEducationProgramMN.\cr Run \code{\link{getAllEarlyEducationProgramMNs}} for a list of EarlyEducationProgramMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted EarlyEducationProgramMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteEarlyEducationProgramMN <- function(EarlyEducationProgramMNID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "EarlyEducationProgramMN", EarlyEducationProgramMNID, EntityID)
}
#' Get all HierarchyDepths.
#'
#' This function returns a dataframe of all HierarchyDepths 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 Curriculum
#' @return All HierarchyDepths in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllHierarchyDepths <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnHierarchyDepthID = F, returnAcademicStandardSetID = F, returnCode = F, returnCreatedTime = F, returnDepthLevel = F, returnDescription = F, returnDistrictGroupKey = F, returnDynamicRelationshipID = 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("Curriculum", "HierarchyDepth", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific HierarchyDepth
#'
#' This function returns fields for a HierarchyDepth.
#'
#' @param HierarchyDepthID The id of the HierarchyDepth.\cr Run \code{\link{getAllHierarchyDepths}} for a list of HierarchyDepths.
#' @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 Curriculum
#' @return Details for the HierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getHierarchyDepth <- function(HierarchyDepthID, EntityID = 1, returnHierarchyDepthID = F, returnAcademicStandardSetID = F, returnCode = F, returnCreatedTime = F, returnDepthLevel = F, returnDescription = F, returnDistrictGroupKey = F, returnDynamicRelationshipID = 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("Curriculum", "HierarchyDepth", HierarchyDepthID, searchFields, EntityID)
}
#' Modify a specific HierarchyDepth
#'
#' This function modifies fields for a HierarchyDepth.
#'
#' @param HierarchyDepthID The id of the HierarchyDepth to be modified.\cr Run \code{\link{getAllHierarchyDepths}} for a list of HierarchyDepths.
#' @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 Curriculum
#' @return Details of the modified HierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyHierarchyDepth <- function(HierarchyDepthID, EntityID = 1, setAcademicStandardSetID = NULL, setCode = NULL, setDepthLevel = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDynamicRelationshipID = 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("Curriculum", "HierarchyDepth", HierarchyDepthID, names(functionParams), functionParams, EntityID)
}
#' Create new HierarchyDepth.
#'
#' This function creates a new HierarchyDepth.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created HierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createHierarchyDepth <- function(EntityID = 1, setAcademicStandardSetID = NULL, setCode = NULL, setDepthLevel = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDynamicRelationshipID = 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("Curriculum", "HierarchyDepth", names(functionParams), functionParams, EntityID)
}
#' Delete a specific HierarchyDepth
#'
#' This function deletes a HierarchyDepth.
#'
#' @param HierarchyDepthID The id of the HierarchyDepth.\cr Run \code{\link{getAllHierarchyDepths}} for a list of HierarchyDepths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted HierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteHierarchyDepth <- function(HierarchyDepthID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "HierarchyDepth", HierarchyDepthID, EntityID)
}
#' Get all Prerequisites.
#'
#' This function returns a dataframe of all Prerequisites 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 Curriculum
#' @return All Prerequisites in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllPrerequisites <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnPrerequisiteID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnCurriculumID = F, returnDescription = F, returnDistrictGroupKey = F, returnEarnedCredits = F, returnHasPrerequisiteCurriculums = F, returnModifiedTime = F, returnSchoolYearHigh = F, returnSchoolYearLow = 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("Curriculum", "Prerequisite", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Prerequisite
#'
#' This function returns fields for a Prerequisite.
#'
#' @param PrerequisiteID The id of the Prerequisite.\cr Run \code{\link{getAllPrerequisites}} for a list of Prerequisites.
#' @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 Curriculum
#' @return Details for the Prerequisite.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getPrerequisite <- function(PrerequisiteID, EntityID = 1, returnPrerequisiteID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnCurriculumID = F, returnDescription = F, returnDistrictGroupKey = F, returnEarnedCredits = F, returnHasPrerequisiteCurriculums = F, returnModifiedTime = F, returnSchoolYearHigh = F, returnSchoolYearLow = 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("Curriculum", "Prerequisite", PrerequisiteID, searchFields, EntityID)
}
#' Modify a specific Prerequisite
#'
#' This function modifies fields for a Prerequisite.
#'
#' @param PrerequisiteID The id of the Prerequisite to be modified.\cr Run \code{\link{getAllPrerequisites}} for a list of Prerequisites.
#' @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 Curriculum
#' @return Details of the modified Prerequisite.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyPrerequisite <- function(PrerequisiteID, EntityID = 1, setCode = NULL, setCurriculumID = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setEarnedCredits = NULL, setSchoolYearHigh = NULL, setSchoolYearLow = 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("Curriculum", "Prerequisite", PrerequisiteID, names(functionParams), functionParams, EntityID)
}
#' Create new Prerequisite.
#'
#' This function creates a new Prerequisite.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created Prerequisite.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createPrerequisite <- function(EntityID = 1, setCode = NULL, setCurriculumID = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setEarnedCredits = NULL, setSchoolYearHigh = NULL, setSchoolYearLow = 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("Curriculum", "Prerequisite", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Prerequisite
#'
#' This function deletes a Prerequisite.
#'
#' @param PrerequisiteID The id of the Prerequisite.\cr Run \code{\link{getAllPrerequisites}} for a list of Prerequisites.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted Prerequisite.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deletePrerequisite <- function(PrerequisiteID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "Prerequisite", PrerequisiteID, EntityID)
}
#' Get all PrerequisiteCurriculums.
#'
#' This function returns a dataframe of all PrerequisiteCurriculums 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 Curriculum
#' @return All PrerequisiteCurriculums in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllPrerequisiteCurriculums <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnPrerequisiteCurriculumID = F, returnCreatedTime = F, returnCurriculumIDRequired = F, returnModifiedTime = F, returnPrerequisiteID = 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("Curriculum", "PrerequisiteCurriculum", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific PrerequisiteCurriculum
#'
#' This function returns fields for a PrerequisiteCurriculum.
#'
#' @param PrerequisiteCurriculumID The id of the PrerequisiteCurriculum.\cr Run \code{\link{getAllPrerequisiteCurriculums}} for a list of PrerequisiteCurriculums.
#' @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 Curriculum
#' @return Details for the PrerequisiteCurriculum.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getPrerequisiteCurriculum <- function(PrerequisiteCurriculumID, EntityID = 1, returnPrerequisiteCurriculumID = F, returnCreatedTime = F, returnCurriculumIDRequired = F, returnModifiedTime = F, returnPrerequisiteID = 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("Curriculum", "PrerequisiteCurriculum", PrerequisiteCurriculumID, searchFields, EntityID)
}
#' Modify a specific PrerequisiteCurriculum
#'
#' This function modifies fields for a PrerequisiteCurriculum.
#'
#' @param PrerequisiteCurriculumID The id of the PrerequisiteCurriculum to be modified.\cr Run \code{\link{getAllPrerequisiteCurriculums}} for a list of PrerequisiteCurriculums.
#' @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 Curriculum
#' @return Details of the modified PrerequisiteCurriculum.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyPrerequisiteCurriculum <- function(PrerequisiteCurriculumID, EntityID = 1, setCurriculumIDRequired = NULL, setPrerequisiteID = 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("Curriculum", "PrerequisiteCurriculum", PrerequisiteCurriculumID, names(functionParams), functionParams, EntityID)
}
#' Create new PrerequisiteCurriculum.
#'
#' This function creates a new PrerequisiteCurriculum.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created PrerequisiteCurriculum.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createPrerequisiteCurriculum <- function(EntityID = 1, setCurriculumIDRequired = NULL, setPrerequisiteID = 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("Curriculum", "PrerequisiteCurriculum", names(functionParams), functionParams, EntityID)
}
#' Delete a specific PrerequisiteCurriculum
#'
#' This function deletes a PrerequisiteCurriculum.
#'
#' @param PrerequisiteCurriculumID The id of the PrerequisiteCurriculum.\cr Run \code{\link{getAllPrerequisiteCurriculums}} for a list of PrerequisiteCurriculums.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted PrerequisiteCurriculum.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deletePrerequisiteCurriculum <- function(PrerequisiteCurriculumID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "PrerequisiteCurriculum", PrerequisiteCurriculumID, EntityID)
}
#' Get all SiteBasedInitiativeMNs.
#'
#' This function returns a dataframe of all SiteBasedInitiativeMNs 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 Curriculum
#' @return All SiteBasedInitiativeMNs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSiteBasedInitiativeMNs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSiteBasedInitiativeMNID = F, returnCreatedTime = F, returnCurriculumYearID = F, returnModifiedTime = F, returnSiteBasedInitiativeMNIDClonedFrom = F, returnStateImplementationStatusMNID = F, returnStateSiteBasedInitiativeMNID = 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("Curriculum", "SiteBasedInitiativeMN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SiteBasedInitiativeMN
#'
#' This function returns fields for a SiteBasedInitiativeMN.
#'
#' @param SiteBasedInitiativeMNID The id of the SiteBasedInitiativeMN.\cr Run \code{\link{getAllSiteBasedInitiativeMNs}} for a list of SiteBasedInitiativeMNs.
#' @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 Curriculum
#' @return Details for the SiteBasedInitiativeMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSiteBasedInitiativeMN <- function(SiteBasedInitiativeMNID, EntityID = 1, returnSiteBasedInitiativeMNID = F, returnCreatedTime = F, returnCurriculumYearID = F, returnModifiedTime = F, returnSiteBasedInitiativeMNIDClonedFrom = F, returnStateImplementationStatusMNID = F, returnStateSiteBasedInitiativeMNID = 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("Curriculum", "SiteBasedInitiativeMN", SiteBasedInitiativeMNID, searchFields, EntityID)
}
#' Modify a specific SiteBasedInitiativeMN
#'
#' This function modifies fields for a SiteBasedInitiativeMN.
#'
#' @param SiteBasedInitiativeMNID The id of the SiteBasedInitiativeMN to be modified.\cr Run \code{\link{getAllSiteBasedInitiativeMNs}} for a list of SiteBasedInitiativeMNs.
#' @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 Curriculum
#' @return Details of the modified SiteBasedInitiativeMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySiteBasedInitiativeMN <- function(SiteBasedInitiativeMNID, EntityID = 1, setCurriculumYearID = NULL, setSiteBasedInitiativeMNIDClonedFrom = NULL, setStateImplementationStatusMNID = NULL, setStateSiteBasedInitiativeMNID = 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("Curriculum", "SiteBasedInitiativeMN", SiteBasedInitiativeMNID, names(functionParams), functionParams, EntityID)
}
#' Create new SiteBasedInitiativeMN.
#'
#' This function creates a new SiteBasedInitiativeMN.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created SiteBasedInitiativeMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSiteBasedInitiativeMN <- function(EntityID = 1, setCurriculumYearID = NULL, setSiteBasedInitiativeMNIDClonedFrom = NULL, setStateImplementationStatusMNID = NULL, setStateSiteBasedInitiativeMNID = 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("Curriculum", "SiteBasedInitiativeMN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SiteBasedInitiativeMN
#'
#' This function deletes a SiteBasedInitiativeMN.
#'
#' @param SiteBasedInitiativeMNID The id of the SiteBasedInitiativeMN.\cr Run \code{\link{getAllSiteBasedInitiativeMNs}} for a list of SiteBasedInitiativeMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted SiteBasedInitiativeMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSiteBasedInitiativeMN <- function(SiteBasedInitiativeMNID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "SiteBasedInitiativeMN", SiteBasedInitiativeMNID, EntityID)
}
#' Get all StandardPlacementMNs.
#'
#' This function returns a dataframe of all StandardPlacementMNs 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 Curriculum
#' @return All StandardPlacementMNs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStandardPlacementMNs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStandardPlacementMNID = F, returnCreatedTime = F, returnCurriculumYearID = F, returnModifiedTime = F, returnStateStandardCodeMNID = 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("Curriculum", "StandardPlacementMN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StandardPlacementMN
#'
#' This function returns fields for a StandardPlacementMN.
#'
#' @param StandardPlacementMNID The id of the StandardPlacementMN.\cr Run \code{\link{getAllStandardPlacementMNs}} for a list of StandardPlacementMNs.
#' @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 Curriculum
#' @return Details for the StandardPlacementMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStandardPlacementMN <- function(StandardPlacementMNID, EntityID = 1, returnStandardPlacementMNID = F, returnCreatedTime = F, returnCurriculumYearID = F, returnModifiedTime = F, returnStateStandardCodeMNID = 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("Curriculum", "StandardPlacementMN", StandardPlacementMNID, searchFields, EntityID)
}
#' Modify a specific StandardPlacementMN
#'
#' This function modifies fields for a StandardPlacementMN.
#'
#' @param StandardPlacementMNID The id of the StandardPlacementMN to be modified.\cr Run \code{\link{getAllStandardPlacementMNs}} for a list of StandardPlacementMNs.
#' @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 Curriculum
#' @return Details of the modified StandardPlacementMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStandardPlacementMN <- function(StandardPlacementMNID, EntityID = 1, setCurriculumYearID = NULL, setStateStandardCodeMNID = 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("Curriculum", "StandardPlacementMN", StandardPlacementMNID, names(functionParams), functionParams, EntityID)
}
#' Create new StandardPlacementMN.
#'
#' This function creates a new StandardPlacementMN.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created StandardPlacementMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStandardPlacementMN <- function(EntityID = 1, setCurriculumYearID = NULL, setStateStandardCodeMNID = 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("Curriculum", "StandardPlacementMN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StandardPlacementMN
#'
#' This function deletes a StandardPlacementMN.
#'
#' @param StandardPlacementMNID The id of the StandardPlacementMN.\cr Run \code{\link{getAllStandardPlacementMNs}} for a list of StandardPlacementMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted StandardPlacementMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStandardPlacementMN <- function(StandardPlacementMNID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "StandardPlacementMN", StandardPlacementMNID, EntityID)
}
#' Get all Subjects.
#'
#' This function returns a dataframe of all Subjects 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 Curriculum
#' @return All Subjects in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSubjects <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSubjectID = F, returnBackgroundColor = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnIsPrimaryForSelectedCurriculum = F, returnModifiedTime = F, returnNumberOfAttachedCurriculums = F, returnSchoolYearID = F, returnSubjectIDClonedFrom = F, returnSubjectIDClonedTo = F, returnTextColor = 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("Curriculum", "Subject", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Subject
#'
#' This function returns fields for a Subject.
#'
#' @param SubjectID The id of the Subject.\cr Run \code{\link{getAllSubjects}} for a list of Subjects.
#' @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 Curriculum
#' @return Details for the Subject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSubject <- function(SubjectID, EntityID = 1, returnSubjectID = F, returnBackgroundColor = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictGroupKey = F, returnDistrictID = F, returnIsPrimaryForSelectedCurriculum = F, returnModifiedTime = F, returnNumberOfAttachedCurriculums = F, returnSchoolYearID = F, returnSubjectIDClonedFrom = F, returnSubjectIDClonedTo = F, returnTextColor = 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("Curriculum", "Subject", SubjectID, searchFields, EntityID)
}
#' Modify a specific Subject
#'
#' This function modifies fields for a Subject.
#'
#' @param SubjectID The id of the Subject to be modified.\cr Run \code{\link{getAllSubjects}} for a list of Subjects.
#' @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 Curriculum
#' @return Details of the modified Subject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySubject <- function(SubjectID, EntityID = 1, setBackgroundColor = NULL, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setSchoolYearID = NULL, setSubjectIDClonedFrom = NULL, setTextColor = 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("Curriculum", "Subject", SubjectID, names(functionParams), functionParams, EntityID)
}
#' Create new Subject.
#'
#' This function creates a new Subject.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created Subject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSubject <- function(EntityID = 1, setBackgroundColor = NULL, setCode = NULL, setDescription = NULL, setDistrictGroupKey = NULL, setDistrictID = NULL, setSchoolYearID = NULL, setSubjectIDClonedFrom = NULL, setTextColor = 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("Curriculum", "Subject", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Subject
#'
#' This function deletes a Subject.
#'
#' @param SubjectID The id of the Subject.\cr Run \code{\link{getAllSubjects}} for a list of Subjects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted Subject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSubject <- function(SubjectID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "Subject", SubjectID, EntityID)
}
#' Get all TempAcademicStandards.
#'
#' This function returns a dataframe of all TempAcademicStandards 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 Curriculum
#' @return All TempAcademicStandards in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempAcademicStandards <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempAcademicStandardID = F, returnCreatedTime = F, returnDescription = F, returnEnteredByDistrict = F, returnExtendedDescription = F, returnGuid = F, returnImportedFrom = F, returnIsPlaceHolder = F, returnKey = F, returnLabel = F, returnLevel = F, returnModifiedTime = F, returnParentGuid = F, returnSequence = F, returnStateNumber = F, returnTempAcademicStandardGradeRangeID = F, returnTempAcademicStandardIDParent = F, returnTempAcademicStandardSetID = 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("Curriculum", "TempAcademicStandard", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempAcademicStandard
#'
#' This function returns fields for a TempAcademicStandard.
#'
#' @param TempAcademicStandardID The id of the TempAcademicStandard.\cr Run \code{\link{getAllTempAcademicStandards}} for a list of TempAcademicStandards.
#' @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 Curriculum
#' @return Details for the TempAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempAcademicStandard <- function(TempAcademicStandardID, EntityID = 1, returnTempAcademicStandardID = F, returnCreatedTime = F, returnDescription = F, returnEnteredByDistrict = F, returnExtendedDescription = F, returnGuid = F, returnImportedFrom = F, returnIsPlaceHolder = F, returnKey = F, returnLabel = F, returnLevel = F, returnModifiedTime = F, returnParentGuid = F, returnSequence = F, returnStateNumber = F, returnTempAcademicStandardGradeRangeID = F, returnTempAcademicStandardIDParent = F, returnTempAcademicStandardSetID = 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("Curriculum", "TempAcademicStandard", TempAcademicStandardID, searchFields, EntityID)
}
#' Modify a specific TempAcademicStandard
#'
#' This function modifies fields for a TempAcademicStandard.
#'
#' @param TempAcademicStandardID The id of the TempAcademicStandard to be modified.\cr Run \code{\link{getAllTempAcademicStandards}} for a list of TempAcademicStandards.
#' @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 Curriculum
#' @return Details of the modified TempAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempAcademicStandard <- function(TempAcademicStandardID, EntityID = 1, setDescription = NULL, setEnteredByDistrict = NULL, setExtendedDescription = NULL, setGuid = NULL, setImportedFrom = NULL, setIsPlaceHolder = NULL, setKey = NULL, setLabel = NULL, setLevel = NULL, setParentGuid = NULL, setSequence = NULL, setStateNumber = NULL, setTempAcademicStandardGradeRangeID = NULL, setTempAcademicStandardIDParent = NULL, setTempAcademicStandardSetID = 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("Curriculum", "TempAcademicStandard", TempAcademicStandardID, names(functionParams), functionParams, EntityID)
}
#' Create new TempAcademicStandard.
#'
#' This function creates a new TempAcademicStandard.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created TempAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempAcademicStandard <- function(EntityID = 1, setDescription = NULL, setEnteredByDistrict = NULL, setExtendedDescription = NULL, setGuid = NULL, setImportedFrom = NULL, setIsPlaceHolder = NULL, setKey = NULL, setLabel = NULL, setLevel = NULL, setParentGuid = NULL, setSequence = NULL, setStateNumber = NULL, setTempAcademicStandardGradeRangeID = NULL, setTempAcademicStandardIDParent = NULL, setTempAcademicStandardSetID = 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("Curriculum", "TempAcademicStandard", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempAcademicStandard
#'
#' This function deletes a TempAcademicStandard.
#'
#' @param TempAcademicStandardID The id of the TempAcademicStandard.\cr Run \code{\link{getAllTempAcademicStandards}} for a list of TempAcademicStandards.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted TempAcademicStandard.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempAcademicStandard <- function(TempAcademicStandardID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "TempAcademicStandard", TempAcademicStandardID, EntityID)
}
#' Get all TempAcademicStandardGradeRanges.
#'
#' This function returns a dataframe of all TempAcademicStandardGradeRanges 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 Curriculum
#' @return All TempAcademicStandardGradeRanges in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempAcademicStandardGradeRanges <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempAcademicStandardGradeRangeID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnEnteredByDistrict = F, returnGradeRangeHigh = F, returnGradeRangeLow = F, returnGuid = F, returnImportedFrom = F, returnModifiedTime = F, returnSequence = F, returnTempAcademicStandardSubjectID = 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("Curriculum", "TempAcademicStandardGradeRange", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempAcademicStandardGradeRange
#'
#' This function returns fields for a TempAcademicStandardGradeRange.
#'
#' @param TempAcademicStandardGradeRangeID The id of the TempAcademicStandardGradeRange.\cr Run \code{\link{getAllTempAcademicStandardGradeRanges}} for a list of TempAcademicStandardGradeRanges.
#' @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 Curriculum
#' @return Details for the TempAcademicStandardGradeRange.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempAcademicStandardGradeRange <- function(TempAcademicStandardGradeRangeID, EntityID = 1, returnTempAcademicStandardGradeRangeID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnEnteredByDistrict = F, returnGradeRangeHigh = F, returnGradeRangeLow = F, returnGuid = F, returnImportedFrom = F, returnModifiedTime = F, returnSequence = F, returnTempAcademicStandardSubjectID = 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("Curriculum", "TempAcademicStandardGradeRange", TempAcademicStandardGradeRangeID, searchFields, EntityID)
}
#' Modify a specific TempAcademicStandardGradeRange
#'
#' This function modifies fields for a TempAcademicStandardGradeRange.
#'
#' @param TempAcademicStandardGradeRangeID The id of the TempAcademicStandardGradeRange to be modified.\cr Run \code{\link{getAllTempAcademicStandardGradeRanges}} for a list of TempAcademicStandardGradeRanges.
#' @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 Curriculum
#' @return Details of the modified TempAcademicStandardGradeRange.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempAcademicStandardGradeRange <- function(TempAcademicStandardGradeRangeID, EntityID = 1, setCode = NULL, setDescription = NULL, setEnteredByDistrict = NULL, setGradeRangeHigh = NULL, setGradeRangeLow = NULL, setGuid = NULL, setImportedFrom = NULL, setSequence = NULL, setTempAcademicStandardSubjectID = 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("Curriculum", "TempAcademicStandardGradeRange", TempAcademicStandardGradeRangeID, names(functionParams), functionParams, EntityID)
}
#' Create new TempAcademicStandardGradeRange.
#'
#' This function creates a new TempAcademicStandardGradeRange.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created TempAcademicStandardGradeRange.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempAcademicStandardGradeRange <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setEnteredByDistrict = NULL, setGradeRangeHigh = NULL, setGradeRangeLow = NULL, setGuid = NULL, setImportedFrom = NULL, setSequence = NULL, setTempAcademicStandardSubjectID = 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("Curriculum", "TempAcademicStandardGradeRange", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempAcademicStandardGradeRange
#'
#' This function deletes a TempAcademicStandardGradeRange.
#'
#' @param TempAcademicStandardGradeRangeID The id of the TempAcademicStandardGradeRange.\cr Run \code{\link{getAllTempAcademicStandardGradeRanges}} for a list of TempAcademicStandardGradeRanges.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted TempAcademicStandardGradeRange.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempAcademicStandardGradeRange <- function(TempAcademicStandardGradeRangeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "TempAcademicStandardGradeRange", TempAcademicStandardGradeRangeID, EntityID)
}
#' Get all TempAcademicStandardSets.
#'
#' This function returns a dataframe of all TempAcademicStandardSets 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 Curriculum
#' @return All TempAcademicStandardSets in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempAcademicStandardSets <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempAcademicStandardSetID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnEnteredByDistrict = F, returnImportedFrom = F, returnIsActive = F, returnModifiedTime = F, returnStateCode = 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("Curriculum", "TempAcademicStandardSet", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempAcademicStandardSet
#'
#' This function returns fields for a TempAcademicStandardSet.
#'
#' @param TempAcademicStandardSetID The id of the TempAcademicStandardSet.\cr Run \code{\link{getAllTempAcademicStandardSets}} for a list of TempAcademicStandardSets.
#' @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 Curriculum
#' @return Details for the TempAcademicStandardSet.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempAcademicStandardSet <- function(TempAcademicStandardSetID, EntityID = 1, returnTempAcademicStandardSetID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnEnteredByDistrict = F, returnImportedFrom = F, returnIsActive = F, returnModifiedTime = F, returnStateCode = 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("Curriculum", "TempAcademicStandardSet", TempAcademicStandardSetID, searchFields, EntityID)
}
#' Modify a specific TempAcademicStandardSet
#'
#' This function modifies fields for a TempAcademicStandardSet.
#'
#' @param TempAcademicStandardSetID The id of the TempAcademicStandardSet to be modified.\cr Run \code{\link{getAllTempAcademicStandardSets}} for a list of TempAcademicStandardSets.
#' @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 Curriculum
#' @return Details of the modified TempAcademicStandardSet.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempAcademicStandardSet <- function(TempAcademicStandardSetID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setEnteredByDistrict = NULL, setImportedFrom = NULL, setIsActive = NULL, setStateCode = 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("Curriculum", "TempAcademicStandardSet", TempAcademicStandardSetID, names(functionParams), functionParams, EntityID)
}
#' Create new TempAcademicStandardSet.
#'
#' This function creates a new TempAcademicStandardSet.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created TempAcademicStandardSet.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempAcademicStandardSet <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setEnteredByDistrict = NULL, setImportedFrom = NULL, setIsActive = NULL, setStateCode = 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("Curriculum", "TempAcademicStandardSet", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempAcademicStandardSet
#'
#' This function deletes a TempAcademicStandardSet.
#'
#' @param TempAcademicStandardSetID The id of the TempAcademicStandardSet.\cr Run \code{\link{getAllTempAcademicStandardSets}} for a list of TempAcademicStandardSets.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted TempAcademicStandardSet.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempAcademicStandardSet <- function(TempAcademicStandardSetID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "TempAcademicStandardSet", TempAcademicStandardSetID, EntityID)
}
#' Get all TempAcademicStandardSubjects.
#'
#' This function returns a dataframe of all TempAcademicStandardSubjects 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 Curriculum
#' @return All TempAcademicStandardSubjects in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempAcademicStandardSubjects <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempAcademicStandardSubjectID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnEnteredByDistrict = F, returnImportedFrom = F, returnModifiedTime = F, returnSequence = F, returnTempAcademicStandardSetID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnYear = 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("Curriculum", "TempAcademicStandardSubject", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempAcademicStandardSubject
#'
#' This function returns fields for a TempAcademicStandardSubject.
#'
#' @param TempAcademicStandardSubjectID The id of the TempAcademicStandardSubject.\cr Run \code{\link{getAllTempAcademicStandardSubjects}} for a list of TempAcademicStandardSubjects.
#' @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 Curriculum
#' @return Details for the TempAcademicStandardSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempAcademicStandardSubject <- function(TempAcademicStandardSubjectID, EntityID = 1, returnTempAcademicStandardSubjectID = F, returnCode = F, returnCreatedTime = F, returnDescription = F, returnEnteredByDistrict = F, returnImportedFrom = F, returnModifiedTime = F, returnSequence = F, returnTempAcademicStandardSetID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnYear = 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("Curriculum", "TempAcademicStandardSubject", TempAcademicStandardSubjectID, searchFields, EntityID)
}
#' Modify a specific TempAcademicStandardSubject
#'
#' This function modifies fields for a TempAcademicStandardSubject.
#'
#' @param TempAcademicStandardSubjectID The id of the TempAcademicStandardSubject to be modified.\cr Run \code{\link{getAllTempAcademicStandardSubjects}} for a list of TempAcademicStandardSubjects.
#' @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 Curriculum
#' @return Details of the modified TempAcademicStandardSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempAcademicStandardSubject <- function(TempAcademicStandardSubjectID, EntityID = 1, setCode = NULL, setDescription = NULL, setEnteredByDistrict = NULL, setImportedFrom = NULL, setSequence = NULL, setTempAcademicStandardSetID = NULL, setYear = 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("Curriculum", "TempAcademicStandardSubject", TempAcademicStandardSubjectID, names(functionParams), functionParams, EntityID)
}
#' Create new TempAcademicStandardSubject.
#'
#' This function creates a new TempAcademicStandardSubject.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created TempAcademicStandardSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempAcademicStandardSubject <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setEnteredByDistrict = NULL, setImportedFrom = NULL, setSequence = NULL, setTempAcademicStandardSetID = NULL, setYear = 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("Curriculum", "TempAcademicStandardSubject", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempAcademicStandardSubject
#'
#' This function deletes a TempAcademicStandardSubject.
#'
#' @param TempAcademicStandardSubjectID The id of the TempAcademicStandardSubject.\cr Run \code{\link{getAllTempAcademicStandardSubjects}} for a list of TempAcademicStandardSubjects.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted TempAcademicStandardSubject.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempAcademicStandardSubject <- function(TempAcademicStandardSubjectID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "TempAcademicStandardSubject", TempAcademicStandardSubjectID, EntityID)
}
#' Get all TempGradeRangeCopyResults.
#'
#' This function returns a dataframe of all TempGradeRangeCopyResults 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 Curriculum
#' @return All TempGradeRangeCopyResults in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempGradeRangeCopyResults <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempGradeRangeCopyResultID = F, returnAcademicStandardSubjectCode = F, returnCreatedTime = F, returnErrorText = F, returnGradeRangeCode = F, returnIsError = 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("Curriculum", "TempGradeRangeCopyResult", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempGradeRangeCopyResult
#'
#' This function returns fields for a TempGradeRangeCopyResult.
#'
#' @param TempGradeRangeCopyResultID The id of the TempGradeRangeCopyResult.\cr Run \code{\link{getAllTempGradeRangeCopyResults}} for a list of TempGradeRangeCopyResults.
#' @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 Curriculum
#' @return Details for the TempGradeRangeCopyResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempGradeRangeCopyResult <- function(TempGradeRangeCopyResultID, EntityID = 1, returnTempGradeRangeCopyResultID = F, returnAcademicStandardSubjectCode = F, returnCreatedTime = F, returnErrorText = F, returnGradeRangeCode = F, returnIsError = 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("Curriculum", "TempGradeRangeCopyResult", TempGradeRangeCopyResultID, searchFields, EntityID)
}
#' Modify a specific TempGradeRangeCopyResult
#'
#' This function modifies fields for a TempGradeRangeCopyResult.
#'
#' @param TempGradeRangeCopyResultID The id of the TempGradeRangeCopyResult to be modified.\cr Run \code{\link{getAllTempGradeRangeCopyResults}} for a list of TempGradeRangeCopyResults.
#' @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 Curriculum
#' @return Details of the modified TempGradeRangeCopyResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempGradeRangeCopyResult <- function(TempGradeRangeCopyResultID, EntityID = 1, setAcademicStandardSubjectCode = NULL, setErrorText = NULL, setGradeRangeCode = NULL, setIsError = 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("Curriculum", "TempGradeRangeCopyResult", TempGradeRangeCopyResultID, names(functionParams), functionParams, EntityID)
}
#' Create new TempGradeRangeCopyResult.
#'
#' This function creates a new TempGradeRangeCopyResult.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created TempGradeRangeCopyResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempGradeRangeCopyResult <- function(EntityID = 1, setAcademicStandardSubjectCode = NULL, setErrorText = NULL, setGradeRangeCode = NULL, setIsError = 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("Curriculum", "TempGradeRangeCopyResult", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempGradeRangeCopyResult
#'
#' This function deletes a TempGradeRangeCopyResult.
#'
#' @param TempGradeRangeCopyResultID The id of the TempGradeRangeCopyResult.\cr Run \code{\link{getAllTempGradeRangeCopyResults}} for a list of TempGradeRangeCopyResults.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted TempGradeRangeCopyResult.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempGradeRangeCopyResult <- function(TempGradeRangeCopyResultID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "TempGradeRangeCopyResult", TempGradeRangeCopyResultID, EntityID)
}
#' Get all TempHierarchyDepths.
#'
#' This function returns a dataframe of all TempHierarchyDepths 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 Curriculum
#' @return All TempHierarchyDepths in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempHierarchyDepths <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempHierarchyDepthID = F, returnAcademicStandardSetCode = F, returnAcademicStandardSetDescription = F, returnCode = F, returnCreatedTime = F, returnDepthLevel = 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("Curriculum", "TempHierarchyDepth", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempHierarchyDepth
#'
#' This function returns fields for a TempHierarchyDepth.
#'
#' @param TempHierarchyDepthID The id of the TempHierarchyDepth.\cr Run \code{\link{getAllTempHierarchyDepths}} for a list of TempHierarchyDepths.
#' @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 Curriculum
#' @return Details for the TempHierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempHierarchyDepth <- function(TempHierarchyDepthID, EntityID = 1, returnTempHierarchyDepthID = F, returnAcademicStandardSetCode = F, returnAcademicStandardSetDescription = F, returnCode = F, returnCreatedTime = F, returnDepthLevel = 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("Curriculum", "TempHierarchyDepth", TempHierarchyDepthID, searchFields, EntityID)
}
#' Modify a specific TempHierarchyDepth
#'
#' This function modifies fields for a TempHierarchyDepth.
#'
#' @param TempHierarchyDepthID The id of the TempHierarchyDepth to be modified.\cr Run \code{\link{getAllTempHierarchyDepths}} for a list of TempHierarchyDepths.
#' @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 Curriculum
#' @return Details of the modified TempHierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempHierarchyDepth <- function(TempHierarchyDepthID, EntityID = 1, setAcademicStandardSetCode = NULL, setAcademicStandardSetDescription = NULL, setCode = NULL, setDepthLevel = 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("Curriculum", "TempHierarchyDepth", TempHierarchyDepthID, names(functionParams), functionParams, EntityID)
}
#' Create new TempHierarchyDepth.
#'
#' This function creates a new TempHierarchyDepth.
#'
#' @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 Curriculum
#' @return The fields used to define the newly created TempHierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempHierarchyDepth <- function(EntityID = 1, setAcademicStandardSetCode = NULL, setAcademicStandardSetDescription = NULL, setCode = NULL, setDepthLevel = 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("Curriculum", "TempHierarchyDepth", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempHierarchyDepth
#'
#' This function deletes a TempHierarchyDepth.
#'
#' @param TempHierarchyDepthID The id of the TempHierarchyDepth.\cr Run \code{\link{getAllTempHierarchyDepths}} for a list of TempHierarchyDepths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Curriculum
#' @return The id of the deleted TempHierarchyDepth.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempHierarchyDepth <- function(TempHierarchyDepthID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Curriculum", "TempHierarchyDepth", TempHierarchyDepthID, EntityID)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.