#' Get all ActionAttendanceTypes.
#'
#' This function returns a dataframe of all ActionAttendanceTypes 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 Discipline
#' @return All ActionAttendanceTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllActionAttendanceTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnActionAttendanceTypeID = F, returnActionID = F, returnAttendanceTypeID = F, returnCreatedTime = F, returnEntityGroupKey = F, returnIsReadOnlyHistoricalRecord = 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("Discipline", "ActionAttendanceType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ActionAttendanceType
#'
#' This function returns fields for an ActionAttendanceType.
#'
#' @param ActionAttendanceTypeID The id of the ActionAttendanceType.\cr Run \code{\link{getAllActionAttendanceTypes}} for a list of ActionAttendanceTypes.
#' @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 Discipline
#' @return Details for the ActionAttendanceType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getActionAttendanceType <- function(ActionAttendanceTypeID, EntityID = 1, returnActionAttendanceTypeID = F, returnActionID = F, returnAttendanceTypeID = F, returnCreatedTime = F, returnEntityGroupKey = F, returnIsReadOnlyHistoricalRecord = 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("Discipline", "ActionAttendanceType", ActionAttendanceTypeID, searchFields, EntityID)
}
#' Modify a specific ActionAttendanceType
#'
#' This function modifies fields for an ActionAttendanceType.
#'
#' @param ActionAttendanceTypeID The id of the ActionAttendanceType to be modified.\cr Run \code{\link{getAllActionAttendanceTypes}} for a list of ActionAttendanceTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified ActionAttendanceType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyActionAttendanceType <- function(ActionAttendanceTypeID, EntityID = 1, setActionID = NULL, setAttendanceTypeID = NULL, setEntityGroupKey = 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("Discipline", "ActionAttendanceType", ActionAttendanceTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new ActionAttendanceType.
#'
#' This function creates a new ActionAttendanceType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created ActionAttendanceType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createActionAttendanceType <- function(EntityID = 1, setActionID = NULL, setAttendanceTypeID = NULL, setEntityGroupKey = 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("Discipline", "ActionAttendanceType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ActionAttendanceType
#'
#' This function deletes an ActionAttendanceType.
#'
#' @param ActionAttendanceTypeID The id of the ActionAttendanceType.\cr Run \code{\link{getAllActionAttendanceTypes}} for a list of ActionAttendanceTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted ActionAttendanceType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteActionAttendanceType <- function(ActionAttendanceTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "ActionAttendanceType", ActionAttendanceTypeID, EntityID)
}
#' Get all Actions.
#'
#' This function returns a dataframe of all Actions 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 Discipline
#' @return All Actions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllActions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnActionID = F, returnActionIDClonedFrom = F, returnActionMNID = F, returnActionTypeID = F, returnCode = F, returnCodeDescription = F, returnCreateAttendanceForActionDetail = F, returnCreatedTime = F, returnDefaultDuration = F, returnDefaultLocationID = F, returnDescription = F, returnDistrictID = F, returnDurationType = F, returnDurationTypeCode = F, returnFederalDisciplineCategoryID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnRestraintSeclusion = F, returnRestraintSeclusionCode = F, returnSchoolYearID = F, returnStateActionTypeMNID = F, returnSuppressCreationOfActionDetails = F, returnTransferToAlternativeSchool = 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("Discipline", "Action", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Action
#'
#' This function returns fields for an Action.
#'
#' @param ActionID The id of the Action.\cr Run \code{\link{getAllActions}} for a list of Actions.
#' @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 Discipline
#' @return Details for the Action.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAction <- function(ActionID, EntityID = 1, returnActionID = F, returnActionIDClonedFrom = F, returnActionMNID = F, returnActionTypeID = F, returnCode = F, returnCodeDescription = F, returnCreateAttendanceForActionDetail = F, returnCreatedTime = F, returnDefaultDuration = F, returnDefaultLocationID = F, returnDescription = F, returnDistrictID = F, returnDurationType = F, returnDurationTypeCode = F, returnFederalDisciplineCategoryID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnRestraintSeclusion = F, returnRestraintSeclusionCode = F, returnSchoolYearID = F, returnStateActionTypeMNID = F, returnSuppressCreationOfActionDetails = F, returnTransferToAlternativeSchool = 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("Discipline", "Action", ActionID, searchFields, EntityID)
}
#' Modify a specific Action
#'
#' This function modifies fields for an Action.
#'
#' @param ActionID The id of the Action to be modified.\cr Run \code{\link{getAllActions}} for a list of Actions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified Action.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyAction <- function(ActionID, EntityID = 1, setActionIDClonedFrom = NULL, setActionTypeID = NULL, setCode = NULL, setCreateAttendanceForActionDetail = NULL, setDefaultDuration = NULL, setDefaultLocationID = NULL, setDescription = NULL, setDistrictID = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setFederalDisciplineCategoryID = NULL, setRestraintSeclusion = NULL, setRestraintSeclusionCode = NULL, setSchoolYearID = NULL, setStateActionTypeMNID = NULL, setSuppressCreationOfActionDetails = NULL, setTransferToAlternativeSchool = 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("Discipline", "Action", ActionID, names(functionParams), functionParams, EntityID)
}
#' Create new Action.
#'
#' This function creates a new Action.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created Action.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createAction <- function(EntityID = 1, setActionIDClonedFrom = NULL, setActionTypeID = NULL, setCode = NULL, setCreateAttendanceForActionDetail = NULL, setDefaultDuration = NULL, setDefaultLocationID = NULL, setDescription = NULL, setDistrictID = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setFederalDisciplineCategoryID = NULL, setRestraintSeclusion = NULL, setRestraintSeclusionCode = NULL, setSchoolYearID = NULL, setStateActionTypeMNID = NULL, setSuppressCreationOfActionDetails = NULL, setTransferToAlternativeSchool = 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("Discipline", "Action", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Action
#'
#' This function deletes an Action.
#'
#' @param ActionID The id of the Action.\cr Run \code{\link{getAllActions}} for a list of Actions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted Action.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteAction <- function(ActionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "Action", ActionID, EntityID)
}
#' Get all ActionTypes.
#'
#' This function returns a dataframe of all ActionTypes 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 Discipline
#' @return All ActionTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllActionTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnActionTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnIsInvalid = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValidYearHigh = F, returnValidYearLow = 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("Discipline", "ActionType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ActionType
#'
#' This function returns fields for an ActionType.
#'
#' @param ActionTypeID The id of the ActionType.\cr Run \code{\link{getAllActionTypes}} for a list of ActionTypes.
#' @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 Discipline
#' @return Details for the ActionType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getActionType <- function(ActionTypeID, EntityID = 1, returnActionTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnIsInvalid = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValidYearHigh = F, returnValidYearLow = 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("Discipline", "ActionType", ActionTypeID, searchFields, EntityID)
}
#' Modify a specific ActionType
#'
#' This function modifies fields for an ActionType.
#'
#' @param ActionTypeID The id of the ActionType to be modified.\cr Run \code{\link{getAllActionTypes}} for a list of ActionTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified ActionType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyActionType <- function(ActionTypeID, EntityID = 1, setCode = NULL, setDescription = NULL, setIsInvalid = NULL, setSkywardHash = NULL, setSkywardID = NULL, setValidYearHigh = NULL, setValidYearLow = 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("Discipline", "ActionType", ActionTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new ActionType.
#'
#' This function creates a new ActionType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created ActionType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createActionType <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setIsInvalid = NULL, setSkywardHash = NULL, setSkywardID = NULL, setValidYearHigh = NULL, setValidYearLow = 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("Discipline", "ActionType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ActionType
#'
#' This function deletes an ActionType.
#'
#' @param ActionTypeID The id of the ActionType.\cr Run \code{\link{getAllActionTypes}} for a list of ActionTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted ActionType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteActionType <- function(ActionTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "ActionType", ActionTypeID, EntityID)
}
#' Get all ConfigDistrictYears.
#'
#' This function returns a dataframe of all ConfigDistrictYears in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept Discipline
#' @return All ConfigDistrictYears in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigDistrictYears <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigDistrictYearID = F, returnAllowActionRecommendationsOnReferrals = F, returnAllowActionTypeUpdate = F, returnAllowDurationTypeUpdate = F, returnAllowOnlyOneOffensePerIncident = F, returnAllowUseOfWarning = F, returnConfigDistrictYearIDClonedFrom = F, returnCreatedTime = F, returnDaysToDelayDisplayOfIncidentsInFamilyAndStudentAccess = F, returnDefaultActionStatus = F, returnDefaultActionStatusCode = F, returnDefaultActionValueFromPreviousPerson = F, returnDefaultDisciplineScreenDateAndTimes = F, returnDefaultGuardianNotifiedOnActionDetailFromAction = F, returnDefaultOffenseValueFromPreviousPerson = F, returnDisplayInvolvedPersonsFromAllEntities = F, returnDisplayStudentOffensesForAllEntities = F, returnDisplayWarningsInFamilyAndStudentAccess = F, returnDistrictID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnRestartIncidentNumberThisYear = F, returnSchoolYearID = F, returnUseIncidentBuildingAndRoom = F, returnUsePerceivedMotivation = 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("Discipline", "ConfigDistrictYear", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ConfigDistrictYear
#'
#' This function returns fields for a ConfigDistrictYear.
#'
#' @param ConfigDistrictYearID The id of the ConfigDistrictYear.\cr Run \code{\link{getAllConfigDistrictYears}} for a list of ConfigDistrictYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept Discipline
#' @return Details for the ConfigDistrictYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigDistrictYear <- function(ConfigDistrictYearID, EntityID = 1, returnConfigDistrictYearID = F, returnAllowActionRecommendationsOnReferrals = F, returnAllowActionTypeUpdate = F, returnAllowDurationTypeUpdate = F, returnAllowOnlyOneOffensePerIncident = F, returnAllowUseOfWarning = F, returnConfigDistrictYearIDClonedFrom = F, returnCreatedTime = F, returnDaysToDelayDisplayOfIncidentsInFamilyAndStudentAccess = F, returnDefaultActionStatus = F, returnDefaultActionStatusCode = F, returnDefaultActionValueFromPreviousPerson = F, returnDefaultDisciplineScreenDateAndTimes = F, returnDefaultGuardianNotifiedOnActionDetailFromAction = F, returnDefaultOffenseValueFromPreviousPerson = F, returnDisplayInvolvedPersonsFromAllEntities = F, returnDisplayStudentOffensesForAllEntities = F, returnDisplayWarningsInFamilyAndStudentAccess = F, returnDistrictID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnRestartIncidentNumberThisYear = F, returnSchoolYearID = F, returnUseIncidentBuildingAndRoom = F, returnUsePerceivedMotivation = 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("Discipline", "ConfigDistrictYear", ConfigDistrictYearID, searchFields, EntityID)
}
#' Modify a specific ConfigDistrictYear
#'
#' This function modifies fields for a ConfigDistrictYear.
#'
#' @param ConfigDistrictYearID The id of the ConfigDistrictYear to be modified.\cr Run \code{\link{getAllConfigDistrictYears}} for a list of ConfigDistrictYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified ConfigDistrictYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigDistrictYear <- function(ConfigDistrictYearID, EntityID = 1, setAllowActionRecommendationsOnReferrals = NULL, setAllowActionTypeUpdate = NULL, setAllowDurationTypeUpdate = NULL, setAllowOnlyOneOffensePerIncident = NULL, setAllowUseOfWarning = NULL, setConfigDistrictYearIDClonedFrom = NULL, setDaysToDelayDisplayOfIncidentsInFamilyAndStudentAccess = NULL, setDefaultActionStatus = NULL, setDefaultActionStatusCode = NULL, setDefaultActionValueFromPreviousPerson = NULL, setDefaultDisciplineScreenDateAndTimes = NULL, setDefaultGuardianNotifiedOnActionDetailFromAction = NULL, setDefaultOffenseValueFromPreviousPerson = NULL, setDisplayInvolvedPersonsFromAllEntities = NULL, setDisplayStudentOffensesForAllEntities = NULL, setDisplayWarningsInFamilyAndStudentAccess = NULL, setDistrictID = NULL, setRestartIncidentNumberThisYear = NULL, setSchoolYearID = NULL, setUseIncidentBuildingAndRoom = NULL, setUsePerceivedMotivation = 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("Discipline", "ConfigDistrictYear", ConfigDistrictYearID, names(functionParams), functionParams, EntityID)
}
#' Create new ConfigDistrictYear.
#'
#' This function creates a new ConfigDistrictYear.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created ConfigDistrictYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createConfigDistrictYear <- function(EntityID = 1, setAllowActionRecommendationsOnReferrals = NULL, setAllowActionTypeUpdate = NULL, setAllowDurationTypeUpdate = NULL, setAllowOnlyOneOffensePerIncident = NULL, setAllowUseOfWarning = NULL, setConfigDistrictYearIDClonedFrom = NULL, setDaysToDelayDisplayOfIncidentsInFamilyAndStudentAccess = NULL, setDefaultActionStatus = NULL, setDefaultActionStatusCode = NULL, setDefaultActionValueFromPreviousPerson = NULL, setDefaultDisciplineScreenDateAndTimes = NULL, setDefaultGuardianNotifiedOnActionDetailFromAction = NULL, setDefaultOffenseValueFromPreviousPerson = NULL, setDisplayInvolvedPersonsFromAllEntities = NULL, setDisplayStudentOffensesForAllEntities = NULL, setDisplayWarningsInFamilyAndStudentAccess = NULL, setDistrictID = NULL, setRestartIncidentNumberThisYear = NULL, setSchoolYearID = NULL, setUseIncidentBuildingAndRoom = NULL, setUsePerceivedMotivation = 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("Discipline", "ConfigDistrictYear", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ConfigDistrictYear
#'
#' This function deletes a ConfigDistrictYear.
#'
#' @param ConfigDistrictYearID The id of the ConfigDistrictYear.\cr Run \code{\link{getAllConfigDistrictYears}} for a list of ConfigDistrictYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted ConfigDistrictYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigDistrictYear <- function(ConfigDistrictYearID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "ConfigDistrictYear", ConfigDistrictYearID, EntityID)
}
#' Get all ConfigEntityGroupYears.
#'
#' This function returns a dataframe of all ConfigEntityGroupYears in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept Discipline
#' @return All ConfigEntityGroupYears in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigEntityGroupYearsDiscipline <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigEntityGroupYearID = F, returnActionStatusDefaultValue = F, returnActionStatusDefaultValueCode = F, returnConfigEntityGroupYearIDClonedFrom = F, returnCreatedTime = F, returnDefaultActionStatusCode = F, returnDetentionsOnFri = F, returnDetentionsOnMon = F, returnDetentionsOnSat = F, returnDetentionsOnSun = F, returnDetentionsOnThu = F, returnDetentionsOnTue = F, returnDetentionsOnWed = F, returnEntityGroupKey = F, returnEntityID = F, returnExpulsionsOnFri = F, returnExpulsionsOnMon = F, returnExpulsionsOnSat = F, returnExpulsionsOnSun = F, returnExpulsionsOnThu = F, returnExpulsionsOnTue = F, returnExpulsionsOnWed = F, returnIncludeDisciplinaryActionAndDetailsOnLetter = F, returnIncludeGradeLevelOnLetter = F, returnIncludeParentNameAndOrPhoneNumberOnLetter = F, returnIncludeSchoolOrCampusOnLetter = F, returnIncludeSignatureLineForOfficeOnLetter = F, returnIncludeSignatureLineForParentOnLetter = F, returnIncludeSignatureLineForStudentOnLetter = F, returnIncludeStudentNameAndOrNumberOnLetter = F, returnInSchoolSuspensionsOnFri = F, returnInSchoolSuspensionsOnMon = F, returnInSchoolSuspensionsOnSat = F, returnInSchoolSuspensionsOnSun = F, returnInSchoolSuspensionsOnThu = F, returnInSchoolSuspensionsOnTue = F, returnInSchoolSuspensionsOnWed = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnOutOfSchoolSuspensionsOnFri = F, returnOutOfSchoolSuspensionsOnMon = F, returnOutOfSchoolSuspensionsOnSat = F, returnOutOfSchoolSuspensionsOnSun = F, returnOutOfSchoolSuspensionsOnThu = F, returnOutOfSchoolSuspensionsOnTue = F, returnOutOfSchoolSuspensionsOnWed = F, returnSchoolYearID = F, returnTardyKioskDisciplineSlipTitle = F, returnUseAlternateActionDetails = 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("Discipline", "ConfigEntityGroupYear", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ConfigEntityGroupYear
#'
#' This function returns fields for a ConfigEntityGroupYear.
#'
#' @param ConfigEntityGroupYearID The id of the ConfigEntityGroupYear.\cr Run \code{\link{getAllConfigEntityGroupYears}} for a list of ConfigEntityGroupYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept Discipline
#' @return Details for the ConfigEntityGroupYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigEntityGroupYearDiscipline <- function(ConfigEntityGroupYearID, EntityID = 1, returnConfigEntityGroupYearID = F, returnActionStatusDefaultValue = F, returnActionStatusDefaultValueCode = F, returnConfigEntityGroupYearIDClonedFrom = F, returnCreatedTime = F, returnDefaultActionStatusCode = F, returnDetentionsOnFri = F, returnDetentionsOnMon = F, returnDetentionsOnSat = F, returnDetentionsOnSun = F, returnDetentionsOnThu = F, returnDetentionsOnTue = F, returnDetentionsOnWed = F, returnEntityGroupKey = F, returnEntityID = F, returnExpulsionsOnFri = F, returnExpulsionsOnMon = F, returnExpulsionsOnSat = F, returnExpulsionsOnSun = F, returnExpulsionsOnThu = F, returnExpulsionsOnTue = F, returnExpulsionsOnWed = F, returnIncludeDisciplinaryActionAndDetailsOnLetter = F, returnIncludeGradeLevelOnLetter = F, returnIncludeParentNameAndOrPhoneNumberOnLetter = F, returnIncludeSchoolOrCampusOnLetter = F, returnIncludeSignatureLineForOfficeOnLetter = F, returnIncludeSignatureLineForParentOnLetter = F, returnIncludeSignatureLineForStudentOnLetter = F, returnIncludeStudentNameAndOrNumberOnLetter = F, returnInSchoolSuspensionsOnFri = F, returnInSchoolSuspensionsOnMon = F, returnInSchoolSuspensionsOnSat = F, returnInSchoolSuspensionsOnSun = F, returnInSchoolSuspensionsOnThu = F, returnInSchoolSuspensionsOnTue = F, returnInSchoolSuspensionsOnWed = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnOutOfSchoolSuspensionsOnFri = F, returnOutOfSchoolSuspensionsOnMon = F, returnOutOfSchoolSuspensionsOnSat = F, returnOutOfSchoolSuspensionsOnSun = F, returnOutOfSchoolSuspensionsOnThu = F, returnOutOfSchoolSuspensionsOnTue = F, returnOutOfSchoolSuspensionsOnWed = F, returnSchoolYearID = F, returnTardyKioskDisciplineSlipTitle = F, returnUseAlternateActionDetails = 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("Discipline", "ConfigEntityGroupYear", ConfigEntityGroupYearID, searchFields, EntityID)
}
#' Modify a specific ConfigEntityGroupYear
#'
#' This function modifies fields for a ConfigEntityGroupYear.
#'
#' @param ConfigEntityGroupYearID The id of the ConfigEntityGroupYear to be modified.\cr Run \code{\link{getAllConfigEntityGroupYears}} for a list of ConfigEntityGroupYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified ConfigEntityGroupYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigEntityGroupYearDiscipline <- function(ConfigEntityGroupYearID, EntityID = 1, setActionStatusDefaultValue = NULL, setActionStatusDefaultValueCode = NULL, setConfigEntityGroupYearIDClonedFrom = NULL, setDefaultActionStatusCode = NULL, setDetentionsOnFri = NULL, setDetentionsOnMon = NULL, setDetentionsOnSat = NULL, setDetentionsOnSun = NULL, setDetentionsOnThu = NULL, setDetentionsOnTue = NULL, setDetentionsOnWed = NULL, setEntityGroupKey = NULL, setEntityID = NULL, setExpulsionsOnFri = NULL, setExpulsionsOnMon = NULL, setExpulsionsOnSat = NULL, setExpulsionsOnSun = NULL, setExpulsionsOnThu = NULL, setExpulsionsOnTue = NULL, setExpulsionsOnWed = NULL, setIncludeDisciplinaryActionAndDetailsOnLetter = NULL, setIncludeGradeLevelOnLetter = NULL, setIncludeParentNameAndOrPhoneNumberOnLetter = NULL, setIncludeSchoolOrCampusOnLetter = NULL, setIncludeSignatureLineForOfficeOnLetter = NULL, setIncludeSignatureLineForParentOnLetter = NULL, setIncludeSignatureLineForStudentOnLetter = NULL, setIncludeStudentNameAndOrNumberOnLetter = NULL, setInSchoolSuspensionsOnFri = NULL, setInSchoolSuspensionsOnMon = NULL, setInSchoolSuspensionsOnSat = NULL, setInSchoolSuspensionsOnSun = NULL, setInSchoolSuspensionsOnThu = NULL, setInSchoolSuspensionsOnTue = NULL, setInSchoolSuspensionsOnWed = NULL, setOutOfSchoolSuspensionsOnFri = NULL, setOutOfSchoolSuspensionsOnMon = NULL, setOutOfSchoolSuspensionsOnSat = NULL, setOutOfSchoolSuspensionsOnSun = NULL, setOutOfSchoolSuspensionsOnThu = NULL, setOutOfSchoolSuspensionsOnTue = NULL, setOutOfSchoolSuspensionsOnWed = NULL, setSchoolYearID = NULL, setTardyKioskDisciplineSlipTitle = NULL, setUseAlternateActionDetails = 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("Discipline", "ConfigEntityGroupYear", ConfigEntityGroupYearID, names(functionParams), functionParams, EntityID)
}
#' Create new ConfigEntityGroupYear.
#'
#' This function creates a new ConfigEntityGroupYear.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created ConfigEntityGroupYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createConfigEntityGroupYearDiscipline <- function(EntityID = 1, setActionStatusDefaultValue = NULL, setActionStatusDefaultValueCode = NULL, setConfigEntityGroupYearIDClonedFrom = NULL, setDefaultActionStatusCode = NULL, setDetentionsOnFri = NULL, setDetentionsOnMon = NULL, setDetentionsOnSat = NULL, setDetentionsOnSun = NULL, setDetentionsOnThu = NULL, setDetentionsOnTue = NULL, setDetentionsOnWed = NULL, setEntityGroupKey = NULL, setEntityID = NULL, setExpulsionsOnFri = NULL, setExpulsionsOnMon = NULL, setExpulsionsOnSat = NULL, setExpulsionsOnSun = NULL, setExpulsionsOnThu = NULL, setExpulsionsOnTue = NULL, setExpulsionsOnWed = NULL, setIncludeDisciplinaryActionAndDetailsOnLetter = NULL, setIncludeGradeLevelOnLetter = NULL, setIncludeParentNameAndOrPhoneNumberOnLetter = NULL, setIncludeSchoolOrCampusOnLetter = NULL, setIncludeSignatureLineForOfficeOnLetter = NULL, setIncludeSignatureLineForParentOnLetter = NULL, setIncludeSignatureLineForStudentOnLetter = NULL, setIncludeStudentNameAndOrNumberOnLetter = NULL, setInSchoolSuspensionsOnFri = NULL, setInSchoolSuspensionsOnMon = NULL, setInSchoolSuspensionsOnSat = NULL, setInSchoolSuspensionsOnSun = NULL, setInSchoolSuspensionsOnThu = NULL, setInSchoolSuspensionsOnTue = NULL, setInSchoolSuspensionsOnWed = NULL, setOutOfSchoolSuspensionsOnFri = NULL, setOutOfSchoolSuspensionsOnMon = NULL, setOutOfSchoolSuspensionsOnSat = NULL, setOutOfSchoolSuspensionsOnSun = NULL, setOutOfSchoolSuspensionsOnThu = NULL, setOutOfSchoolSuspensionsOnTue = NULL, setOutOfSchoolSuspensionsOnWed = NULL, setSchoolYearID = NULL, setTardyKioskDisciplineSlipTitle = NULL, setUseAlternateActionDetails = 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("Discipline", "ConfigEntityGroupYear", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ConfigEntityGroupYear
#'
#' This function deletes a ConfigEntityGroupYear.
#'
#' @param ConfigEntityGroupYearID The id of the ConfigEntityGroupYear.\cr Run \code{\link{getAllConfigEntityGroupYears}} for a list of ConfigEntityGroupYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted ConfigEntityGroupYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigEntityGroupYearDiscipline <- function(ConfigEntityGroupYearID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "ConfigEntityGroupYear", ConfigEntityGroupYearID, EntityID)
}
#' Get all ConfigEntityYears.
#'
#' This function returns a dataframe of all ConfigEntityYears 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 Discipline
#' @return All ConfigEntityYears in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigEntityYears <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigEntityYearID = F, returnConfigEntityYearIDClonedFrom = F, returnCreatedTime = F, returnEntityID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Discipline", "ConfigEntityYear", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ConfigEntityYear
#'
#' This function returns fields for a ConfigEntityYear.
#'
#' @param ConfigEntityYearID The id of the ConfigEntityYear.\cr Run \code{\link{getAllConfigEntityYears}} for a list of ConfigEntityYears.
#' @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 Discipline
#' @return Details for the ConfigEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigEntityYear <- function(ConfigEntityYearID, EntityID = 1, returnConfigEntityYearID = F, returnConfigEntityYearIDClonedFrom = F, returnCreatedTime = F, returnEntityID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Discipline", "ConfigEntityYear", ConfigEntityYearID, searchFields, EntityID)
}
#' Modify a specific ConfigEntityYear
#'
#' This function modifies fields for a ConfigEntityYear.
#'
#' @param ConfigEntityYearID The id of the ConfigEntityYear to be modified.\cr Run \code{\link{getAllConfigEntityYears}} for a list of ConfigEntityYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified ConfigEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigEntityYear <- function(ConfigEntityYearID, EntityID = 1, setConfigEntityYearIDClonedFrom = NULL, setEntityID = NULL, setSchoolYearID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Discipline", "ConfigEntityYear", ConfigEntityYearID, names(functionParams), functionParams, EntityID)
}
#' Create new ConfigEntityYear.
#'
#' This function creates a new ConfigEntityYear.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created ConfigEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createConfigEntityYear <- function(EntityID = 1, setConfigEntityYearIDClonedFrom = NULL, setEntityID = NULL, setSchoolYearID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Discipline", "ConfigEntityYear", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ConfigEntityYear
#'
#' This function deletes a ConfigEntityYear.
#'
#' @param ConfigEntityYearID The id of the ConfigEntityYear.\cr Run \code{\link{getAllConfigEntityYears}} for a list of ConfigEntityYears.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted ConfigEntityYear.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigEntityYear <- function(ConfigEntityYearID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "ConfigEntityYear", ConfigEntityYearID, EntityID)
}
#' Get all ConfigSystems.
#'
#' This function returns a dataframe of all ConfigSystems in the database.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param searchConditionsList A list of search conditions to filter results which are joined by the searchConditionsGroupType. Of the form {FieldName} {ConditionType} {SearchCondition}. For example, c('StudentID LessEqual 500', 'LastName Like Ander\%'). Run \code{\link{getAllSearchConditionTypes}} for a list of ConditionTypes. Defaults to NULL (unfiltered).
#' @param searchConditionsGroupType The conjunction which joins multiple searchConditions in the searchConditionsList. Either 'Or' or 'And'. Defaults to 'And'.
#' @param searchSortFieldNamesList The list of fields sort results by. Defaults to NULL (unsorted).
#' @param searchSortFieldNamesDescendingList A list of T/F values corresponding to whether to sort each field in searchSortFieldNamesList in descending order. Defaults to F for each FieldName in searchSortFieldNamesList.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept Discipline
#' @return All ConfigSystems in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllConfigSystemsDiscipline <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnConfigSystemID = F, returnAllowIncidentSuppression = F, returnAllowUpdateHistoricalData = F, returnCreatedTime = F, returnModifiedTime = F, returnReportIDDisciplineLetter = 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("Discipline", "ConfigSystem", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ConfigSystem
#'
#' This function returns fields for a ConfigSystem.
#'
#' @param ConfigSystemID The id of the ConfigSystem.\cr Run \code{\link{getAllConfigSystems}} for a list of ConfigSystems.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param return{FieldName} A TRUE or FALSE value determining whether or not to return {FieldName} for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.
#' @concept Discipline
#' @return Details for the ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getConfigSystemDiscipline <- function(ConfigSystemID, EntityID = 1, returnConfigSystemID = F, returnAllowIncidentSuppression = F, returnAllowUpdateHistoricalData = F, returnCreatedTime = F, returnModifiedTime = F, returnReportIDDisciplineLetter = 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("Discipline", "ConfigSystem", ConfigSystemID, searchFields, EntityID)
}
#' Modify a specific ConfigSystem
#'
#' This function modifies fields for a ConfigSystem.
#'
#' @param ConfigSystemID The id of the ConfigSystem to be modified.\cr Run \code{\link{getAllConfigSystems}} for a list of ConfigSystems.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyConfigSystemDiscipline <- function(ConfigSystemID, EntityID = 1, setAllowIncidentSuppression = NULL, setAllowUpdateHistoricalData = NULL, setReportIDDisciplineLetter = 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("Discipline", "ConfigSystem", ConfigSystemID, names(functionParams), functionParams, EntityID)
}
#' Create new ConfigSystem.
#'
#' This function creates a new ConfigSystem.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createConfigSystemDiscipline <- function(EntityID = 1, setAllowIncidentSuppression = NULL, setAllowUpdateHistoricalData = NULL, setReportIDDisciplineLetter = 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("Discipline", "ConfigSystem", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ConfigSystem
#'
#' This function deletes a ConfigSystem.
#'
#' @param ConfigSystemID The id of the ConfigSystem.\cr Run \code{\link{getAllConfigSystems}} for a list of ConfigSystems.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted ConfigSystem.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteConfigSystemDiscipline <- function(ConfigSystemID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "ConfigSystem", ConfigSystemID, EntityID)
}
#' Get all DisciplineLetterRunHistories.
#'
#' This function returns a dataframe of all DisciplineLetterRunHistories 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 Discipline
#' @return All DisciplineLetterRunHistories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDisciplineLetterRunHistories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnDisciplineLetterRunHistoryID = F, returnCachedEntity = F, returnCachedFiscalYear = F, returnCachedSchoolYear = F, returnCreatedTime = F, returnDate = F, returnDisciplineLetterTemplateID = F, returnEndDate = F, returnEntityID = F, returnEntityIDList = F, returnFilterType = F, returnFilterTypeCode = F, returnFiscalYearID = F, returnGracePeriod = F, returnIncidentType = F, returnIncidentTypeCode = F, returnIsActive = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnParameterData = F, returnParameterDescription = F, returnReportRunInfoID = F, returnRunDescription = F, returnSchoolYearID = F, returnSchoolYearNumericYearOrCurrent = F, returnSectionID = F, returnStartDate = 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("Discipline", "DisciplineLetterRunHistory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DisciplineLetterRunHistory
#'
#' This function returns fields for a DisciplineLetterRunHistory.
#'
#' @param DisciplineLetterRunHistoryID The id of the DisciplineLetterRunHistory.\cr Run \code{\link{getAllDisciplineLetterRunHistories}} for a list of DisciplineLetterRunHistories.
#' @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 Discipline
#' @return Details for the DisciplineLetterRunHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDisciplineLetterRunHistory <- function(DisciplineLetterRunHistoryID, EntityID = 1, returnDisciplineLetterRunHistoryID = F, returnCachedEntity = F, returnCachedFiscalYear = F, returnCachedSchoolYear = F, returnCreatedTime = F, returnDate = F, returnDisciplineLetterTemplateID = F, returnEndDate = F, returnEntityID = F, returnEntityIDList = F, returnFilterType = F, returnFilterTypeCode = F, returnFiscalYearID = F, returnGracePeriod = F, returnIncidentType = F, returnIncidentTypeCode = F, returnIsActive = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnParameterData = F, returnParameterDescription = F, returnReportRunInfoID = F, returnRunDescription = F, returnSchoolYearID = F, returnSchoolYearNumericYearOrCurrent = F, returnSectionID = F, returnStartDate = 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("Discipline", "DisciplineLetterRunHistory", DisciplineLetterRunHistoryID, searchFields, EntityID)
}
#' Modify a specific DisciplineLetterRunHistory
#'
#' This function modifies fields for a DisciplineLetterRunHistory.
#'
#' @param DisciplineLetterRunHistoryID The id of the DisciplineLetterRunHistory to be modified.\cr Run \code{\link{getAllDisciplineLetterRunHistories}} for a list of DisciplineLetterRunHistorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified DisciplineLetterRunHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDisciplineLetterRunHistory <- function(DisciplineLetterRunHistoryID, EntityID = 1, setDate = NULL, setDisciplineLetterTemplateID = NULL, setEndDate = NULL, setEntityID = NULL, setFilterType = NULL, setFilterTypeCode = NULL, setGracePeriod = NULL, setIncidentType = NULL, setIncidentTypeCode = NULL, setIsActive = NULL, setReportRunInfoID = NULL, setRunDescription = NULL, setStartDate = 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("Discipline", "DisciplineLetterRunHistory", DisciplineLetterRunHistoryID, names(functionParams), functionParams, EntityID)
}
#' Create new DisciplineLetterRunHistory.
#'
#' This function creates a new DisciplineLetterRunHistory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created DisciplineLetterRunHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDisciplineLetterRunHistory <- function(EntityID = 1, setDate = NULL, setDisciplineLetterTemplateID = NULL, setEndDate = NULL, setEntityID = NULL, setFilterType = NULL, setFilterTypeCode = NULL, setGracePeriod = NULL, setIncidentType = NULL, setIncidentTypeCode = NULL, setIsActive = NULL, setReportRunInfoID = NULL, setRunDescription = NULL, setStartDate = 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("Discipline", "DisciplineLetterRunHistory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DisciplineLetterRunHistory
#'
#' This function deletes a DisciplineLetterRunHistory.
#'
#' @param DisciplineLetterRunHistoryID The id of the DisciplineLetterRunHistory.\cr Run \code{\link{getAllDisciplineLetterRunHistories}} for a list of DisciplineLetterRunHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted DisciplineLetterRunHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDisciplineLetterRunHistory <- function(DisciplineLetterRunHistoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "DisciplineLetterRunHistory", DisciplineLetterRunHistoryID, EntityID)
}
#' Get all DisciplineLetterRunHistoryActions.
#'
#' This function returns a dataframe of all DisciplineLetterRunHistoryActions 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 Discipline
#' @return All DisciplineLetterRunHistoryActions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDisciplineLetterRunHistoryActions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnDisciplineLetterRunHistoryActionID = F, returnActionID = F, returnCreatedTime = F, returnDisciplineLetterRunHistoryID = 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("Discipline", "DisciplineLetterRunHistoryAction", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DisciplineLetterRunHistoryAction
#'
#' This function returns fields for a DisciplineLetterRunHistoryAction.
#'
#' @param DisciplineLetterRunHistoryActionID The id of the DisciplineLetterRunHistoryAction.\cr Run \code{\link{getAllDisciplineLetterRunHistoryActions}} for a list of DisciplineLetterRunHistoryActions.
#' @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 Discipline
#' @return Details for the DisciplineLetterRunHistoryAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDisciplineLetterRunHistoryAction <- function(DisciplineLetterRunHistoryActionID, EntityID = 1, returnDisciplineLetterRunHistoryActionID = F, returnActionID = F, returnCreatedTime = F, returnDisciplineLetterRunHistoryID = 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("Discipline", "DisciplineLetterRunHistoryAction", DisciplineLetterRunHistoryActionID, searchFields, EntityID)
}
#' Modify a specific DisciplineLetterRunHistoryAction
#'
#' This function modifies fields for a DisciplineLetterRunHistoryAction.
#'
#' @param DisciplineLetterRunHistoryActionID The id of the DisciplineLetterRunHistoryAction to be modified.\cr Run \code{\link{getAllDisciplineLetterRunHistoryActions}} for a list of DisciplineLetterRunHistoryActions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified DisciplineLetterRunHistoryAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDisciplineLetterRunHistoryAction <- function(DisciplineLetterRunHistoryActionID, EntityID = 1, setActionID = NULL, setDisciplineLetterRunHistoryID = 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("Discipline", "DisciplineLetterRunHistoryAction", DisciplineLetterRunHistoryActionID, names(functionParams), functionParams, EntityID)
}
#' Create new DisciplineLetterRunHistoryAction.
#'
#' This function creates a new DisciplineLetterRunHistoryAction.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created DisciplineLetterRunHistoryAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDisciplineLetterRunHistoryAction <- function(EntityID = 1, setActionID = NULL, setDisciplineLetterRunHistoryID = 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("Discipline", "DisciplineLetterRunHistoryAction", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DisciplineLetterRunHistoryAction
#'
#' This function deletes a DisciplineLetterRunHistoryAction.
#'
#' @param DisciplineLetterRunHistoryActionID The id of the DisciplineLetterRunHistoryAction.\cr Run \code{\link{getAllDisciplineLetterRunHistoryActions}} for a list of DisciplineLetterRunHistoryActions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted DisciplineLetterRunHistoryAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDisciplineLetterRunHistoryAction <- function(DisciplineLetterRunHistoryActionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "DisciplineLetterRunHistoryAction", DisciplineLetterRunHistoryActionID, EntityID)
}
#' Get all DisciplineLetterRunHistoryOffenses.
#'
#' This function returns a dataframe of all DisciplineLetterRunHistoryOffenses 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 Discipline
#' @return All DisciplineLetterRunHistoryOffenses in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDisciplineLetterRunHistoryOffenses <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnDisciplineLetterRunHistoryOffenseID = F, returnCreatedTime = F, returnDisciplineLetterRunHistoryID = F, returnModifiedTime = F, returnOffenseID = 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("Discipline", "DisciplineLetterRunHistoryOffense", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DisciplineLetterRunHistoryOffense
#'
#' This function returns fields for a DisciplineLetterRunHistoryOffense.
#'
#' @param DisciplineLetterRunHistoryOffenseID The id of the DisciplineLetterRunHistoryOffense.\cr Run \code{\link{getAllDisciplineLetterRunHistoryOffenses}} for a list of DisciplineLetterRunHistoryOffenses.
#' @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 Discipline
#' @return Details for the DisciplineLetterRunHistoryOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDisciplineLetterRunHistoryOffense <- function(DisciplineLetterRunHistoryOffenseID, EntityID = 1, returnDisciplineLetterRunHistoryOffenseID = F, returnCreatedTime = F, returnDisciplineLetterRunHistoryID = F, returnModifiedTime = F, returnOffenseID = 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("Discipline", "DisciplineLetterRunHistoryOffense", DisciplineLetterRunHistoryOffenseID, searchFields, EntityID)
}
#' Modify a specific DisciplineLetterRunHistoryOffense
#'
#' This function modifies fields for a DisciplineLetterRunHistoryOffense.
#'
#' @param DisciplineLetterRunHistoryOffenseID The id of the DisciplineLetterRunHistoryOffense to be modified.\cr Run \code{\link{getAllDisciplineLetterRunHistoryOffenses}} for a list of DisciplineLetterRunHistoryOffenses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified DisciplineLetterRunHistoryOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDisciplineLetterRunHistoryOffense <- function(DisciplineLetterRunHistoryOffenseID, EntityID = 1, setDisciplineLetterRunHistoryID = NULL, setOffenseID = 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("Discipline", "DisciplineLetterRunHistoryOffense", DisciplineLetterRunHistoryOffenseID, names(functionParams), functionParams, EntityID)
}
#' Create new DisciplineLetterRunHistoryOffense.
#'
#' This function creates a new DisciplineLetterRunHistoryOffense.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created DisciplineLetterRunHistoryOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDisciplineLetterRunHistoryOffense <- function(EntityID = 1, setDisciplineLetterRunHistoryID = NULL, setOffenseID = 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("Discipline", "DisciplineLetterRunHistoryOffense", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DisciplineLetterRunHistoryOffense
#'
#' This function deletes a DisciplineLetterRunHistoryOffense.
#'
#' @param DisciplineLetterRunHistoryOffenseID The id of the DisciplineLetterRunHistoryOffense.\cr Run \code{\link{getAllDisciplineLetterRunHistoryOffenses}} for a list of DisciplineLetterRunHistoryOffenses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted DisciplineLetterRunHistoryOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDisciplineLetterRunHistoryOffense <- function(DisciplineLetterRunHistoryOffenseID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "DisciplineLetterRunHistoryOffense", DisciplineLetterRunHistoryOffenseID, EntityID)
}
#' Get all DisciplineLetterTemplates.
#'
#' This function returns a dataframe of all DisciplineLetterTemplates 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 Discipline
#' @return All DisciplineLetterTemplates in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDisciplineLetterTemplates <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnDisciplineLetterTemplateID = F, returnAdvisorNameFormat = F, returnAdvisorNameFormatCode = F, returnBody = F, returnColumnHeaderLabel1 = F, returnColumnHeaderLabel10 = F, returnColumnHeaderLabel2 = F, returnColumnHeaderLabel3 = F, returnColumnHeaderLabel4 = F, returnColumnHeaderLabel5 = F, returnColumnHeaderLabel6 = F, returnColumnHeaderLabel7 = F, returnColumnHeaderLabel8 = F, returnColumnHeaderLabel9 = F, returnCreatedTime = F, returnDescription = F, returnDisciplineLetterTemplateIDClonedFrom = F, returnDistrictID = F, returnFooter = F, returnForCurrentEntity = F, returnGuardianNameFormat = F, returnGuardianNameFormatCode = F, returnHasLogo = F, returnHeader = F, returnIsDefault = F, returnIsReadOnlyHistoricalRecord = F, returnMediaIDLogo = F, returnModifiedTime = F, returnPrintSingleColumn1 = F, returnPrintSingleColumn10 = F, returnPrintSingleColumn2 = F, returnPrintSingleColumn3 = F, returnPrintSingleColumn4 = F, returnPrintSingleColumn5 = F, returnPrintSingleColumn6 = F, returnPrintSingleColumn7 = F, returnPrintSingleColumn8 = F, returnPrintSingleColumn9 = F, returnSchoolYearID = F, returnStudentNameFormat = F, returnStudentNameFormatCode = F, returnSuperintendentNameFormat = F, returnSuperintendentNameFormatCode = 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("Discipline", "DisciplineLetterTemplate", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DisciplineLetterTemplate
#'
#' This function returns fields for a DisciplineLetterTemplate.
#'
#' @param DisciplineLetterTemplateID The id of the DisciplineLetterTemplate.\cr Run \code{\link{getAllDisciplineLetterTemplates}} for a list of DisciplineLetterTemplates.
#' @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 Discipline
#' @return Details for the DisciplineLetterTemplate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDisciplineLetterTemplate <- function(DisciplineLetterTemplateID, EntityID = 1, returnDisciplineLetterTemplateID = F, returnAdvisorNameFormat = F, returnAdvisorNameFormatCode = F, returnBody = F, returnColumnHeaderLabel1 = F, returnColumnHeaderLabel10 = F, returnColumnHeaderLabel2 = F, returnColumnHeaderLabel3 = F, returnColumnHeaderLabel4 = F, returnColumnHeaderLabel5 = F, returnColumnHeaderLabel6 = F, returnColumnHeaderLabel7 = F, returnColumnHeaderLabel8 = F, returnColumnHeaderLabel9 = F, returnCreatedTime = F, returnDescription = F, returnDisciplineLetterTemplateIDClonedFrom = F, returnDistrictID = F, returnFooter = F, returnForCurrentEntity = F, returnGuardianNameFormat = F, returnGuardianNameFormatCode = F, returnHasLogo = F, returnHeader = F, returnIsDefault = F, returnIsReadOnlyHistoricalRecord = F, returnMediaIDLogo = F, returnModifiedTime = F, returnPrintSingleColumn1 = F, returnPrintSingleColumn10 = F, returnPrintSingleColumn2 = F, returnPrintSingleColumn3 = F, returnPrintSingleColumn4 = F, returnPrintSingleColumn5 = F, returnPrintSingleColumn6 = F, returnPrintSingleColumn7 = F, returnPrintSingleColumn8 = F, returnPrintSingleColumn9 = F, returnSchoolYearID = F, returnStudentNameFormat = F, returnStudentNameFormatCode = F, returnSuperintendentNameFormat = F, returnSuperintendentNameFormatCode = 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("Discipline", "DisciplineLetterTemplate", DisciplineLetterTemplateID, searchFields, EntityID)
}
#' Modify a specific DisciplineLetterTemplate
#'
#' This function modifies fields for a DisciplineLetterTemplate.
#'
#' @param DisciplineLetterTemplateID The id of the DisciplineLetterTemplate to be modified.\cr Run \code{\link{getAllDisciplineLetterTemplates}} for a list of DisciplineLetterTemplates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified DisciplineLetterTemplate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDisciplineLetterTemplate <- function(DisciplineLetterTemplateID, EntityID = 1, setAdvisorNameFormat = NULL, setAdvisorNameFormatCode = NULL, setBody = NULL, setColumnHeaderLabel1 = NULL, setColumnHeaderLabel10 = NULL, setColumnHeaderLabel2 = NULL, setColumnHeaderLabel3 = NULL, setColumnHeaderLabel4 = NULL, setColumnHeaderLabel5 = NULL, setColumnHeaderLabel6 = NULL, setColumnHeaderLabel7 = NULL, setColumnHeaderLabel8 = NULL, setColumnHeaderLabel9 = NULL, setDescription = NULL, setDisciplineLetterTemplateIDClonedFrom = NULL, setDistrictID = NULL, setFooter = NULL, setGuardianNameFormat = NULL, setGuardianNameFormatCode = NULL, setHeader = NULL, setIsDefault = NULL, setMediaIDLogo = NULL, setSchoolYearID = NULL, setStudentNameFormat = NULL, setStudentNameFormatCode = NULL, setSuperintendentNameFormat = NULL, setSuperintendentNameFormatCode = 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("Discipline", "DisciplineLetterTemplate", DisciplineLetterTemplateID, names(functionParams), functionParams, EntityID)
}
#' Create new DisciplineLetterTemplate.
#'
#' This function creates a new DisciplineLetterTemplate.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created DisciplineLetterTemplate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDisciplineLetterTemplate <- function(EntityID = 1, setAdvisorNameFormat = NULL, setAdvisorNameFormatCode = NULL, setBody = NULL, setColumnHeaderLabel1 = NULL, setColumnHeaderLabel10 = NULL, setColumnHeaderLabel2 = NULL, setColumnHeaderLabel3 = NULL, setColumnHeaderLabel4 = NULL, setColumnHeaderLabel5 = NULL, setColumnHeaderLabel6 = NULL, setColumnHeaderLabel7 = NULL, setColumnHeaderLabel8 = NULL, setColumnHeaderLabel9 = NULL, setDescription = NULL, setDisciplineLetterTemplateIDClonedFrom = NULL, setDistrictID = NULL, setFooter = NULL, setGuardianNameFormat = NULL, setGuardianNameFormatCode = NULL, setHeader = NULL, setIsDefault = NULL, setMediaIDLogo = NULL, setSchoolYearID = NULL, setStudentNameFormat = NULL, setStudentNameFormatCode = NULL, setSuperintendentNameFormat = NULL, setSuperintendentNameFormatCode = 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("Discipline", "DisciplineLetterTemplate", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DisciplineLetterTemplate
#'
#' This function deletes a DisciplineLetterTemplate.
#'
#' @param DisciplineLetterTemplateID The id of the DisciplineLetterTemplate.\cr Run \code{\link{getAllDisciplineLetterTemplates}} for a list of DisciplineLetterTemplates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted DisciplineLetterTemplate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDisciplineLetterTemplate <- function(DisciplineLetterTemplateID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "DisciplineLetterTemplate", DisciplineLetterTemplateID, EntityID)
}
#' Get all DisciplineLetterTemplateEntities.
#'
#' This function returns a dataframe of all DisciplineLetterTemplateEntities 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 Discipline
#' @return All DisciplineLetterTemplateEntities in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDisciplineLetterTemplateEntities <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnDisciplineLetterTemplateEntityID = F, returnCreatedTime = F, returnDisciplineLetterTemplateID = F, returnEntityID = 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("Discipline", "DisciplineLetterTemplateEntity", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DisciplineLetterTemplateEntity
#'
#' This function returns fields for a DisciplineLetterTemplateEntity.
#'
#' @param DisciplineLetterTemplateEntityID The id of the DisciplineLetterTemplateEntity.\cr Run \code{\link{getAllDisciplineLetterTemplateEntities}} for a list of DisciplineLetterTemplateEntities.
#' @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 Discipline
#' @return Details for the DisciplineLetterTemplateEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDisciplineLetterTemplateEntity <- function(DisciplineLetterTemplateEntityID, EntityID = 1, returnDisciplineLetterTemplateEntityID = F, returnCreatedTime = F, returnDisciplineLetterTemplateID = F, returnEntityID = 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("Discipline", "DisciplineLetterTemplateEntity", DisciplineLetterTemplateEntityID, searchFields, EntityID)
}
#' Modify a specific DisciplineLetterTemplateEntity
#'
#' This function modifies fields for a DisciplineLetterTemplateEntity.
#'
#' @param DisciplineLetterTemplateEntityID The id of the DisciplineLetterTemplateEntity to be modified.\cr Run \code{\link{getAllDisciplineLetterTemplateEntities}} for a list of DisciplineLetterTemplateEntitys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified DisciplineLetterTemplateEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDisciplineLetterTemplateEntity <- function(DisciplineLetterTemplateEntityID, EntityID = 1, setDisciplineLetterTemplateID = NULL, setEntityID = 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("Discipline", "DisciplineLetterTemplateEntity", DisciplineLetterTemplateEntityID, names(functionParams), functionParams, EntityID)
}
#' Create new DisciplineLetterTemplateEntity.
#'
#' This function creates a new DisciplineLetterTemplateEntity.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created DisciplineLetterTemplateEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDisciplineLetterTemplateEntity <- function(EntityID = 1, setDisciplineLetterTemplateID = NULL, setEntityID = 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("Discipline", "DisciplineLetterTemplateEntity", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DisciplineLetterTemplateEntity
#'
#' This function deletes a DisciplineLetterTemplateEntity.
#'
#' @param DisciplineLetterTemplateEntityID The id of the DisciplineLetterTemplateEntity.\cr Run \code{\link{getAllDisciplineLetterTemplateEntities}} for a list of DisciplineLetterTemplateEntities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted DisciplineLetterTemplateEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDisciplineLetterTemplateEntity <- function(DisciplineLetterTemplateEntityID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "DisciplineLetterTemplateEntity", DisciplineLetterTemplateEntityID, EntityID)
}
#' Get all DisciplineLetterTemplateHeaderColumns.
#'
#' This function returns a dataframe of all DisciplineLetterTemplateHeaderColumns 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 Discipline
#' @return All DisciplineLetterTemplateHeaderColumns in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDisciplineLetterTemplateHeaderColumns <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnDisciplineLetterTemplateHeaderColumnID = F, returnColumnNumber = F, returnCreatedTime = F, returnDisciplineLetterTemplateHeaderColumnIDClonedFrom = F, returnDisciplineLetterTemplateHeaderRowID = F, returnFieldType = F, returnFieldTypeCode = F, returnFreeformText = F, returnLabelOverride = F, returnModifiedTime = F, returnSortNumber = 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("Discipline", "DisciplineLetterTemplateHeaderColumn", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DisciplineLetterTemplateHeaderColumn
#'
#' This function returns fields for a DisciplineLetterTemplateHeaderColumn.
#'
#' @param DisciplineLetterTemplateHeaderColumnID The id of the DisciplineLetterTemplateHeaderColumn.\cr Run \code{\link{getAllDisciplineLetterTemplateHeaderColumns}} for a list of DisciplineLetterTemplateHeaderColumns.
#' @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 Discipline
#' @return Details for the DisciplineLetterTemplateHeaderColumn.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDisciplineLetterTemplateHeaderColumn <- function(DisciplineLetterTemplateHeaderColumnID, EntityID = 1, returnDisciplineLetterTemplateHeaderColumnID = F, returnColumnNumber = F, returnCreatedTime = F, returnDisciplineLetterTemplateHeaderColumnIDClonedFrom = F, returnDisciplineLetterTemplateHeaderRowID = F, returnFieldType = F, returnFieldTypeCode = F, returnFreeformText = F, returnLabelOverride = F, returnModifiedTime = F, returnSortNumber = 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("Discipline", "DisciplineLetterTemplateHeaderColumn", DisciplineLetterTemplateHeaderColumnID, searchFields, EntityID)
}
#' Modify a specific DisciplineLetterTemplateHeaderColumn
#'
#' This function modifies fields for a DisciplineLetterTemplateHeaderColumn.
#'
#' @param DisciplineLetterTemplateHeaderColumnID The id of the DisciplineLetterTemplateHeaderColumn to be modified.\cr Run \code{\link{getAllDisciplineLetterTemplateHeaderColumns}} for a list of DisciplineLetterTemplateHeaderColumns.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified DisciplineLetterTemplateHeaderColumn.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDisciplineLetterTemplateHeaderColumn <- function(DisciplineLetterTemplateHeaderColumnID, EntityID = 1, setDisciplineLetterTemplateHeaderColumnIDClonedFrom = NULL, setDisciplineLetterTemplateHeaderRowID = NULL, setFieldType = NULL, setFieldTypeCode = NULL, setFreeformText = NULL, setLabelOverride = NULL, setSortNumber = 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("Discipline", "DisciplineLetterTemplateHeaderColumn", DisciplineLetterTemplateHeaderColumnID, names(functionParams), functionParams, EntityID)
}
#' Create new DisciplineLetterTemplateHeaderColumn.
#'
#' This function creates a new DisciplineLetterTemplateHeaderColumn.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created DisciplineLetterTemplateHeaderColumn.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDisciplineLetterTemplateHeaderColumn <- function(EntityID = 1, setDisciplineLetterTemplateHeaderColumnIDClonedFrom = NULL, setDisciplineLetterTemplateHeaderRowID = NULL, setFieldType = NULL, setFieldTypeCode = NULL, setFreeformText = NULL, setLabelOverride = NULL, setSortNumber = 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("Discipline", "DisciplineLetterTemplateHeaderColumn", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DisciplineLetterTemplateHeaderColumn
#'
#' This function deletes a DisciplineLetterTemplateHeaderColumn.
#'
#' @param DisciplineLetterTemplateHeaderColumnID The id of the DisciplineLetterTemplateHeaderColumn.\cr Run \code{\link{getAllDisciplineLetterTemplateHeaderColumns}} for a list of DisciplineLetterTemplateHeaderColumns.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted DisciplineLetterTemplateHeaderColumn.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDisciplineLetterTemplateHeaderColumn <- function(DisciplineLetterTemplateHeaderColumnID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "DisciplineLetterTemplateHeaderColumn", DisciplineLetterTemplateHeaderColumnID, EntityID)
}
#' Get all DisciplineLetterTemplateHeaderRows.
#'
#' This function returns a dataframe of all DisciplineLetterTemplateHeaderRows 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 Discipline
#' @return All DisciplineLetterTemplateHeaderRows in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDisciplineLetterTemplateHeaderRows <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnDisciplineLetterTemplateHeaderRowID = F, returnColumnCount = F, returnCreatedTime = F, returnDisciplineLetterTemplateHeaderRowIDClonedFrom = F, returnDisciplineLetterTemplateID = F, returnModifiedTime = F, returnSortNumber = 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("Discipline", "DisciplineLetterTemplateHeaderRow", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific DisciplineLetterTemplateHeaderRow
#'
#' This function returns fields for a DisciplineLetterTemplateHeaderRow.
#'
#' @param DisciplineLetterTemplateHeaderRowID The id of the DisciplineLetterTemplateHeaderRow.\cr Run \code{\link{getAllDisciplineLetterTemplateHeaderRows}} for a list of DisciplineLetterTemplateHeaderRows.
#' @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 Discipline
#' @return Details for the DisciplineLetterTemplateHeaderRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDisciplineLetterTemplateHeaderRow <- function(DisciplineLetterTemplateHeaderRowID, EntityID = 1, returnDisciplineLetterTemplateHeaderRowID = F, returnColumnCount = F, returnCreatedTime = F, returnDisciplineLetterTemplateHeaderRowIDClonedFrom = F, returnDisciplineLetterTemplateID = F, returnModifiedTime = F, returnSortNumber = 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("Discipline", "DisciplineLetterTemplateHeaderRow", DisciplineLetterTemplateHeaderRowID, searchFields, EntityID)
}
#' Modify a specific DisciplineLetterTemplateHeaderRow
#'
#' This function modifies fields for a DisciplineLetterTemplateHeaderRow.
#'
#' @param DisciplineLetterTemplateHeaderRowID The id of the DisciplineLetterTemplateHeaderRow to be modified.\cr Run \code{\link{getAllDisciplineLetterTemplateHeaderRows}} for a list of DisciplineLetterTemplateHeaderRows.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified DisciplineLetterTemplateHeaderRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDisciplineLetterTemplateHeaderRow <- function(DisciplineLetterTemplateHeaderRowID, EntityID = 1, setColumnCount = NULL, setDisciplineLetterTemplateHeaderRowIDClonedFrom = NULL, setDisciplineLetterTemplateID = NULL, setSortNumber = 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("Discipline", "DisciplineLetterTemplateHeaderRow", DisciplineLetterTemplateHeaderRowID, names(functionParams), functionParams, EntityID)
}
#' Create new DisciplineLetterTemplateHeaderRow.
#'
#' This function creates a new DisciplineLetterTemplateHeaderRow.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created DisciplineLetterTemplateHeaderRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDisciplineLetterTemplateHeaderRow <- function(EntityID = 1, setColumnCount = NULL, setDisciplineLetterTemplateHeaderRowIDClonedFrom = NULL, setDisciplineLetterTemplateID = NULL, setSortNumber = 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("Discipline", "DisciplineLetterTemplateHeaderRow", names(functionParams), functionParams, EntityID)
}
#' Delete a specific DisciplineLetterTemplateHeaderRow
#'
#' This function deletes a DisciplineLetterTemplateHeaderRow.
#'
#' @param DisciplineLetterTemplateHeaderRowID The id of the DisciplineLetterTemplateHeaderRow.\cr Run \code{\link{getAllDisciplineLetterTemplateHeaderRows}} for a list of DisciplineLetterTemplateHeaderRows.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted DisciplineLetterTemplateHeaderRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDisciplineLetterTemplateHeaderRow <- function(DisciplineLetterTemplateHeaderRowID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "DisciplineLetterTemplateHeaderRow", DisciplineLetterTemplateHeaderRowID, EntityID)
}
#' Get all Drugs.
#'
#' This function returns a dataframe of all Drugs 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 Discipline
#' @return All Drugs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllDrugs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnDrugID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnDrugIDClonedFrom = F, returnDrugMNID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnSchoolYearID = F, returnStateDrugTypeMNID = 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("Discipline", "Drug", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Drug
#'
#' This function returns fields for a Drug.
#'
#' @param DrugID The id of the Drug.\cr Run \code{\link{getAllDrugs}} for a list of Drugs.
#' @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 Discipline
#' @return Details for the Drug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getDrug <- function(DrugID, EntityID = 1, returnDrugID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnDrugIDClonedFrom = F, returnDrugMNID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnSchoolYearID = F, returnStateDrugTypeMNID = 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("Discipline", "Drug", DrugID, searchFields, EntityID)
}
#' Modify a specific Drug
#'
#' This function modifies fields for a Drug.
#'
#' @param DrugID The id of the Drug to be modified.\cr Run \code{\link{getAllDrugs}} for a list of Drugs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified Drug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyDrug <- function(DrugID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setDrugIDClonedFrom = NULL, setSchoolYearID = NULL, setStateDrugTypeMNID = 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("Discipline", "Drug", DrugID, names(functionParams), functionParams, EntityID)
}
#' Create new Drug.
#'
#' This function creates a new Drug.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created Drug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createDrug <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setDrugIDClonedFrom = NULL, setSchoolYearID = NULL, setStateDrugTypeMNID = 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("Discipline", "Drug", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Drug
#'
#' This function deletes a Drug.
#'
#' @param DrugID The id of the Drug.\cr Run \code{\link{getAllDrugs}} for a list of Drugs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted Drug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteDrug <- function(DrugID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "Drug", DrugID, EntityID)
}
#' Get all Incidents.
#'
#' This function returns a dataframe of all Incidents 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 Discipline
#' @return All Incidents in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIncidents <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIncidentID = F, returnActionIDRecommended = F, returnBuildingID = F, returnCreatedTime = F, returnDamageCost = F, returnDateTime = F, returnDateTimeDate = F, returnDateTimeTime = F, returnDescription = F, returnDistrictID = F, returnEntityID = F, returnHasActions = F, returnHasActionsForOffenders = F, returnHasDrugs = F, returnHasOpenActions = F, returnHasOverdueActionDetails = F, returnHasWeapons = F, returnIncidentMNID = F, returnIncidentNumber = F, returnIncidentNumberValue = F, returnIsIncidentOrWarning = F, returnIsReadOnlyHistoricalRecord = F, returnIsReferralOrWarning = F, returnIsSuppressed = F, returnLocationID = F, returnModifiedTime = F, returnNumberOfNonEnrolledOffenders = F, returnNumberOfNonEnrolledVictims = F, returnReferredByFreeformName = F, returnReferredByName = F, returnReferredByNameID = F, returnReferredByType = F, returnReferredByTypeCode = F, returnReportedToLawEnforcement = F, returnRoomID = F, returnSchoolYearID = F, returnStateDIRSTimeMNID = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Discipline", "Incident", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Incident
#'
#' This function returns fields for an Incident.
#'
#' @param IncidentID The id of the Incident.\cr Run \code{\link{getAllIncidents}} for a list of Incidents.
#' @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 Discipline
#' @return Details for the Incident.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIncident <- function(IncidentID, EntityID = 1, returnIncidentID = F, returnActionIDRecommended = F, returnBuildingID = F, returnCreatedTime = F, returnDamageCost = F, returnDateTime = F, returnDateTimeDate = F, returnDateTimeTime = F, returnDescription = F, returnDistrictID = F, returnEntityID = F, returnHasActions = F, returnHasActionsForOffenders = F, returnHasDrugs = F, returnHasOpenActions = F, returnHasOverdueActionDetails = F, returnHasWeapons = F, returnIncidentMNID = F, returnIncidentNumber = F, returnIncidentNumberValue = F, returnIsIncidentOrWarning = F, returnIsReadOnlyHistoricalRecord = F, returnIsReferralOrWarning = F, returnIsSuppressed = F, returnLocationID = F, returnModifiedTime = F, returnNumberOfNonEnrolledOffenders = F, returnNumberOfNonEnrolledVictims = F, returnReferredByFreeformName = F, returnReferredByName = F, returnReferredByNameID = F, returnReferredByType = F, returnReferredByTypeCode = F, returnReportedToLawEnforcement = F, returnRoomID = F, returnSchoolYearID = F, returnStateDIRSTimeMNID = F, returnType = F, returnTypeCode = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Discipline", "Incident", IncidentID, searchFields, EntityID)
}
#' Modify a specific Incident
#'
#' This function modifies fields for an Incident.
#'
#' @param IncidentID The id of the Incident to be modified.\cr Run \code{\link{getAllIncidents}} for a list of Incidents.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified Incident.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIncident <- function(IncidentID, EntityID = 1, setActionIDRecommended = NULL, setBuildingID = NULL, setDamageCost = NULL, setDateTime = NULL, setDateTimeDate = NULL, setDateTimeTime = NULL, setDescription = NULL, setDistrictID = NULL, setEntityID = NULL, setIncidentNumber = NULL, setIsSuppressed = NULL, setLocationID = NULL, setNumberOfNonEnrolledOffenders = NULL, setNumberOfNonEnrolledVictims = NULL, setReferredByFreeformName = NULL, setReferredByNameID = NULL, setReferredByType = NULL, setReferredByTypeCode = NULL, setReportedToLawEnforcement = NULL, setRoomID = NULL, setSchoolYearID = NULL, setStateDIRSTimeMNID = NULL, setType = NULL, setTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Discipline", "Incident", IncidentID, names(functionParams), functionParams, EntityID)
}
#' Create new Incident.
#'
#' This function creates a new Incident.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created Incident.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIncident <- function(EntityID = 1, setActionIDRecommended = NULL, setBuildingID = NULL, setDamageCost = NULL, setDateTime = NULL, setDateTimeDate = NULL, setDateTimeTime = NULL, setDescription = NULL, setDistrictID = NULL, setEntityID = NULL, setIncidentNumber = NULL, setIsSuppressed = NULL, setLocationID = NULL, setNumberOfNonEnrolledOffenders = NULL, setNumberOfNonEnrolledVictims = NULL, setReferredByFreeformName = NULL, setReferredByNameID = NULL, setReferredByType = NULL, setReferredByTypeCode = NULL, setReportedToLawEnforcement = NULL, setRoomID = NULL, setSchoolYearID = NULL, setStateDIRSTimeMNID = NULL, setType = NULL, setTypeCode = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Discipline", "Incident", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Incident
#'
#' This function deletes an Incident.
#'
#' @param IncidentID The id of the Incident.\cr Run \code{\link{getAllIncidents}} for a list of Incidents.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted Incident.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIncident <- function(IncidentID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "Incident", IncidentID, EntityID)
}
#' Get all IncidentOffenses.
#'
#' This function returns a dataframe of all IncidentOffenses 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 Discipline
#' @return All IncidentOffenses in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIncidentOffenses <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIncidentOffenseID = F, returnCreatedTime = F, returnHasActions = F, returnHasDrugs = F, returnHasWeapons = F, returnIncidentID = F, returnIsPrimaryOffense = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnOffenseID = 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("Discipline", "IncidentOffense", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific IncidentOffense
#'
#' This function returns fields for an IncidentOffense.
#'
#' @param IncidentOffenseID The id of the IncidentOffense.\cr Run \code{\link{getAllIncidentOffenses}} for a list of IncidentOffenses.
#' @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 Discipline
#' @return Details for the IncidentOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIncidentOffense <- function(IncidentOffenseID, EntityID = 1, returnIncidentOffenseID = F, returnCreatedTime = F, returnHasActions = F, returnHasDrugs = F, returnHasWeapons = F, returnIncidentID = F, returnIsPrimaryOffense = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnOffenseID = 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("Discipline", "IncidentOffense", IncidentOffenseID, searchFields, EntityID)
}
#' Modify a specific IncidentOffense
#'
#' This function modifies fields for an IncidentOffense.
#'
#' @param IncidentOffenseID The id of the IncidentOffense to be modified.\cr Run \code{\link{getAllIncidentOffenses}} for a list of IncidentOffenses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified IncidentOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIncidentOffense <- function(IncidentOffenseID, EntityID = 1, setIncidentID = NULL, setIsPrimaryOffense = NULL, setOffenseID = 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("Discipline", "IncidentOffense", IncidentOffenseID, names(functionParams), functionParams, EntityID)
}
#' Create new IncidentOffense.
#'
#' This function creates a new IncidentOffense.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created IncidentOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIncidentOffense <- function(EntityID = 1, setIncidentID = NULL, setIsPrimaryOffense = NULL, setOffenseID = 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("Discipline", "IncidentOffense", names(functionParams), functionParams, EntityID)
}
#' Delete a specific IncidentOffense
#'
#' This function deletes an IncidentOffense.
#'
#' @param IncidentOffenseID The id of the IncidentOffense.\cr Run \code{\link{getAllIncidentOffenses}} for a list of IncidentOffenses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted IncidentOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIncidentOffense <- function(IncidentOffenseID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "IncidentOffense", IncidentOffenseID, EntityID)
}
#' Get all IncidentOffenseNameActionDetails.
#'
#' This function returns a dataframe of all IncidentOffenseNameActionDetails 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 Discipline
#' @return All IncidentOffenseNameActionDetails in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIncidentOffenseNameActionDetails <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIncidentOffenseNameActionDetailID = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDurationServed = F, returnDurationServedWithLabel = F, returnDurationToServe = F, returnDurationToServeWithLabel = F, returnIncidentOffenseNameActionID = F, returnIsAlternate = F, returnIsGuardianNotified = F, returnIsReadOnlyHistoricalRecord = F, returnLastAlternate = F, returnLocationID = F, returnModifiedTime = F, returnOverdue = F, returnPartialDayPeriods = F, returnPrintComment = F, returnRenderReissueOption = F, returnRoomID = F, returnScheduledTime = F, returnScheduledTimeDate = F, returnScheduledTimeTime = F, returnStaffIDFollowUpOfficer = F, returnStatus = F, returnStatusCode = 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("Discipline", "IncidentOffenseNameActionDetail", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific IncidentOffenseNameActionDetail
#'
#' This function returns fields for an IncidentOffenseNameActionDetail.
#'
#' @param IncidentOffenseNameActionDetailID The id of the IncidentOffenseNameActionDetail.\cr Run \code{\link{getAllIncidentOffenseNameActionDetails}} for a list of IncidentOffenseNameActionDetails.
#' @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 Discipline
#' @return Details for the IncidentOffenseNameActionDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIncidentOffenseNameActionDetail <- function(IncidentOffenseNameActionDetailID, EntityID = 1, returnIncidentOffenseNameActionDetailID = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDurationServed = F, returnDurationServedWithLabel = F, returnDurationToServe = F, returnDurationToServeWithLabel = F, returnIncidentOffenseNameActionID = F, returnIsAlternate = F, returnIsGuardianNotified = F, returnIsReadOnlyHistoricalRecord = F, returnLastAlternate = F, returnLocationID = F, returnModifiedTime = F, returnOverdue = F, returnPartialDayPeriods = F, returnPrintComment = F, returnRenderReissueOption = F, returnRoomID = F, returnScheduledTime = F, returnScheduledTimeDate = F, returnScheduledTimeTime = F, returnStaffIDFollowUpOfficer = F, returnStatus = F, returnStatusCode = 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("Discipline", "IncidentOffenseNameActionDetail", IncidentOffenseNameActionDetailID, searchFields, EntityID)
}
#' Modify a specific IncidentOffenseNameActionDetail
#'
#' This function modifies fields for an IncidentOffenseNameActionDetail.
#'
#' @param IncidentOffenseNameActionDetailID The id of the IncidentOffenseNameActionDetail to be modified.\cr Run \code{\link{getAllIncidentOffenseNameActionDetails}} for a list of IncidentOffenseNameActionDetails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified IncidentOffenseNameActionDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIncidentOffenseNameActionDetail <- function(IncidentOffenseNameActionDetailID, EntityID = 1, setBuildingID = NULL, setComment = NULL, setDurationServed = NULL, setDurationToServe = NULL, setIncidentOffenseNameActionID = NULL, setIsAlternate = NULL, setIsGuardianNotified = NULL, setLocationID = NULL, setRoomID = NULL, setScheduledTime = NULL, setScheduledTimeDate = NULL, setScheduledTimeTime = NULL, setStaffIDFollowUpOfficer = NULL, setStatus = NULL, setStatusCode = 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("Discipline", "IncidentOffenseNameActionDetail", IncidentOffenseNameActionDetailID, names(functionParams), functionParams, EntityID)
}
#' Create new IncidentOffenseNameActionDetail.
#'
#' This function creates a new IncidentOffenseNameActionDetail.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created IncidentOffenseNameActionDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIncidentOffenseNameActionDetail <- function(EntityID = 1, setBuildingID = NULL, setComment = NULL, setDurationServed = NULL, setDurationToServe = NULL, setIncidentOffenseNameActionID = NULL, setIsAlternate = NULL, setIsGuardianNotified = NULL, setLocationID = NULL, setRoomID = NULL, setScheduledTime = NULL, setScheduledTimeDate = NULL, setScheduledTimeTime = NULL, setStaffIDFollowUpOfficer = NULL, setStatus = NULL, setStatusCode = 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("Discipline", "IncidentOffenseNameActionDetail", names(functionParams), functionParams, EntityID)
}
#' Delete a specific IncidentOffenseNameActionDetail
#'
#' This function deletes an IncidentOffenseNameActionDetail.
#'
#' @param IncidentOffenseNameActionDetailID The id of the IncidentOffenseNameActionDetail.\cr Run \code{\link{getAllIncidentOffenseNameActionDetails}} for a list of IncidentOffenseNameActionDetails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted IncidentOffenseNameActionDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIncidentOffenseNameActionDetail <- function(IncidentOffenseNameActionDetailID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "IncidentOffenseNameActionDetail", IncidentOffenseNameActionDetailID, EntityID)
}
#' Get all IncidentOffenseNameActionDetailPeriods.
#'
#' This function returns a dataframe of all IncidentOffenseNameActionDetailPeriods 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 Discipline
#' @return All IncidentOffenseNameActionDetailPeriods in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIncidentOffenseNameActionDetailPeriods <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIncidentOffenseNameActionDetailPeriodID = F, returnAttendancePeriodID = F, returnCreatedTime = F, returnIncidentOffenseNameActionDetailID = F, returnIsReadOnlyHistoricalRecord = 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("Discipline", "IncidentOffenseNameActionDetailPeriod", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific IncidentOffenseNameActionDetailPeriod
#'
#' This function returns fields for an IncidentOffenseNameActionDetailPeriod.
#'
#' @param IncidentOffenseNameActionDetailPeriodID The id of the IncidentOffenseNameActionDetailPeriod.\cr Run \code{\link{getAllIncidentOffenseNameActionDetailPeriods}} for a list of IncidentOffenseNameActionDetailPeriods.
#' @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 Discipline
#' @return Details for the IncidentOffenseNameActionDetailPeriod.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIncidentOffenseNameActionDetailPeriod <- function(IncidentOffenseNameActionDetailPeriodID, EntityID = 1, returnIncidentOffenseNameActionDetailPeriodID = F, returnAttendancePeriodID = F, returnCreatedTime = F, returnIncidentOffenseNameActionDetailID = F, returnIsReadOnlyHistoricalRecord = 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("Discipline", "IncidentOffenseNameActionDetailPeriod", IncidentOffenseNameActionDetailPeriodID, searchFields, EntityID)
}
#' Modify a specific IncidentOffenseNameActionDetailPeriod
#'
#' This function modifies fields for an IncidentOffenseNameActionDetailPeriod.
#'
#' @param IncidentOffenseNameActionDetailPeriodID The id of the IncidentOffenseNameActionDetailPeriod to be modified.\cr Run \code{\link{getAllIncidentOffenseNameActionDetailPeriods}} for a list of IncidentOffenseNameActionDetailPeriods.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified IncidentOffenseNameActionDetailPeriod.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIncidentOffenseNameActionDetailPeriod <- function(IncidentOffenseNameActionDetailPeriodID, EntityID = 1, setAttendancePeriodID = NULL, setIncidentOffenseNameActionDetailID = 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("Discipline", "IncidentOffenseNameActionDetailPeriod", IncidentOffenseNameActionDetailPeriodID, names(functionParams), functionParams, EntityID)
}
#' Create new IncidentOffenseNameActionDetailPeriod.
#'
#' This function creates a new IncidentOffenseNameActionDetailPeriod.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created IncidentOffenseNameActionDetailPeriod.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIncidentOffenseNameActionDetailPeriod <- function(EntityID = 1, setAttendancePeriodID = NULL, setIncidentOffenseNameActionDetailID = 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("Discipline", "IncidentOffenseNameActionDetailPeriod", names(functionParams), functionParams, EntityID)
}
#' Delete a specific IncidentOffenseNameActionDetailPeriod
#'
#' This function deletes an IncidentOffenseNameActionDetailPeriod.
#'
#' @param IncidentOffenseNameActionDetailPeriodID The id of the IncidentOffenseNameActionDetailPeriod.\cr Run \code{\link{getAllIncidentOffenseNameActionDetailPeriods}} for a list of IncidentOffenseNameActionDetailPeriods.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted IncidentOffenseNameActionDetailPeriod.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIncidentOffenseNameActionDetailPeriod <- function(IncidentOffenseNameActionDetailPeriodID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "IncidentOffenseNameActionDetailPeriod", IncidentOffenseNameActionDetailPeriodID, EntityID)
}
#' Get all IncidentOffenseNameActions.
#'
#' This function returns a dataframe of all IncidentOffenseNameActions 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 Discipline
#' @return All IncidentOffenseNameActions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIncidentOffenseNameActions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIncidentOffenseNameActionID = F, returnActionID = F, returnActionTypeID = F, returnActualDurationServed = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDateExpulsionExclusionEnds = F, returnDIRSActionExplanation = F, returnDurationServed = F, returnDurationServedOverride = F, returnDurationToServe = F, returnDurationToServeWithLabel = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnExclusionThroughYearEnd = F, returnExpulsionModified = F, returnExpulsionThroughYearEnd = F, returnFirstActionDetailDateNorthEastExport = F, returnIncidentOffenseNameActionMNID = F, returnIncidentOffenseNameID = F, returnIsGuardianNotified = F, returnIsReadOnlyHistoricalRecord = F, returnLastActionDetailDateNorthEastExport = F, returnLocationID = F, returnModifiedTime = F, returnOrderedDate = F, returnOrderedDateAge = F, returnReturnBeforeYearEnd = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStartTimeDate = F, returnStartTimeTime = F, returnStateDIRSAESTypeMNID = F, returnStatus = F, returnStatusCode = F, returnTotalDurationServed = 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("Discipline", "IncidentOffenseNameAction", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific IncidentOffenseNameAction
#'
#' This function returns fields for an IncidentOffenseNameAction.
#'
#' @param IncidentOffenseNameActionID The id of the IncidentOffenseNameAction.\cr Run \code{\link{getAllIncidentOffenseNameActions}} for a list of IncidentOffenseNameActions.
#' @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 Discipline
#' @return Details for the IncidentOffenseNameAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIncidentOffenseNameAction <- function(IncidentOffenseNameActionID, EntityID = 1, returnIncidentOffenseNameActionID = F, returnActionID = F, returnActionTypeID = F, returnActualDurationServed = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDateExpulsionExclusionEnds = F, returnDIRSActionExplanation = F, returnDurationServed = F, returnDurationServedOverride = F, returnDurationToServe = F, returnDurationToServeWithLabel = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnExclusionThroughYearEnd = F, returnExpulsionModified = F, returnExpulsionThroughYearEnd = F, returnFirstActionDetailDateNorthEastExport = F, returnIncidentOffenseNameActionMNID = F, returnIncidentOffenseNameID = F, returnIsGuardianNotified = F, returnIsReadOnlyHistoricalRecord = F, returnLastActionDetailDateNorthEastExport = F, returnLocationID = F, returnModifiedTime = F, returnOrderedDate = F, returnOrderedDateAge = F, returnReturnBeforeYearEnd = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStartTimeDate = F, returnStartTimeTime = F, returnStateDIRSAESTypeMNID = F, returnStatus = F, returnStatusCode = F, returnTotalDurationServed = 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("Discipline", "IncidentOffenseNameAction", IncidentOffenseNameActionID, searchFields, EntityID)
}
#' Modify a specific IncidentOffenseNameAction
#'
#' This function modifies fields for an IncidentOffenseNameAction.
#'
#' @param IncidentOffenseNameActionID The id of the IncidentOffenseNameAction to be modified.\cr Run \code{\link{getAllIncidentOffenseNameActions}} for a list of IncidentOffenseNameActions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified IncidentOffenseNameAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIncidentOffenseNameAction <- function(IncidentOffenseNameActionID, EntityID = 1, setActionID = NULL, setActionTypeID = NULL, setBuildingID = NULL, setComment = NULL, setDateExpulsionExclusionEnds = NULL, setDIRSActionExplanation = NULL, setDurationServedOverride = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setExclusionThroughYearEnd = NULL, setExpulsionModified = NULL, setExpulsionThroughYearEnd = NULL, setIncidentOffenseNameID = NULL, setIsGuardianNotified = NULL, setLocationID = NULL, setOrderedDate = NULL, setReturnBeforeYearEnd = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStartTimeDate = NULL, setStartTimeTime = NULL, setStateDIRSAESTypeMNID = NULL, setStatus = NULL, setStatusCode = 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("Discipline", "IncidentOffenseNameAction", IncidentOffenseNameActionID, names(functionParams), functionParams, EntityID)
}
#' Create new IncidentOffenseNameAction.
#'
#' This function creates a new IncidentOffenseNameAction.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created IncidentOffenseNameAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIncidentOffenseNameAction <- function(EntityID = 1, setActionID = NULL, setActionTypeID = NULL, setBuildingID = NULL, setComment = NULL, setDateExpulsionExclusionEnds = NULL, setDIRSActionExplanation = NULL, setDurationServedOverride = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setExclusionThroughYearEnd = NULL, setExpulsionModified = NULL, setExpulsionThroughYearEnd = NULL, setIncidentOffenseNameID = NULL, setIsGuardianNotified = NULL, setLocationID = NULL, setOrderedDate = NULL, setReturnBeforeYearEnd = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStartTimeDate = NULL, setStartTimeTime = NULL, setStateDIRSAESTypeMNID = NULL, setStatus = NULL, setStatusCode = 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("Discipline", "IncidentOffenseNameAction", names(functionParams), functionParams, EntityID)
}
#' Delete a specific IncidentOffenseNameAction
#'
#' This function deletes an IncidentOffenseNameAction.
#'
#' @param IncidentOffenseNameActionID The id of the IncidentOffenseNameAction.\cr Run \code{\link{getAllIncidentOffenseNameActions}} for a list of IncidentOffenseNameActions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted IncidentOffenseNameAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIncidentOffenseNameAction <- function(IncidentOffenseNameActionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "IncidentOffenseNameAction", IncidentOffenseNameActionID, EntityID)
}
#' Get all IncidentOffenseNameDrugs.
#'
#' This function returns a dataframe of all IncidentOffenseNameDrugs 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 Discipline
#' @return All IncidentOffenseNameDrugs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIncidentOffenseNameDrugs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIncidentOffenseNameDrugID = F, returnCreatedTime = F, returnDrugID = F, returnIncidentOffenseNameID = F, returnIsReadOnlyHistoricalRecord = 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("Discipline", "IncidentOffenseNameDrug", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific IncidentOffenseNameDrug
#'
#' This function returns fields for an IncidentOffenseNameDrug.
#'
#' @param IncidentOffenseNameDrugID The id of the IncidentOffenseNameDrug.\cr Run \code{\link{getAllIncidentOffenseNameDrugs}} for a list of IncidentOffenseNameDrugs.
#' @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 Discipline
#' @return Details for the IncidentOffenseNameDrug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIncidentOffenseNameDrug <- function(IncidentOffenseNameDrugID, EntityID = 1, returnIncidentOffenseNameDrugID = F, returnCreatedTime = F, returnDrugID = F, returnIncidentOffenseNameID = F, returnIsReadOnlyHistoricalRecord = 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("Discipline", "IncidentOffenseNameDrug", IncidentOffenseNameDrugID, searchFields, EntityID)
}
#' Modify a specific IncidentOffenseNameDrug
#'
#' This function modifies fields for an IncidentOffenseNameDrug.
#'
#' @param IncidentOffenseNameDrugID The id of the IncidentOffenseNameDrug to be modified.\cr Run \code{\link{getAllIncidentOffenseNameDrugs}} for a list of IncidentOffenseNameDrugs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified IncidentOffenseNameDrug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIncidentOffenseNameDrug <- function(IncidentOffenseNameDrugID, EntityID = 1, setDrugID = NULL, setIncidentOffenseNameID = 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("Discipline", "IncidentOffenseNameDrug", IncidentOffenseNameDrugID, names(functionParams), functionParams, EntityID)
}
#' Create new IncidentOffenseNameDrug.
#'
#' This function creates a new IncidentOffenseNameDrug.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created IncidentOffenseNameDrug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIncidentOffenseNameDrug <- function(EntityID = 1, setDrugID = NULL, setIncidentOffenseNameID = 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("Discipline", "IncidentOffenseNameDrug", names(functionParams), functionParams, EntityID)
}
#' Delete a specific IncidentOffenseNameDrug
#'
#' This function deletes an IncidentOffenseNameDrug.
#'
#' @param IncidentOffenseNameDrugID The id of the IncidentOffenseNameDrug.\cr Run \code{\link{getAllIncidentOffenseNameDrugs}} for a list of IncidentOffenseNameDrugs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted IncidentOffenseNameDrug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIncidentOffenseNameDrug <- function(IncidentOffenseNameDrugID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "IncidentOffenseNameDrug", IncidentOffenseNameDrugID, EntityID)
}
#' Get all IncidentOffenseNames.
#'
#' This function returns a dataframe of all IncidentOffenseNames 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 Discipline
#' @return All IncidentOffenseNames in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIncidentOffenseNames <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIncidentOffenseNameID = F, returnAttachmentCount = F, returnAttachmentIndicatorColumn = F, returnCreatedTime = F, returnDisciplineThresholdID = F, returnFirstDrugCodeforNorthEastExport = F, returnFreeformName = F, returnHasActions = F, returnHasDangerousWeapons = F, returnHasDrugs = F, returnHasOpenActions = F, returnHasOverdueActionDetails = F, returnHasWeapons = F, returnIncidentOffenseID = F, returnIncidentOffenseNameMNID = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInjuryOccured = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnIsGuardianNotified = F, returnIsPhysicalAssault = F, returnIsPhysicalAssaultState = F, returnIsReadOnlyHistoricalRecord = F, returnIsStudentOffender = F, returnModifiedTime = F, returnNameID = F, returnNorthEastExportAttendancePeriods = F, returnNorthEastExportOffenseCodes = F, returnOffenderArrestedByLawEnforcement = F, returnOffenseLevelID = F, returnPerceivedMotivationID = F, returnPersonalName = F, returnReportedToLawEnforcement = F, returnStaffIDDisciplineOfficer = F, returnStatement = F, returnStateOffenderActivityMNID = F, returnStateVictimCostMNID = F, returnStateVictimTypeMNID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWasSeriousBodilyInjury = 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("Discipline", "IncidentOffenseName", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific IncidentOffenseName
#'
#' This function returns fields for an IncidentOffenseName.
#'
#' @param IncidentOffenseNameID The id of the IncidentOffenseName.\cr Run \code{\link{getAllIncidentOffenseNames}} for a list of IncidentOffenseNames.
#' @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 Discipline
#' @return Details for the IncidentOffenseName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIncidentOffenseName <- function(IncidentOffenseNameID, EntityID = 1, returnIncidentOffenseNameID = F, returnAttachmentCount = F, returnAttachmentIndicatorColumn = F, returnCreatedTime = F, returnDisciplineThresholdID = F, returnFirstDrugCodeforNorthEastExport = F, returnFreeformName = F, returnHasActions = F, returnHasDangerousWeapons = F, returnHasDrugs = F, returnHasOpenActions = F, returnHasOverdueActionDetails = F, returnHasWeapons = F, returnIncidentOffenseID = F, returnIncidentOffenseNameMNID = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInjuryOccured = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnIsGuardianNotified = F, returnIsPhysicalAssault = F, returnIsPhysicalAssaultState = F, returnIsReadOnlyHistoricalRecord = F, returnIsStudentOffender = F, returnModifiedTime = F, returnNameID = F, returnNorthEastExportAttendancePeriods = F, returnNorthEastExportOffenseCodes = F, returnOffenderArrestedByLawEnforcement = F, returnOffenseLevelID = F, returnPerceivedMotivationID = F, returnPersonalName = F, returnReportedToLawEnforcement = F, returnStaffIDDisciplineOfficer = F, returnStatement = F, returnStateOffenderActivityMNID = F, returnStateVictimCostMNID = F, returnStateVictimTypeMNID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWasSeriousBodilyInjury = 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("Discipline", "IncidentOffenseName", IncidentOffenseNameID, searchFields, EntityID)
}
#' Modify a specific IncidentOffenseName
#'
#' This function modifies fields for an IncidentOffenseName.
#'
#' @param IncidentOffenseNameID The id of the IncidentOffenseName to be modified.\cr Run \code{\link{getAllIncidentOffenseNames}} for a list of IncidentOffenseNames.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified IncidentOffenseName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIncidentOffenseName <- function(IncidentOffenseNameID, EntityID = 1, setDisciplineThresholdID = NULL, setFreeformName = NULL, setIncidentOffenseID = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInjuryOccured = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setIsGuardianNotified = NULL, setIsPhysicalAssault = NULL, setIsPhysicalAssaultState = NULL, setNameID = NULL, setOffenderArrestedByLawEnforcement = NULL, setOffenseLevelID = NULL, setPerceivedMotivationID = NULL, setReportedToLawEnforcement = NULL, setStaffIDDisciplineOfficer = NULL, setStatement = NULL, setStateOffenderActivityMNID = NULL, setStateVictimCostMNID = NULL, setStateVictimTypeMNID = NULL, setWasSeriousBodilyInjury = 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("Discipline", "IncidentOffenseName", IncidentOffenseNameID, names(functionParams), functionParams, EntityID)
}
#' Create new IncidentOffenseName.
#'
#' This function creates a new IncidentOffenseName.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created IncidentOffenseName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIncidentOffenseName <- function(EntityID = 1, setDisciplineThresholdID = NULL, setFreeformName = NULL, setIncidentOffenseID = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInjuryOccured = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setIsGuardianNotified = NULL, setIsPhysicalAssault = NULL, setIsPhysicalAssaultState = NULL, setNameID = NULL, setOffenderArrestedByLawEnforcement = NULL, setOffenseLevelID = NULL, setPerceivedMotivationID = NULL, setReportedToLawEnforcement = NULL, setStaffIDDisciplineOfficer = NULL, setStatement = NULL, setStateOffenderActivityMNID = NULL, setStateVictimCostMNID = NULL, setStateVictimTypeMNID = NULL, setWasSeriousBodilyInjury = 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("Discipline", "IncidentOffenseName", names(functionParams), functionParams, EntityID)
}
#' Delete a specific IncidentOffenseName
#'
#' This function deletes an IncidentOffenseName.
#'
#' @param IncidentOffenseNameID The id of the IncidentOffenseName.\cr Run \code{\link{getAllIncidentOffenseNames}} for a list of IncidentOffenseNames.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted IncidentOffenseName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIncidentOffenseName <- function(IncidentOffenseNameID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "IncidentOffenseName", IncidentOffenseNameID, EntityID)
}
#' Get all IncidentOffenseNameReportRunHistories.
#'
#' This function returns a dataframe of all IncidentOffenseNameReportRunHistories 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 Discipline
#' @return All IncidentOffenseNameReportRunHistories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIncidentOffenseNameReportRunHistories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIncidentOffenseNameReportRunHistoryID = F, returnAttachmentID = F, returnColumnHeaderData1 = F, returnColumnHeaderData10 = F, returnColumnHeaderData2 = F, returnColumnHeaderData3 = F, returnColumnHeaderData4 = F, returnColumnHeaderData5 = F, returnColumnHeaderData6 = F, returnColumnHeaderData7 = F, returnColumnHeaderData8 = F, returnColumnHeaderData9 = F, returnCreatedTime = F, returnDisciplineLetterRunHistoryID = F, returnIncidentOffenseNameID = F, returnIsActive = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnStudentID = F, returnUnboundBody = F, returnUnboundFooter = F, returnUnboundHeader = 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("Discipline", "IncidentOffenseNameReportRunHistory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific IncidentOffenseNameReportRunHistory
#'
#' This function returns fields for an IncidentOffenseNameReportRunHistory.
#'
#' @param IncidentOffenseNameReportRunHistoryID The id of the IncidentOffenseNameReportRunHistory.\cr Run \code{\link{getAllIncidentOffenseNameReportRunHistories}} for a list of IncidentOffenseNameReportRunHistories.
#' @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 Discipline
#' @return Details for the IncidentOffenseNameReportRunHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIncidentOffenseNameReportRunHistory <- function(IncidentOffenseNameReportRunHistoryID, EntityID = 1, returnIncidentOffenseNameReportRunHistoryID = F, returnAttachmentID = F, returnColumnHeaderData1 = F, returnColumnHeaderData10 = F, returnColumnHeaderData2 = F, returnColumnHeaderData3 = F, returnColumnHeaderData4 = F, returnColumnHeaderData5 = F, returnColumnHeaderData6 = F, returnColumnHeaderData7 = F, returnColumnHeaderData8 = F, returnColumnHeaderData9 = F, returnCreatedTime = F, returnDisciplineLetterRunHistoryID = F, returnIncidentOffenseNameID = F, returnIsActive = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnStudentID = F, returnUnboundBody = F, returnUnboundFooter = F, returnUnboundHeader = 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("Discipline", "IncidentOffenseNameReportRunHistory", IncidentOffenseNameReportRunHistoryID, searchFields, EntityID)
}
#' Modify a specific IncidentOffenseNameReportRunHistory
#'
#' This function modifies fields for an IncidentOffenseNameReportRunHistory.
#'
#' @param IncidentOffenseNameReportRunHistoryID The id of the IncidentOffenseNameReportRunHistory to be modified.\cr Run \code{\link{getAllIncidentOffenseNameReportRunHistories}} for a list of IncidentOffenseNameReportRunHistorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified IncidentOffenseNameReportRunHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIncidentOffenseNameReportRunHistory <- function(IncidentOffenseNameReportRunHistoryID, EntityID = 1, setAttachmentID = NULL, setColumnHeaderData1 = NULL, setColumnHeaderData10 = NULL, setColumnHeaderData2 = NULL, setColumnHeaderData3 = NULL, setColumnHeaderData4 = NULL, setColumnHeaderData5 = NULL, setColumnHeaderData6 = NULL, setColumnHeaderData7 = NULL, setColumnHeaderData8 = NULL, setColumnHeaderData9 = NULL, setDisciplineLetterRunHistoryID = NULL, setIncidentOffenseNameID = NULL, setIsActive = NULL, setStudentID = NULL, setUnboundBody = NULL, setUnboundFooter = NULL, setUnboundHeader = 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("Discipline", "IncidentOffenseNameReportRunHistory", IncidentOffenseNameReportRunHistoryID, names(functionParams), functionParams, EntityID)
}
#' Create new IncidentOffenseNameReportRunHistory.
#'
#' This function creates a new IncidentOffenseNameReportRunHistory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created IncidentOffenseNameReportRunHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIncidentOffenseNameReportRunHistory <- function(EntityID = 1, setAttachmentID = NULL, setColumnHeaderData1 = NULL, setColumnHeaderData10 = NULL, setColumnHeaderData2 = NULL, setColumnHeaderData3 = NULL, setColumnHeaderData4 = NULL, setColumnHeaderData5 = NULL, setColumnHeaderData6 = NULL, setColumnHeaderData7 = NULL, setColumnHeaderData8 = NULL, setColumnHeaderData9 = NULL, setDisciplineLetterRunHistoryID = NULL, setIncidentOffenseNameID = NULL, setIsActive = NULL, setStudentID = NULL, setUnboundBody = NULL, setUnboundFooter = NULL, setUnboundHeader = 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("Discipline", "IncidentOffenseNameReportRunHistory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific IncidentOffenseNameReportRunHistory
#'
#' This function deletes an IncidentOffenseNameReportRunHistory.
#'
#' @param IncidentOffenseNameReportRunHistoryID The id of the IncidentOffenseNameReportRunHistory.\cr Run \code{\link{getAllIncidentOffenseNameReportRunHistories}} for a list of IncidentOffenseNameReportRunHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted IncidentOffenseNameReportRunHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIncidentOffenseNameReportRunHistory <- function(IncidentOffenseNameReportRunHistoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "IncidentOffenseNameReportRunHistory", IncidentOffenseNameReportRunHistoryID, EntityID)
}
#' Get all IncidentOffenseNameWeapons.
#'
#' This function returns a dataframe of all IncidentOffenseNameWeapons 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 Discipline
#' @return All IncidentOffenseNameWeapons in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllIncidentOffenseNameWeapons <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnIncidentOffenseNameWeaponID = F, returnCreatedTime = F, returnGunFoundInTrunk = F, returnGunWasInCase = F, returnGunWasLoaded = F, returnIncidentOffenseNameID = F, returnIncidentOffenseNameWeaponMNID = F, returnIsReadOnlyHistoricalRecord = F, returnMeetsFederalStatuteOfDangerousWeapon = F, returnMeetsStateStatuteOfDangerousWeapon = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWeaponCount = F, returnWeaponID = 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("Discipline", "IncidentOffenseNameWeapon", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific IncidentOffenseNameWeapon
#'
#' This function returns fields for an IncidentOffenseNameWeapon.
#'
#' @param IncidentOffenseNameWeaponID The id of the IncidentOffenseNameWeapon.\cr Run \code{\link{getAllIncidentOffenseNameWeapons}} for a list of IncidentOffenseNameWeapons.
#' @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 Discipline
#' @return Details for the IncidentOffenseNameWeapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getIncidentOffenseNameWeapon <- function(IncidentOffenseNameWeaponID, EntityID = 1, returnIncidentOffenseNameWeaponID = F, returnCreatedTime = F, returnGunFoundInTrunk = F, returnGunWasInCase = F, returnGunWasLoaded = F, returnIncidentOffenseNameID = F, returnIncidentOffenseNameWeaponMNID = F, returnIsReadOnlyHistoricalRecord = F, returnMeetsFederalStatuteOfDangerousWeapon = F, returnMeetsStateStatuteOfDangerousWeapon = F, returnModifiedTime = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWeaponCount = F, returnWeaponID = 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("Discipline", "IncidentOffenseNameWeapon", IncidentOffenseNameWeaponID, searchFields, EntityID)
}
#' Modify a specific IncidentOffenseNameWeapon
#'
#' This function modifies fields for an IncidentOffenseNameWeapon.
#'
#' @param IncidentOffenseNameWeaponID The id of the IncidentOffenseNameWeapon to be modified.\cr Run \code{\link{getAllIncidentOffenseNameWeapons}} for a list of IncidentOffenseNameWeapons.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified IncidentOffenseNameWeapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyIncidentOffenseNameWeapon <- function(IncidentOffenseNameWeaponID, EntityID = 1, setGunFoundInTrunk = NULL, setGunWasInCase = NULL, setGunWasLoaded = NULL, setIncidentOffenseNameID = NULL, setMeetsFederalStatuteOfDangerousWeapon = NULL, setMeetsStateStatuteOfDangerousWeapon = NULL, setWeaponCount = NULL, setWeaponID = 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("Discipline", "IncidentOffenseNameWeapon", IncidentOffenseNameWeaponID, names(functionParams), functionParams, EntityID)
}
#' Create new IncidentOffenseNameWeapon.
#'
#' This function creates a new IncidentOffenseNameWeapon.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created IncidentOffenseNameWeapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createIncidentOffenseNameWeapon <- function(EntityID = 1, setGunFoundInTrunk = NULL, setGunWasInCase = NULL, setGunWasLoaded = NULL, setIncidentOffenseNameID = NULL, setMeetsFederalStatuteOfDangerousWeapon = NULL, setMeetsStateStatuteOfDangerousWeapon = NULL, setWeaponCount = NULL, setWeaponID = 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("Discipline", "IncidentOffenseNameWeapon", names(functionParams), functionParams, EntityID)
}
#' Delete a specific IncidentOffenseNameWeapon
#'
#' This function deletes an IncidentOffenseNameWeapon.
#'
#' @param IncidentOffenseNameWeaponID The id of the IncidentOffenseNameWeapon.\cr Run \code{\link{getAllIncidentOffenseNameWeapons}} for a list of IncidentOffenseNameWeapons.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted IncidentOffenseNameWeapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteIncidentOffenseNameWeapon <- function(IncidentOffenseNameWeaponID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "IncidentOffenseNameWeapon", IncidentOffenseNameWeaponID, EntityID)
}
#' Get all Locations.
#'
#' This function returns a dataframe of all Locations 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 Discipline
#' @return All Locations in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllLocations <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnLocationID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnEdFiIncidentLocationID = F, returnLocationMNID = F, returnModifiedTime = F, returnStateIncidentLocationMNID = 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("Discipline", "Location", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Location
#'
#' This function returns fields for a Location.
#'
#' @param LocationID The id of the Location.\cr Run \code{\link{getAllLocations}} for a list of Locations.
#' @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 Discipline
#' @return Details for the Location.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getLocation <- function(LocationID, EntityID = 1, returnLocationID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnEdFiIncidentLocationID = F, returnLocationMNID = F, returnModifiedTime = F, returnStateIncidentLocationMNID = 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("Discipline", "Location", LocationID, searchFields, EntityID)
}
#' Modify a specific Location
#'
#' This function modifies fields for a Location.
#'
#' @param LocationID The id of the Location to be modified.\cr Run \code{\link{getAllLocations}} for a list of Locations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified Location.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyLocation <- function(LocationID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setEdFiIncidentLocationID = NULL, setStateIncidentLocationMNID = 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("Discipline", "Location", LocationID, names(functionParams), functionParams, EntityID)
}
#' Create new Location.
#'
#' This function creates a new Location.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created Location.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createLocation <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setEdFiIncidentLocationID = NULL, setStateIncidentLocationMNID = 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("Discipline", "Location", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Location
#'
#' This function deletes a Location.
#'
#' @param LocationID The id of the Location.\cr Run \code{\link{getAllLocations}} for a list of Locations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted Location.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteLocation <- function(LocationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "Location", LocationID, EntityID)
}
#' Get all NextIncidentNumbers.
#'
#' This function returns a dataframe of all NextIncidentNumbers 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 Discipline
#' @return All NextIncidentNumbers in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllNextIncidentNumbers <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnNextIncidentNumberID = F, returnCreatedTime = F, returnDistrictID = F, returnModifiedTime = F, returnSchoolYearID = F, returnSequenceNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Discipline", "NextIncidentNumber", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific NextIncidentNumber
#'
#' This function returns fields for a NextIncidentNumber.
#'
#' @param NextIncidentNumberID The id of the NextIncidentNumber.\cr Run \code{\link{getAllNextIncidentNumbers}} for a list of NextIncidentNumbers.
#' @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 Discipline
#' @return Details for the NextIncidentNumber.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getNextIncidentNumber <- function(NextIncidentNumberID, EntityID = 1, returnNextIncidentNumberID = F, returnCreatedTime = F, returnDistrictID = F, returnModifiedTime = F, returnSchoolYearID = F, returnSequenceNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Discipline", "NextIncidentNumber", NextIncidentNumberID, searchFields, EntityID)
}
#' Modify a specific NextIncidentNumber
#'
#' This function modifies fields for a NextIncidentNumber.
#'
#' @param NextIncidentNumberID The id of the NextIncidentNumber to be modified.\cr Run \code{\link{getAllNextIncidentNumbers}} for a list of NextIncidentNumbers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified NextIncidentNumber.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyNextIncidentNumber <- function(NextIncidentNumberID, EntityID = 1, setDistrictID = NULL, setSchoolYearID = NULL, setSequenceNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Discipline", "NextIncidentNumber", NextIncidentNumberID, names(functionParams), functionParams, EntityID)
}
#' Create new NextIncidentNumber.
#'
#' This function creates a new NextIncidentNumber.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created NextIncidentNumber.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createNextIncidentNumber <- function(EntityID = 1, setDistrictID = NULL, setSchoolYearID = NULL, setSequenceNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Discipline", "NextIncidentNumber", names(functionParams), functionParams, EntityID)
}
#' Delete a specific NextIncidentNumber
#'
#' This function deletes a NextIncidentNumber.
#'
#' @param NextIncidentNumberID The id of the NextIncidentNumber.\cr Run \code{\link{getAllNextIncidentNumbers}} for a list of NextIncidentNumbers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted NextIncidentNumber.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteNextIncidentNumber <- function(NextIncidentNumberID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "NextIncidentNumber", NextIncidentNumberID, EntityID)
}
#' Get all Offenses.
#'
#' This function returns a dataframe of all Offenses 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 Discipline
#' @return All Offenses in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOffenses <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOffenseID = F, returnAllowActionRecommendations = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDefaultActionID = F, returnDescription = F, returnDistrictID = F, returnFederalOffenseCategoryID = F, returnHarassmentBullying = F, returnHarassmentBullyingCode = F, returnIsDrugRelated = F, returnIsInjuryThreat = F, returnIsReadOnlyHistoricalRecord = F, returnIsWeaponRelated = F, returnModifiedTime = F, returnOffenseIDClonedFrom = F, returnOffenseLevelIDDefault = F, returnRestrictActions = F, returnSchoolYearID = F, returnUseForReferral = 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("Discipline", "Offense", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Offense
#'
#' This function returns fields for an Offense.
#'
#' @param OffenseID The id of the Offense.\cr Run \code{\link{getAllOffenses}} for a list of Offenses.
#' @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 Discipline
#' @return Details for the Offense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOffense <- function(OffenseID, EntityID = 1, returnOffenseID = F, returnAllowActionRecommendations = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDefaultActionID = F, returnDescription = F, returnDistrictID = F, returnFederalOffenseCategoryID = F, returnHarassmentBullying = F, returnHarassmentBullyingCode = F, returnIsDrugRelated = F, returnIsInjuryThreat = F, returnIsReadOnlyHistoricalRecord = F, returnIsWeaponRelated = F, returnModifiedTime = F, returnOffenseIDClonedFrom = F, returnOffenseLevelIDDefault = F, returnRestrictActions = F, returnSchoolYearID = F, returnUseForReferral = 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("Discipline", "Offense", OffenseID, searchFields, EntityID)
}
#' Modify a specific Offense
#'
#' This function modifies fields for an Offense.
#'
#' @param OffenseID The id of the Offense to be modified.\cr Run \code{\link{getAllOffenses}} for a list of Offenses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified Offense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOffense <- function(OffenseID, EntityID = 1, setAllowActionRecommendations = NULL, setCode = NULL, setDefaultActionID = NULL, setDescription = NULL, setDistrictID = NULL, setFederalOffenseCategoryID = NULL, setHarassmentBullying = NULL, setHarassmentBullyingCode = NULL, setIsDrugRelated = NULL, setIsInjuryThreat = NULL, setIsWeaponRelated = NULL, setOffenseIDClonedFrom = NULL, setOffenseLevelIDDefault = NULL, setRestrictActions = NULL, setSchoolYearID = NULL, setUseForReferral = 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("Discipline", "Offense", OffenseID, names(functionParams), functionParams, EntityID)
}
#' Create new Offense.
#'
#' This function creates a new Offense.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created Offense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOffense <- function(EntityID = 1, setAllowActionRecommendations = NULL, setCode = NULL, setDefaultActionID = NULL, setDescription = NULL, setDistrictID = NULL, setFederalOffenseCategoryID = NULL, setHarassmentBullying = NULL, setHarassmentBullyingCode = NULL, setIsDrugRelated = NULL, setIsInjuryThreat = NULL, setIsWeaponRelated = NULL, setOffenseIDClonedFrom = NULL, setOffenseLevelIDDefault = NULL, setRestrictActions = NULL, setSchoolYearID = NULL, setUseForReferral = 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("Discipline", "Offense", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Offense
#'
#' This function deletes an Offense.
#'
#' @param OffenseID The id of the Offense.\cr Run \code{\link{getAllOffenses}} for a list of Offenses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted Offense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOffense <- function(OffenseID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "Offense", OffenseID, EntityID)
}
#' Get all OffenseActions.
#'
#' This function returns a dataframe of all OffenseActions 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 Discipline
#' @return All OffenseActions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOffenseActions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOffenseActionID = F, returnActionID = F, returnCreatedTime = F, returnIsReadOnlyHistoricalRecord = F, returnIsReferralAction = F, returnModifiedTime = F, returnOffenseActionIDClonedFrom = F, returnOffenseID = 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("Discipline", "OffenseAction", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OffenseAction
#'
#' This function returns fields for an OffenseAction.
#'
#' @param OffenseActionID The id of the OffenseAction.\cr Run \code{\link{getAllOffenseActions}} for a list of OffenseActions.
#' @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 Discipline
#' @return Details for the OffenseAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOffenseAction <- function(OffenseActionID, EntityID = 1, returnOffenseActionID = F, returnActionID = F, returnCreatedTime = F, returnIsReadOnlyHistoricalRecord = F, returnIsReferralAction = F, returnModifiedTime = F, returnOffenseActionIDClonedFrom = F, returnOffenseID = 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("Discipline", "OffenseAction", OffenseActionID, searchFields, EntityID)
}
#' Modify a specific OffenseAction
#'
#' This function modifies fields for an OffenseAction.
#'
#' @param OffenseActionID The id of the OffenseAction to be modified.\cr Run \code{\link{getAllOffenseActions}} for a list of OffenseActions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified OffenseAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOffenseAction <- function(OffenseActionID, EntityID = 1, setActionID = NULL, setIsReferralAction = NULL, setOffenseActionIDClonedFrom = NULL, setOffenseID = 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("Discipline", "OffenseAction", OffenseActionID, names(functionParams), functionParams, EntityID)
}
#' Create new OffenseAction.
#'
#' This function creates a new OffenseAction.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created OffenseAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOffenseAction <- function(EntityID = 1, setActionID = NULL, setIsReferralAction = NULL, setOffenseActionIDClonedFrom = NULL, setOffenseID = 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("Discipline", "OffenseAction", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OffenseAction
#'
#' This function deletes an OffenseAction.
#'
#' @param OffenseActionID The id of the OffenseAction.\cr Run \code{\link{getAllOffenseActions}} for a list of OffenseActions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted OffenseAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOffenseAction <- function(OffenseActionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "OffenseAction", OffenseActionID, EntityID)
}
#' Get all OffenseLevels.
#'
#' This function returns a dataframe of all OffenseLevels 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 Discipline
#' @return All OffenseLevels in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOffenseLevels <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOffenseLevelID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnOffenseLevelIDClonedFrom = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Discipline", "OffenseLevel", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OffenseLevel
#'
#' This function returns fields for an OffenseLevel.
#'
#' @param OffenseLevelID The id of the OffenseLevel.\cr Run \code{\link{getAllOffenseLevels}} for a list of OffenseLevels.
#' @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 Discipline
#' @return Details for the OffenseLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOffenseLevel <- function(OffenseLevelID, EntityID = 1, returnOffenseLevelID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnOffenseLevelIDClonedFrom = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Discipline", "OffenseLevel", OffenseLevelID, searchFields, EntityID)
}
#' Modify a specific OffenseLevel
#'
#' This function modifies fields for an OffenseLevel.
#'
#' @param OffenseLevelID The id of the OffenseLevel to be modified.\cr Run \code{\link{getAllOffenseLevels}} for a list of OffenseLevels.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified OffenseLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOffenseLevel <- function(OffenseLevelID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setOffenseLevelIDClonedFrom = NULL, setSchoolYearID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Discipline", "OffenseLevel", OffenseLevelID, names(functionParams), functionParams, EntityID)
}
#' Create new OffenseLevel.
#'
#' This function creates a new OffenseLevel.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created OffenseLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOffenseLevel <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setOffenseLevelIDClonedFrom = NULL, setSchoolYearID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Discipline", "OffenseLevel", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OffenseLevel
#'
#' This function deletes an OffenseLevel.
#'
#' @param OffenseLevelID The id of the OffenseLevel.\cr Run \code{\link{getAllOffenseLevels}} for a list of OffenseLevels.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted OffenseLevel.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOffenseLevel <- function(OffenseLevelID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "OffenseLevel", OffenseLevelID, EntityID)
}
#' Get all PerceivedMotivations.
#'
#' This function returns a dataframe of all PerceivedMotivations 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 Discipline
#' @return All PerceivedMotivations in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllPerceivedMotivations <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnPerceivedMotivationID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnPerceivedMotivationIDClonedFrom = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Discipline", "PerceivedMotivation", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific PerceivedMotivation
#'
#' This function returns fields for a PerceivedMotivation.
#'
#' @param PerceivedMotivationID The id of the PerceivedMotivation.\cr Run \code{\link{getAllPerceivedMotivations}} for a list of PerceivedMotivations.
#' @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 Discipline
#' @return Details for the PerceivedMotivation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getPerceivedMotivation <- function(PerceivedMotivationID, EntityID = 1, returnPerceivedMotivationID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnPerceivedMotivationIDClonedFrom = F, returnSchoolYearID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Discipline", "PerceivedMotivation", PerceivedMotivationID, searchFields, EntityID)
}
#' Modify a specific PerceivedMotivation
#'
#' This function modifies fields for a PerceivedMotivation.
#'
#' @param PerceivedMotivationID The id of the PerceivedMotivation to be modified.\cr Run \code{\link{getAllPerceivedMotivations}} for a list of PerceivedMotivations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified PerceivedMotivation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyPerceivedMotivation <- function(PerceivedMotivationID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setPerceivedMotivationIDClonedFrom = NULL, setSchoolYearID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Discipline", "PerceivedMotivation", PerceivedMotivationID, names(functionParams), functionParams, EntityID)
}
#' Create new PerceivedMotivation.
#'
#' This function creates a new PerceivedMotivation.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created PerceivedMotivation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createPerceivedMotivation <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setPerceivedMotivationIDClonedFrom = NULL, setSchoolYearID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Discipline", "PerceivedMotivation", names(functionParams), functionParams, EntityID)
}
#' Delete a specific PerceivedMotivation
#'
#' This function deletes a PerceivedMotivation.
#'
#' @param PerceivedMotivationID The id of the PerceivedMotivation.\cr Run \code{\link{getAllPerceivedMotivations}} for a list of PerceivedMotivations.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted PerceivedMotivation.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deletePerceivedMotivation <- function(PerceivedMotivationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "PerceivedMotivation", PerceivedMotivationID, EntityID)
}
#' Get all TempIncidentInvolvedPersons.
#'
#' This function returns a dataframe of all TempIncidentInvolvedPersons 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 Discipline
#' @return All TempIncidentInvolvedPersons in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentInvolvedPersons <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentInvolvedPersonID = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnISSCount = F, returnISSPartialCount = F, returnModifiedTime = F, returnNameID = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Discipline", "TempIncidentInvolvedPerson", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentInvolvedPerson
#'
#' This function returns fields for a TempIncidentInvolvedPerson.
#'
#' @param TempIncidentInvolvedPersonID The id of the TempIncidentInvolvedPerson.\cr Run \code{\link{getAllTempIncidentInvolvedPersons}} for a list of TempIncidentInvolvedPersons.
#' @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 Discipline
#' @return Details for the TempIncidentInvolvedPerson.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentInvolvedPerson <- function(TempIncidentInvolvedPersonID, EntityID = 1, returnTempIncidentInvolvedPersonID = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnISSCount = F, returnISSPartialCount = F, returnModifiedTime = F, returnNameID = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Discipline", "TempIncidentInvolvedPerson", TempIncidentInvolvedPersonID, searchFields, EntityID)
}
#' Modify a specific TempIncidentInvolvedPerson
#'
#' This function modifies fields for a TempIncidentInvolvedPerson.
#'
#' @param TempIncidentInvolvedPersonID The id of the TempIncidentInvolvedPerson to be modified.\cr Run \code{\link{getAllTempIncidentInvolvedPersons}} for a list of TempIncidentInvolvedPersons.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentInvolvedPerson.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentInvolvedPerson <- function(TempIncidentInvolvedPersonID, EntityID = 1, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setISSCount = NULL, setISSPartialCount = NULL, setNameID = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Discipline", "TempIncidentInvolvedPerson", TempIncidentInvolvedPersonID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentInvolvedPerson.
#'
#' This function creates a new TempIncidentInvolvedPerson.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentInvolvedPerson.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentInvolvedPerson <- function(EntityID = 1, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setISSCount = NULL, setISSPartialCount = NULL, setNameID = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Discipline", "TempIncidentInvolvedPerson", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentInvolvedPerson
#'
#' This function deletes a TempIncidentInvolvedPerson.
#'
#' @param TempIncidentInvolvedPersonID The id of the TempIncidentInvolvedPerson.\cr Run \code{\link{getAllTempIncidentInvolvedPersons}} for a list of TempIncidentInvolvedPersons.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentInvolvedPerson.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentInvolvedPerson <- function(TempIncidentInvolvedPersonID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentInvolvedPerson", TempIncidentInvolvedPersonID, EntityID)
}
#' Get all TempIncidentInvolvedPersonINs.
#'
#' This function returns a dataframe of all TempIncidentInvolvedPersonINs 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 Discipline
#' @return All TempIncidentInvolvedPersonINs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentInvolvedPersonINs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentInvolvedPersonID = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnIsChemicalRestraint = F, returnIsMechanicalRestraint = F, returnIsPhysicalRestraint = F, returnISSCount = F, returnIsSeclusion = F, returnISSPartialCount = F, returnModifiedTime = F, returnNameID = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStaffIDResourceOfficer = F, returnStateArrestReasonINID = F, returnStateArrestTypeINID = F, returnStateCriminalEventINID = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Discipline", "TempIncidentInvolvedPersonIN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentInvolvedPersonIN
#'
#' This function returns fields for a TempIncidentInvolvedPersonIN.
#'
#' @param TempIncidentInvolvedPersonINID The id of the TempIncidentInvolvedPersonIN.\cr Run \code{\link{getAllTempIncidentInvolvedPersonINs}} for a list of TempIncidentInvolvedPersonINs.
#' @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 Discipline
#' @return Details for the TempIncidentInvolvedPersonIN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentInvolvedPersonIN <- function(TempIncidentInvolvedPersonINID, EntityID = 1, returnTempIncidentInvolvedPersonID = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnIsChemicalRestraint = F, returnIsMechanicalRestraint = F, returnIsPhysicalRestraint = F, returnISSCount = F, returnIsSeclusion = F, returnISSPartialCount = F, returnModifiedTime = F, returnNameID = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStaffIDResourceOfficer = F, returnStateArrestReasonINID = F, returnStateArrestTypeINID = F, returnStateCriminalEventINID = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Discipline", "TempIncidentInvolvedPersonIN", TempIncidentInvolvedPersonINID, searchFields, EntityID)
}
#' Modify a specific TempIncidentInvolvedPersonIN
#'
#' This function modifies fields for a TempIncidentInvolvedPersonIN.
#'
#' @param TempIncidentInvolvedPersonINID The id of the TempIncidentInvolvedPersonIN to be modified.\cr Run \code{\link{getAllTempIncidentInvolvedPersonINs}} for a list of TempIncidentInvolvedPersonINs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentInvolvedPersonIN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentInvolvedPersonIN <- function(TempIncidentInvolvedPersonINID, EntityID = 1, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setIsChemicalRestraint = NULL, setIsMechanicalRestraint = NULL, setIsPhysicalRestraint = NULL, setISSCount = NULL, setIsSeclusion = NULL, setISSPartialCount = NULL, setNameID = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStaffIDResourceOfficer = NULL, setStateArrestReasonINID = NULL, setStateArrestTypeINID = NULL, setStateCriminalEventINID = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Discipline", "TempIncidentInvolvedPersonIN", TempIncidentInvolvedPersonINID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentInvolvedPersonIN.
#'
#' This function creates a new TempIncidentInvolvedPersonIN.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentInvolvedPersonIN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentInvolvedPersonIN <- function(EntityID = 1, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setIsChemicalRestraint = NULL, setIsMechanicalRestraint = NULL, setIsPhysicalRestraint = NULL, setISSCount = NULL, setIsSeclusion = NULL, setISSPartialCount = NULL, setNameID = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStaffIDResourceOfficer = NULL, setStateArrestReasonINID = NULL, setStateArrestTypeINID = NULL, setStateCriminalEventINID = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Discipline", "TempIncidentInvolvedPersonIN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentInvolvedPersonIN
#'
#' This function deletes a TempIncidentInvolvedPersonIN.
#'
#' @param TempIncidentInvolvedPersonINID The id of the TempIncidentInvolvedPersonIN.\cr Run \code{\link{getAllTempIncidentInvolvedPersonINs}} for a list of TempIncidentInvolvedPersonINs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentInvolvedPersonIN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentInvolvedPersonIN <- function(TempIncidentInvolvedPersonINID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentInvolvedPersonIN", TempIncidentInvolvedPersonINID, EntityID)
}
#' Get all TempIncidentInvolvedPersonMNs.
#'
#' This function returns a dataframe of all TempIncidentInvolvedPersonMNs 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 Discipline
#' @return All TempIncidentInvolvedPersonMNs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentInvolvedPersonMNs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentInvolvedPersonID = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInjuryOccured = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnIsPhysicalAssault = F, returnIsPhysicalAssaultState = F, returnISSCount = F, returnISSPartialCount = F, returnModifiedTime = F, returnNameID = F, returnOffenderArrestedByLawEnforcement = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnReportedToLawEnforcement = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStateOffenderActivityMNID = F, returnStateVictimCostMNID = F, returnStateVictimTypeMNID = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWasSeriousBodilyInjury = 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("Discipline", "TempIncidentInvolvedPersonMN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentInvolvedPersonMN
#'
#' This function returns fields for a TempIncidentInvolvedPersonMN.
#'
#' @param TempIncidentInvolvedPersonMNID The id of the TempIncidentInvolvedPersonMN.\cr Run \code{\link{getAllTempIncidentInvolvedPersonMNs}} for a list of TempIncidentInvolvedPersonMNs.
#' @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 Discipline
#' @return Details for the TempIncidentInvolvedPersonMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentInvolvedPersonMN <- function(TempIncidentInvolvedPersonMNID, EntityID = 1, returnTempIncidentInvolvedPersonID = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInjuryOccured = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnIsPhysicalAssault = F, returnIsPhysicalAssaultState = F, returnISSCount = F, returnISSPartialCount = F, returnModifiedTime = F, returnNameID = F, returnOffenderArrestedByLawEnforcement = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnReportedToLawEnforcement = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStateOffenderActivityMNID = F, returnStateVictimCostMNID = F, returnStateVictimTypeMNID = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWasSeriousBodilyInjury = 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("Discipline", "TempIncidentInvolvedPersonMN", TempIncidentInvolvedPersonMNID, searchFields, EntityID)
}
#' Modify a specific TempIncidentInvolvedPersonMN
#'
#' This function modifies fields for a TempIncidentInvolvedPersonMN.
#'
#' @param TempIncidentInvolvedPersonMNID The id of the TempIncidentInvolvedPersonMN to be modified.\cr Run \code{\link{getAllTempIncidentInvolvedPersonMNs}} for a list of TempIncidentInvolvedPersonMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentInvolvedPersonMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentInvolvedPersonMN <- function(TempIncidentInvolvedPersonMNID, EntityID = 1, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInjuryOccured = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setIsPhysicalAssault = NULL, setIsPhysicalAssaultState = NULL, setISSCount = NULL, setISSPartialCount = NULL, setNameID = NULL, setOffenderArrestedByLawEnforcement = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setReportedToLawEnforcement = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStateOffenderActivityMNID = NULL, setStateVictimCostMNID = NULL, setStateVictimTypeMNID = NULL, setStudentID = NULL, setStudentNumber = NULL, setWasSeriousBodilyInjury = 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("Discipline", "TempIncidentInvolvedPersonMN", TempIncidentInvolvedPersonMNID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentInvolvedPersonMN.
#'
#' This function creates a new TempIncidentInvolvedPersonMN.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentInvolvedPersonMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentInvolvedPersonMN <- function(EntityID = 1, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInjuryOccured = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setIsPhysicalAssault = NULL, setIsPhysicalAssaultState = NULL, setISSCount = NULL, setISSPartialCount = NULL, setNameID = NULL, setOffenderArrestedByLawEnforcement = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setReportedToLawEnforcement = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStateOffenderActivityMNID = NULL, setStateVictimCostMNID = NULL, setStateVictimTypeMNID = NULL, setStudentID = NULL, setStudentNumber = NULL, setWasSeriousBodilyInjury = 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("Discipline", "TempIncidentInvolvedPersonMN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentInvolvedPersonMN
#'
#' This function deletes a TempIncidentInvolvedPersonMN.
#'
#' @param TempIncidentInvolvedPersonMNID The id of the TempIncidentInvolvedPersonMN.\cr Run \code{\link{getAllTempIncidentInvolvedPersonMNs}} for a list of TempIncidentInvolvedPersonMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentInvolvedPersonMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentInvolvedPersonMN <- function(TempIncidentInvolvedPersonMNID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentInvolvedPersonMN", TempIncidentInvolvedPersonMNID, EntityID)
}
#' Get all TempIncidentInvolvedPersonPAs.
#'
#' This function returns a dataframe of all TempIncidentInvolvedPersonPAs 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 Discipline
#' @return All TempIncidentInvolvedPersonPAs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentInvolvedPersonPAs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentInvolvedPersonID = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnIncidentVictimComment = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnIsResidentialPlacementByNonEdAgency = F, returnISSCount = F, returnISSPartialCount = F, returnLLEIncidentNumber = F, returnLocalLawEnforcementNotified = F, returnMedicalTreatmentRequired = F, returnModifiedTime = F, returnNameID = F, returnNameOfLocalLawEnforcementContacted = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStateAdjudicationPAID = F, returnStateArrestedPAID = F, returnStateInjurySeverityPAID = F, returnStateOffenderTypePAID = F, returnStateVictimTypePAID = F, returnStateWeaponDetectedMethodPAID = F, returnStudentAssistanceProgramReferral = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWeaponDetectionComment = 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("Discipline", "TempIncidentInvolvedPersonPA", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentInvolvedPersonPA
#'
#' This function returns fields for a TempIncidentInvolvedPersonPA.
#'
#' @param TempIncidentInvolvedPersonPAID The id of the TempIncidentInvolvedPersonPA.\cr Run \code{\link{getAllTempIncidentInvolvedPersonPAs}} for a list of TempIncidentInvolvedPersonPAs.
#' @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 Discipline
#' @return Details for the TempIncidentInvolvedPersonPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentInvolvedPersonPA <- function(TempIncidentInvolvedPersonPAID, EntityID = 1, returnTempIncidentInvolvedPersonID = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnIncidentVictimComment = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnIsResidentialPlacementByNonEdAgency = F, returnISSCount = F, returnISSPartialCount = F, returnLLEIncidentNumber = F, returnLocalLawEnforcementNotified = F, returnMedicalTreatmentRequired = F, returnModifiedTime = F, returnNameID = F, returnNameOfLocalLawEnforcementContacted = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStateAdjudicationPAID = F, returnStateArrestedPAID = F, returnStateInjurySeverityPAID = F, returnStateOffenderTypePAID = F, returnStateVictimTypePAID = F, returnStateWeaponDetectedMethodPAID = F, returnStudentAssistanceProgramReferral = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWeaponDetectionComment = 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("Discipline", "TempIncidentInvolvedPersonPA", TempIncidentInvolvedPersonPAID, searchFields, EntityID)
}
#' Modify a specific TempIncidentInvolvedPersonPA
#'
#' This function modifies fields for a TempIncidentInvolvedPersonPA.
#'
#' @param TempIncidentInvolvedPersonPAID The id of the TempIncidentInvolvedPersonPA to be modified.\cr Run \code{\link{getAllTempIncidentInvolvedPersonPAs}} for a list of TempIncidentInvolvedPersonPAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentInvolvedPersonPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentInvolvedPersonPA <- function(TempIncidentInvolvedPersonPAID, EntityID = 1, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setIncidentVictimComment = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setIsResidentialPlacementByNonEdAgency = NULL, setISSCount = NULL, setISSPartialCount = NULL, setLLEIncidentNumber = NULL, setLocalLawEnforcementNotified = NULL, setMedicalTreatmentRequired = NULL, setNameID = NULL, setNameOfLocalLawEnforcementContacted = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStateAdjudicationPAID = NULL, setStateArrestedPAID = NULL, setStateInjurySeverityPAID = NULL, setStateOffenderTypePAID = NULL, setStateVictimTypePAID = NULL, setStateWeaponDetectedMethodPAID = NULL, setStudentAssistanceProgramReferral = NULL, setStudentID = NULL, setStudentNumber = NULL, setWeaponDetectionComment = 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("Discipline", "TempIncidentInvolvedPersonPA", TempIncidentInvolvedPersonPAID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentInvolvedPersonPA.
#'
#' This function creates a new TempIncidentInvolvedPersonPA.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentInvolvedPersonPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentInvolvedPersonPA <- function(EntityID = 1, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setIncidentVictimComment = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setIsResidentialPlacementByNonEdAgency = NULL, setISSCount = NULL, setISSPartialCount = NULL, setLLEIncidentNumber = NULL, setLocalLawEnforcementNotified = NULL, setMedicalTreatmentRequired = NULL, setNameID = NULL, setNameOfLocalLawEnforcementContacted = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStateAdjudicationPAID = NULL, setStateArrestedPAID = NULL, setStateInjurySeverityPAID = NULL, setStateOffenderTypePAID = NULL, setStateVictimTypePAID = NULL, setStateWeaponDetectedMethodPAID = NULL, setStudentAssistanceProgramReferral = NULL, setStudentID = NULL, setStudentNumber = NULL, setWeaponDetectionComment = 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("Discipline", "TempIncidentInvolvedPersonPA", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentInvolvedPersonPA
#'
#' This function deletes a TempIncidentInvolvedPersonPA.
#'
#' @param TempIncidentInvolvedPersonPAID The id of the TempIncidentInvolvedPersonPA.\cr Run \code{\link{getAllTempIncidentInvolvedPersonPAs}} for a list of TempIncidentInvolvedPersonPAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentInvolvedPersonPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentInvolvedPersonPA <- function(TempIncidentInvolvedPersonPAID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentInvolvedPersonPA", TempIncidentInvolvedPersonPAID, EntityID)
}
#' Get all TempIncidentInvolvedPersonTXs.
#'
#' This function returns a dataframe of all TempIncidentInvolvedPersonTXs 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 Discipline
#' @return All TempIncidentInvolvedPersonTXs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentInvolvedPersonTXs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentInvolvedPersonID = F, returnCampusIDOfDisciplinaryResponsibility = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnISSCount = F, returnISSPartialCount = F, returnModifiedTime = F, returnNameID = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Discipline", "TempIncidentInvolvedPersonTX", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentInvolvedPersonTX
#'
#' This function returns fields for a TempIncidentInvolvedPersonTX.
#'
#' @param TempIncidentInvolvedPersonTXID The id of the TempIncidentInvolvedPersonTX.\cr Run \code{\link{getAllTempIncidentInvolvedPersonTXs}} for a list of TempIncidentInvolvedPersonTXs.
#' @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 Discipline
#' @return Details for the TempIncidentInvolvedPersonTX.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentInvolvedPersonTX <- function(TempIncidentInvolvedPersonTXID, EntityID = 1, returnTempIncidentInvolvedPersonID = F, returnCampusIDOfDisciplinaryResponsibility = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnISSCount = F, returnISSPartialCount = F, returnModifiedTime = F, returnNameID = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Discipline", "TempIncidentInvolvedPersonTX", TempIncidentInvolvedPersonTXID, searchFields, EntityID)
}
#' Modify a specific TempIncidentInvolvedPersonTX
#'
#' This function modifies fields for a TempIncidentInvolvedPersonTX.
#'
#' @param TempIncidentInvolvedPersonTXID The id of the TempIncidentInvolvedPersonTX to be modified.\cr Run \code{\link{getAllTempIncidentInvolvedPersonTXs}} for a list of TempIncidentInvolvedPersonTXs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentInvolvedPersonTX.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentInvolvedPersonTX <- function(TempIncidentInvolvedPersonTXID, EntityID = 1, setCampusIDOfDisciplinaryResponsibility = NULL, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setISSCount = NULL, setISSPartialCount = NULL, setNameID = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Discipline", "TempIncidentInvolvedPersonTX", TempIncidentInvolvedPersonTXID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentInvolvedPersonTX.
#'
#' This function creates a new TempIncidentInvolvedPersonTX.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentInvolvedPersonTX.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentInvolvedPersonTX <- function(EntityID = 1, setCampusIDOfDisciplinaryResponsibility = NULL, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setISSCount = NULL, setISSPartialCount = NULL, setNameID = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Discipline", "TempIncidentInvolvedPersonTX", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentInvolvedPersonTX
#'
#' This function deletes a TempIncidentInvolvedPersonTX.
#'
#' @param TempIncidentInvolvedPersonTXID The id of the TempIncidentInvolvedPersonTX.\cr Run \code{\link{getAllTempIncidentInvolvedPersonTXs}} for a list of TempIncidentInvolvedPersonTXs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentInvolvedPersonTX.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentInvolvedPersonTX <- function(TempIncidentInvolvedPersonTXID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentInvolvedPersonTX", TempIncidentInvolvedPersonTXID, EntityID)
}
#' Get all TempIncidentInvolvedPersonWAs.
#'
#' This function returns a dataframe of all TempIncidentInvolvedPersonWAs 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 Discipline
#' @return All TempIncidentInvolvedPersonWAs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentInvolvedPersonWAs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentInvolvedPersonID = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnISSCount = F, returnISSPartialCount = F, returnModifiedTime = F, returnNameID = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStateReportedOffense = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("Discipline", "TempIncidentInvolvedPersonWA", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentInvolvedPersonWA
#'
#' This function returns fields for a TempIncidentInvolvedPersonWA.
#'
#' @param TempIncidentInvolvedPersonWAID The id of the TempIncidentInvolvedPersonWA.\cr Run \code{\link{getAllTempIncidentInvolvedPersonWAs}} for a list of TempIncidentInvolvedPersonWAs.
#' @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 Discipline
#' @return Details for the TempIncidentInvolvedPersonWA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentInvolvedPersonWA <- function(TempIncidentInvolvedPersonWAID, EntityID = 1, returnTempIncidentInvolvedPersonID = F, returnCreatedTime = F, returnExcludePrimaryOffense = F, returnExistingIncidentOffenseNamesToDelete = F, returnFreeformName = F, returnFullName = F, returnIncidentOffenseNameKey = F, returnIncidentOffenseNameType = F, returnIncidentOffenseNameTypeCode = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnISSCount = F, returnISSPartialCount = F, returnModifiedTime = F, returnNameID = F, returnOSSCount = F, returnOSSPartialCount = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnPrimaryOffenseID = F, returnSecondaryOffensesBackingData = F, returnSecondaryOffensesBackingDataDictionary = F, returnStaffID = F, returnStaffIDDisciplineOfficer = F, returnStateReportedOffense = F, returnStudentID = F, returnStudentNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("Discipline", "TempIncidentInvolvedPersonWA", TempIncidentInvolvedPersonWAID, searchFields, EntityID)
}
#' Modify a specific TempIncidentInvolvedPersonWA
#'
#' This function modifies fields for a TempIncidentInvolvedPersonWA.
#'
#' @param TempIncidentInvolvedPersonWAID The id of the TempIncidentInvolvedPersonWA to be modified.\cr Run \code{\link{getAllTempIncidentInvolvedPersonWAs}} for a list of TempIncidentInvolvedPersonWAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentInvolvedPersonWA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentInvolvedPersonWA <- function(TempIncidentInvolvedPersonWAID, EntityID = 1, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setISSCount = NULL, setISSPartialCount = NULL, setNameID = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStateReportedOffense = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("Discipline", "TempIncidentInvolvedPersonWA", TempIncidentInvolvedPersonWAID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentInvolvedPersonWA.
#'
#' This function creates a new TempIncidentInvolvedPersonWA.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentInvolvedPersonWA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentInvolvedPersonWA <- function(EntityID = 1, setExcludePrimaryOffense = NULL, setExistingIncidentOffenseNamesToDelete = NULL, setFreeformName = NULL, setFullName = NULL, setIncidentOffenseNameKey = NULL, setIncidentOffenseNameType = NULL, setIncidentOffenseNameTypeCode = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setISSCount = NULL, setISSPartialCount = NULL, setNameID = NULL, setOSSCount = NULL, setOSSPartialCount = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setPrimaryOffenseID = NULL, setSecondaryOffensesBackingData = NULL, setStaffID = NULL, setStaffIDDisciplineOfficer = NULL, setStateReportedOffense = NULL, setStudentID = NULL, setStudentNumber = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("Discipline", "TempIncidentInvolvedPersonWA", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentInvolvedPersonWA
#'
#' This function deletes a TempIncidentInvolvedPersonWA.
#'
#' @param TempIncidentInvolvedPersonWAID The id of the TempIncidentInvolvedPersonWA.\cr Run \code{\link{getAllTempIncidentInvolvedPersonWAs}} for a list of TempIncidentInvolvedPersonWAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentInvolvedPersonWA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentInvolvedPersonWA <- function(TempIncidentInvolvedPersonWAID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentInvolvedPersonWA", TempIncidentInvolvedPersonWAID, EntityID)
}
#' Get all TempIncidentOffenses.
#'
#' This function returns a dataframe of all TempIncidentOffenses 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 Discipline
#' @return All TempIncidentOffenses in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenses <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseID = F, returnCreatedTime = F, returnExistingIncidentID = F, returnIsPrimaryOffense = F, returnModifiedTime = F, returnOffenseID = 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("Discipline", "TempIncidentOffense", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffense
#'
#' This function returns fields for a TempIncidentOffense.
#'
#' @param TempIncidentOffenseID The id of the TempIncidentOffense.\cr Run \code{\link{getAllTempIncidentOffenses}} for a list of TempIncidentOffenses.
#' @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 Discipline
#' @return Details for the TempIncidentOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffense <- function(TempIncidentOffenseID, EntityID = 1, returnTempIncidentOffenseID = F, returnCreatedTime = F, returnExistingIncidentID = F, returnIsPrimaryOffense = F, returnModifiedTime = F, returnOffenseID = 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("Discipline", "TempIncidentOffense", TempIncidentOffenseID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffense
#'
#' This function modifies fields for a TempIncidentOffense.
#'
#' @param TempIncidentOffenseID The id of the TempIncidentOffense to be modified.\cr Run \code{\link{getAllTempIncidentOffenses}} for a list of TempIncidentOffenses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffense <- function(TempIncidentOffenseID, EntityID = 1, setExistingIncidentID = NULL, setIsPrimaryOffense = NULL, setOffenseID = 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("Discipline", "TempIncidentOffense", TempIncidentOffenseID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffense.
#'
#' This function creates a new TempIncidentOffense.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffense <- function(EntityID = 1, setExistingIncidentID = NULL, setIsPrimaryOffense = NULL, setOffenseID = 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("Discipline", "TempIncidentOffense", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffense
#'
#' This function deletes a TempIncidentOffense.
#'
#' @param TempIncidentOffenseID The id of the TempIncidentOffense.\cr Run \code{\link{getAllTempIncidentOffenses}} for a list of TempIncidentOffenses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffense.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffense <- function(TempIncidentOffenseID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffense", TempIncidentOffenseID, EntityID)
}
#' Get all TempIncidentOffenseNames.
#'
#' This function returns a dataframe of all TempIncidentOffenseNames 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 Discipline
#' @return All TempIncidentOffenseNames in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNames <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameID = F, returnCreatedTime = F, returnExistingIncidentOffenseNameID = F, returnFullName = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnIsPrimaryOffense = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOffenseID = F, returnOffenseLevelID = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnStudentNumber = F, returnTempIncidentInvolvedPersonID = F, returnTempIncidentOffenseID = 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("Discipline", "TempIncidentOffenseName", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseName
#'
#' This function returns fields for a TempIncidentOffenseName.
#'
#' @param TempIncidentOffenseNameID The id of the TempIncidentOffenseName.\cr Run \code{\link{getAllTempIncidentOffenseNames}} for a list of TempIncidentOffenseNames.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseName <- function(TempIncidentOffenseNameID, EntityID = 1, returnTempIncidentOffenseNameID = F, returnCreatedTime = F, returnExistingIncidentOffenseNameID = F, returnFullName = F, returnInvolvementType = F, returnInvolvementTypeCode = F, returnIsPrimaryOffense = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOffenseID = F, returnOffenseLevelID = F, returnPerceivedMotivationCodeDescription = F, returnPerceivedMotivationID = F, returnStudentNumber = F, returnTempIncidentInvolvedPersonID = F, returnTempIncidentOffenseID = 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("Discipline", "TempIncidentOffenseName", TempIncidentOffenseNameID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseName
#'
#' This function modifies fields for a TempIncidentOffenseName.
#'
#' @param TempIncidentOffenseNameID The id of the TempIncidentOffenseName to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNames}} for a list of TempIncidentOffenseNames.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseName <- function(TempIncidentOffenseNameID, EntityID = 1, setExistingIncidentOffenseNameID = NULL, setFullName = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setIsPrimaryOffense = NULL, setOffenseCodeDescription = NULL, setOffenseID = NULL, setOffenseLevelID = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setStudentNumber = NULL, setTempIncidentInvolvedPersonID = NULL, setTempIncidentOffenseID = 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("Discipline", "TempIncidentOffenseName", TempIncidentOffenseNameID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseName.
#'
#' This function creates a new TempIncidentOffenseName.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseName <- function(EntityID = 1, setExistingIncidentOffenseNameID = NULL, setFullName = NULL, setInvolvementType = NULL, setInvolvementTypeCode = NULL, setIsPrimaryOffense = NULL, setOffenseCodeDescription = NULL, setOffenseID = NULL, setOffenseLevelID = NULL, setPerceivedMotivationCodeDescription = NULL, setPerceivedMotivationID = NULL, setStudentNumber = NULL, setTempIncidentInvolvedPersonID = NULL, setTempIncidentOffenseID = 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("Discipline", "TempIncidentOffenseName", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseName
#'
#' This function deletes a TempIncidentOffenseName.
#'
#' @param TempIncidentOffenseNameID The id of the TempIncidentOffenseName.\cr Run \code{\link{getAllTempIncidentOffenseNames}} for a list of TempIncidentOffenseNames.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseName <- function(TempIncidentOffenseNameID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseName", TempIncidentOffenseNameID, EntityID)
}
#' Get all TempIncidentOffenseNameActions.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameActions 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 Discipline
#' @return All TempIncidentOffenseNameActions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameActions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnFullName = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameAction", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameAction
#'
#' This function returns fields for a TempIncidentOffenseNameAction.
#'
#' @param TempIncidentOffenseNameActionID The id of the TempIncidentOffenseNameAction.\cr Run \code{\link{getAllTempIncidentOffenseNameActions}} for a list of TempIncidentOffenseNameActions.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameAction <- function(TempIncidentOffenseNameActionID, EntityID = 1, returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnFullName = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameAction", TempIncidentOffenseNameActionID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameAction
#'
#' This function modifies fields for a TempIncidentOffenseNameAction.
#'
#' @param TempIncidentOffenseNameActionID The id of the TempIncidentOffenseNameAction to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameActions}} for a list of TempIncidentOffenseNameActions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameAction <- function(TempIncidentOffenseNameActionID, EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setBuildingID = NULL, setComment = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setFullName = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameAction", TempIncidentOffenseNameActionID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameAction.
#'
#' This function creates a new TempIncidentOffenseNameAction.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameAction <- function(EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setBuildingID = NULL, setComment = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setFullName = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameAction", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameAction
#'
#' This function deletes a TempIncidentOffenseNameAction.
#'
#' @param TempIncidentOffenseNameActionID The id of the TempIncidentOffenseNameAction.\cr Run \code{\link{getAllTempIncidentOffenseNameActions}} for a list of TempIncidentOffenseNameActions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameAction.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameAction <- function(TempIncidentOffenseNameActionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameAction", TempIncidentOffenseNameActionID, EntityID)
}
#' Get all TempIncidentOffenseNameActionDetails.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameActionDetails 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 Discipline
#' @return All TempIncidentOffenseNameActionDetails in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameActionDetails <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameActionDetailID = F, returnActionCodeDescription = F, returnCreateAttendance = F, returnCreatedTime = F, returnDurationServed = F, returnDurationToServe = F, returnDurationType = F, returnFullName = F, returnIncidentOffenseNameActionDetailID = F, returnInvolvementType = F, returnIsAlternate = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnNewStatus = F, returnNewStatusCode = F, returnOffenseCodeDescription = F, returnOldStatus = F, returnOldStatusCode = F, returnPartialDayPeriods = F, returnScheduledTime = F, returnScheduledTimeDate = F, returnScheduledTimeTime = F, returnStaffIDFollowUpOfficer = F, returnStatus = F, returnStatusCode = F, returnTempIncidentOffenseNameActionID = 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("Discipline", "TempIncidentOffenseNameActionDetail", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameActionDetail
#'
#' This function returns fields for a TempIncidentOffenseNameActionDetail.
#'
#' @param TempIncidentOffenseNameActionDetailID The id of the TempIncidentOffenseNameActionDetail.\cr Run \code{\link{getAllTempIncidentOffenseNameActionDetails}} for a list of TempIncidentOffenseNameActionDetails.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameActionDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameActionDetail <- function(TempIncidentOffenseNameActionDetailID, EntityID = 1, returnTempIncidentOffenseNameActionDetailID = F, returnActionCodeDescription = F, returnCreateAttendance = F, returnCreatedTime = F, returnDurationServed = F, returnDurationToServe = F, returnDurationType = F, returnFullName = F, returnIncidentOffenseNameActionDetailID = F, returnInvolvementType = F, returnIsAlternate = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnNewStatus = F, returnNewStatusCode = F, returnOffenseCodeDescription = F, returnOldStatus = F, returnOldStatusCode = F, returnPartialDayPeriods = F, returnScheduledTime = F, returnScheduledTimeDate = F, returnScheduledTimeTime = F, returnStaffIDFollowUpOfficer = F, returnStatus = F, returnStatusCode = F, returnTempIncidentOffenseNameActionID = 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("Discipline", "TempIncidentOffenseNameActionDetail", TempIncidentOffenseNameActionDetailID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameActionDetail
#'
#' This function modifies fields for a TempIncidentOffenseNameActionDetail.
#'
#' @param TempIncidentOffenseNameActionDetailID The id of the TempIncidentOffenseNameActionDetail to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameActionDetails}} for a list of TempIncidentOffenseNameActionDetails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameActionDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameActionDetail <- function(TempIncidentOffenseNameActionDetailID, EntityID = 1, setActionCodeDescription = NULL, setCreateAttendance = NULL, setDurationServed = NULL, setDurationToServe = NULL, setDurationType = NULL, setFullName = NULL, setIncidentOffenseNameActionDetailID = NULL, setInvolvementType = NULL, setIsAlternate = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setNewStatus = NULL, setNewStatusCode = NULL, setOffenseCodeDescription = NULL, setOldStatus = NULL, setOldStatusCode = NULL, setPartialDayPeriods = NULL, setScheduledTime = NULL, setScheduledTimeDate = NULL, setScheduledTimeTime = NULL, setStaffIDFollowUpOfficer = NULL, setStatus = NULL, setStatusCode = NULL, setTempIncidentOffenseNameActionID = 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("Discipline", "TempIncidentOffenseNameActionDetail", TempIncidentOffenseNameActionDetailID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameActionDetail.
#'
#' This function creates a new TempIncidentOffenseNameActionDetail.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameActionDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameActionDetail <- function(EntityID = 1, setActionCodeDescription = NULL, setCreateAttendance = NULL, setDurationServed = NULL, setDurationToServe = NULL, setDurationType = NULL, setFullName = NULL, setIncidentOffenseNameActionDetailID = NULL, setInvolvementType = NULL, setIsAlternate = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setNewStatus = NULL, setNewStatusCode = NULL, setOffenseCodeDescription = NULL, setOldStatus = NULL, setOldStatusCode = NULL, setPartialDayPeriods = NULL, setScheduledTime = NULL, setScheduledTimeDate = NULL, setScheduledTimeTime = NULL, setStaffIDFollowUpOfficer = NULL, setStatus = NULL, setStatusCode = NULL, setTempIncidentOffenseNameActionID = 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("Discipline", "TempIncidentOffenseNameActionDetail", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameActionDetail
#'
#' This function deletes a TempIncidentOffenseNameActionDetail.
#'
#' @param TempIncidentOffenseNameActionDetailID The id of the TempIncidentOffenseNameActionDetail.\cr Run \code{\link{getAllTempIncidentOffenseNameActionDetails}} for a list of TempIncidentOffenseNameActionDetails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameActionDetail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameActionDetail <- function(TempIncidentOffenseNameActionDetailID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameActionDetail", TempIncidentOffenseNameActionDetailID, EntityID)
}
#' Get all TempIncidentOffenseNameActionDetailRecords.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameActionDetailRecords 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 Discipline
#' @return All TempIncidentOffenseNameActionDetailRecords in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameActionDetailRecords <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameActionDetailRecordID = F, returnBuilding = F, returnBuildingID = F, returnCreatedTime = F, returnDurationServed = F, returnDurationToServe = F, returnDurationType = F, returnIncidentOffenseNameActionID = F, returnIsAlternate = F, returnIsGuardianNotified = F, returnLocation = F, returnLocationID = F, returnModifiedTime = F, returnRoomID = F, returnRoomNumber = F, returnScheduledTime = F, returnStaffFollowUpOfficerName = F, returnStaffIDFollowUpOfficer = F, returnStatus = F, returnStatusCode = 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("Discipline", "TempIncidentOffenseNameActionDetailRecord", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameActionDetailRecord
#'
#' This function returns fields for a TempIncidentOffenseNameActionDetailRecord.
#'
#' @param TempIncidentOffenseNameActionDetailRecordID The id of the TempIncidentOffenseNameActionDetailRecord.\cr Run \code{\link{getAllTempIncidentOffenseNameActionDetailRecords}} for a list of TempIncidentOffenseNameActionDetailRecords.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameActionDetailRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameActionDetailRecord <- function(TempIncidentOffenseNameActionDetailRecordID, EntityID = 1, returnTempIncidentOffenseNameActionDetailRecordID = F, returnBuilding = F, returnBuildingID = F, returnCreatedTime = F, returnDurationServed = F, returnDurationToServe = F, returnDurationType = F, returnIncidentOffenseNameActionID = F, returnIsAlternate = F, returnIsGuardianNotified = F, returnLocation = F, returnLocationID = F, returnModifiedTime = F, returnRoomID = F, returnRoomNumber = F, returnScheduledTime = F, returnStaffFollowUpOfficerName = F, returnStaffIDFollowUpOfficer = F, returnStatus = F, returnStatusCode = 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("Discipline", "TempIncidentOffenseNameActionDetailRecord", TempIncidentOffenseNameActionDetailRecordID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameActionDetailRecord
#'
#' This function modifies fields for a TempIncidentOffenseNameActionDetailRecord.
#'
#' @param TempIncidentOffenseNameActionDetailRecordID The id of the TempIncidentOffenseNameActionDetailRecord to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameActionDetailRecords}} for a list of TempIncidentOffenseNameActionDetailRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameActionDetailRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameActionDetailRecord <- function(TempIncidentOffenseNameActionDetailRecordID, EntityID = 1, setBuilding = NULL, setBuildingID = NULL, setDurationServed = NULL, setDurationToServe = NULL, setDurationType = NULL, setIncidentOffenseNameActionID = NULL, setIsAlternate = NULL, setIsGuardianNotified = NULL, setLocation = NULL, setLocationID = NULL, setRoomID = NULL, setRoomNumber = NULL, setScheduledTime = NULL, setStaffFollowUpOfficerName = NULL, setStaffIDFollowUpOfficer = NULL, setStatus = NULL, setStatusCode = 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("Discipline", "TempIncidentOffenseNameActionDetailRecord", TempIncidentOffenseNameActionDetailRecordID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameActionDetailRecord.
#'
#' This function creates a new TempIncidentOffenseNameActionDetailRecord.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameActionDetailRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameActionDetailRecord <- function(EntityID = 1, setBuilding = NULL, setBuildingID = NULL, setDurationServed = NULL, setDurationToServe = NULL, setDurationType = NULL, setIncidentOffenseNameActionID = NULL, setIsAlternate = NULL, setIsGuardianNotified = NULL, setLocation = NULL, setLocationID = NULL, setRoomID = NULL, setRoomNumber = NULL, setScheduledTime = NULL, setStaffFollowUpOfficerName = NULL, setStaffIDFollowUpOfficer = NULL, setStatus = NULL, setStatusCode = 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("Discipline", "TempIncidentOffenseNameActionDetailRecord", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameActionDetailRecord
#'
#' This function deletes a TempIncidentOffenseNameActionDetailRecord.
#'
#' @param TempIncidentOffenseNameActionDetailRecordID The id of the TempIncidentOffenseNameActionDetailRecord.\cr Run \code{\link{getAllTempIncidentOffenseNameActionDetailRecords}} for a list of TempIncidentOffenseNameActionDetailRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameActionDetailRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameActionDetailRecord <- function(TempIncidentOffenseNameActionDetailRecordID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameActionDetailRecord", TempIncidentOffenseNameActionDetailRecordID, EntityID)
}
#' Get all TempIncidentOffenseNameActionINs.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameActionINs 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 Discipline
#' @return All TempIncidentOffenseNameActionINs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameActionINs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnFullName = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryAction = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStateEducationalServiceProvidedINID = F, returnStateSuspensionReasonINID = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionIN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameActionIN
#'
#' This function returns fields for a TempIncidentOffenseNameActionIN.
#'
#' @param TempIncidentOffenseNameActionINID The id of the TempIncidentOffenseNameActionIN.\cr Run \code{\link{getAllTempIncidentOffenseNameActionINs}} for a list of TempIncidentOffenseNameActionINs.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameActionIN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameActionIN <- function(TempIncidentOffenseNameActionINID, EntityID = 1, returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnFullName = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryAction = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStateEducationalServiceProvidedINID = F, returnStateSuspensionReasonINID = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionIN", TempIncidentOffenseNameActionINID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameActionIN
#'
#' This function modifies fields for a TempIncidentOffenseNameActionIN.
#'
#' @param TempIncidentOffenseNameActionINID The id of the TempIncidentOffenseNameActionIN to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameActionINs}} for a list of TempIncidentOffenseNameActionINs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameActionIN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameActionIN <- function(TempIncidentOffenseNameActionINID, EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setBuildingID = NULL, setComment = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setFullName = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryAction = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStateEducationalServiceProvidedINID = NULL, setStateSuspensionReasonINID = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionIN", TempIncidentOffenseNameActionINID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameActionIN.
#'
#' This function creates a new TempIncidentOffenseNameActionIN.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameActionIN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameActionIN <- function(EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setBuildingID = NULL, setComment = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setFullName = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryAction = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStateEducationalServiceProvidedINID = NULL, setStateSuspensionReasonINID = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionIN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameActionIN
#'
#' This function deletes a TempIncidentOffenseNameActionIN.
#'
#' @param TempIncidentOffenseNameActionINID The id of the TempIncidentOffenseNameActionIN.\cr Run \code{\link{getAllTempIncidentOffenseNameActionINs}} for a list of TempIncidentOffenseNameActionINs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameActionIN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameActionIN <- function(TempIncidentOffenseNameActionINID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameActionIN", TempIncidentOffenseNameActionINID, EntityID)
}
#' Get all TempIncidentOffenseNameActionMNs.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameActionMNs 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 Discipline
#' @return All TempIncidentOffenseNameActionMNs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameActionMNs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDateExpulsionExclusionEnds = F, returnDIRSActionExplanation = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnExclusionThroughYearEnd = F, returnExpulsionModified = F, returnExpulsionThroughYearEnd = F, returnFullName = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnReturnBeforeYearEnd = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStateDIRSAESTypeMNID = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionMN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameActionMN
#'
#' This function returns fields for a TempIncidentOffenseNameActionMN.
#'
#' @param TempIncidentOffenseNameActionMNID The id of the TempIncidentOffenseNameActionMN.\cr Run \code{\link{getAllTempIncidentOffenseNameActionMNs}} for a list of TempIncidentOffenseNameActionMNs.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameActionMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameActionMN <- function(TempIncidentOffenseNameActionMNID, EntityID = 1, returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDateExpulsionExclusionEnds = F, returnDIRSActionExplanation = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnExclusionThroughYearEnd = F, returnExpulsionModified = F, returnExpulsionThroughYearEnd = F, returnFullName = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnReturnBeforeYearEnd = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStateDIRSAESTypeMNID = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionMN", TempIncidentOffenseNameActionMNID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameActionMN
#'
#' This function modifies fields for a TempIncidentOffenseNameActionMN.
#'
#' @param TempIncidentOffenseNameActionMNID The id of the TempIncidentOffenseNameActionMN to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameActionMNs}} for a list of TempIncidentOffenseNameActionMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameActionMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameActionMN <- function(TempIncidentOffenseNameActionMNID, EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setBuildingID = NULL, setComment = NULL, setDateExpulsionExclusionEnds = NULL, setDIRSActionExplanation = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setExclusionThroughYearEnd = NULL, setExpulsionModified = NULL, setExpulsionThroughYearEnd = NULL, setFullName = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setReturnBeforeYearEnd = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStateDIRSAESTypeMNID = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionMN", TempIncidentOffenseNameActionMNID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameActionMN.
#'
#' This function creates a new TempIncidentOffenseNameActionMN.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameActionMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameActionMN <- function(EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setBuildingID = NULL, setComment = NULL, setDateExpulsionExclusionEnds = NULL, setDIRSActionExplanation = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setExclusionThroughYearEnd = NULL, setExpulsionModified = NULL, setExpulsionThroughYearEnd = NULL, setFullName = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setReturnBeforeYearEnd = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStateDIRSAESTypeMNID = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionMN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameActionMN
#'
#' This function deletes a TempIncidentOffenseNameActionMN.
#'
#' @param TempIncidentOffenseNameActionMNID The id of the TempIncidentOffenseNameActionMN.\cr Run \code{\link{getAllTempIncidentOffenseNameActionMNs}} for a list of TempIncidentOffenseNameActionMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameActionMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameActionMN <- function(TempIncidentOffenseNameActionMNID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameActionMN", TempIncidentOffenseNameActionMNID, EntityID)
}
#' Get all TempIncidentOffenseNameActionPAs.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameActionPAs 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 Discipline
#' @return All TempIncidentOffenseNameActionPAs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameActionPAs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnAssignedAlternativeEducation = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnFullName = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnReceivedEducationalServices = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionPA", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameActionPA
#'
#' This function returns fields for a TempIncidentOffenseNameActionPA.
#'
#' @param TempIncidentOffenseNameActionPAID The id of the TempIncidentOffenseNameActionPA.\cr Run \code{\link{getAllTempIncidentOffenseNameActionPAs}} for a list of TempIncidentOffenseNameActionPAs.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameActionPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameActionPA <- function(TempIncidentOffenseNameActionPAID, EntityID = 1, returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnAssignedAlternativeEducation = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnFullName = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnReceivedEducationalServices = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionPA", TempIncidentOffenseNameActionPAID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameActionPA
#'
#' This function modifies fields for a TempIncidentOffenseNameActionPA.
#'
#' @param TempIncidentOffenseNameActionPAID The id of the TempIncidentOffenseNameActionPA to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameActionPAs}} for a list of TempIncidentOffenseNameActionPAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameActionPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameActionPA <- function(TempIncidentOffenseNameActionPAID, EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setAssignedAlternativeEducation = NULL, setBuildingID = NULL, setComment = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setFullName = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setReceivedEducationalServices = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionPA", TempIncidentOffenseNameActionPAID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameActionPA.
#'
#' This function creates a new TempIncidentOffenseNameActionPA.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameActionPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameActionPA <- function(EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setAssignedAlternativeEducation = NULL, setBuildingID = NULL, setComment = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setFullName = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setReceivedEducationalServices = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionPA", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameActionPA
#'
#' This function deletes a TempIncidentOffenseNameActionPA.
#'
#' @param TempIncidentOffenseNameActionPAID The id of the TempIncidentOffenseNameActionPA.\cr Run \code{\link{getAllTempIncidentOffenseNameActionPAs}} for a list of TempIncidentOffenseNameActionPAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameActionPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameActionPA <- function(TempIncidentOffenseNameActionPAID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameActionPA", TempIncidentOffenseNameActionPAID, EntityID)
}
#' Get all TempIncidentOffenseNameActionWAs.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameActionWAs 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 Discipline
#' @return All TempIncidentOffenseNameActionWAs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameActionWAs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDateReadmissionPetitionGranted = F, returnDateReadmissionPetitionSubmitted = F, returnDateReengagementMeetingHeld = F, returnDurationOfExclusionaryActionDays = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnFullName = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnPlacedInInterimAlternativeEducationalSetting = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStateAcademicServiceWAID = F, returnStateAppealCodeWAID = F, returnStateBehaviorServiceWAID = F, returnStatePetitionExtensionExpulsionWAID = F, returnStateReengagementPlanWAID = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = F, returnTotalAmountOfExclusionaryTime = 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("Discipline", "TempIncidentOffenseNameActionWA", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameActionWA
#'
#' This function returns fields for a TempIncidentOffenseNameActionWA.
#'
#' @param TempIncidentOffenseNameActionWAID The id of the TempIncidentOffenseNameActionWA.\cr Run \code{\link{getAllTempIncidentOffenseNameActionWAs}} for a list of TempIncidentOffenseNameActionWAs.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameActionWA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameActionWA <- function(TempIncidentOffenseNameActionWAID, EntityID = 1, returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnBuildingID = F, returnComment = F, returnCreatedTime = F, returnDateReadmissionPetitionGranted = F, returnDateReadmissionPetitionSubmitted = F, returnDateReengagementMeetingHeld = F, returnDurationOfExclusionaryActionDays = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnFullName = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnPlacedInInterimAlternativeEducationalSetting = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStateAcademicServiceWAID = F, returnStateAppealCodeWAID = F, returnStateBehaviorServiceWAID = F, returnStatePetitionExtensionExpulsionWAID = F, returnStateReengagementPlanWAID = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = F, returnTotalAmountOfExclusionaryTime = 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("Discipline", "TempIncidentOffenseNameActionWA", TempIncidentOffenseNameActionWAID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameActionWA
#'
#' This function modifies fields for a TempIncidentOffenseNameActionWA.
#'
#' @param TempIncidentOffenseNameActionWAID The id of the TempIncidentOffenseNameActionWA to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameActionWAs}} for a list of TempIncidentOffenseNameActionWAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameActionWA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameActionWA <- function(TempIncidentOffenseNameActionWAID, EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setBuildingID = NULL, setComment = NULL, setDateReadmissionPetitionGranted = NULL, setDateReadmissionPetitionSubmitted = NULL, setDateReengagementMeetingHeld = NULL, setDurationOfExclusionaryActionDays = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setFullName = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setPlacedInInterimAlternativeEducationalSetting = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStateAcademicServiceWAID = NULL, setStateAppealCodeWAID = NULL, setStateBehaviorServiceWAID = NULL, setStatePetitionExtensionExpulsionWAID = NULL, setStateReengagementPlanWAID = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = NULL, setTotalAmountOfExclusionaryTime = 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("Discipline", "TempIncidentOffenseNameActionWA", TempIncidentOffenseNameActionWAID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameActionWA.
#'
#' This function creates a new TempIncidentOffenseNameActionWA.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameActionWA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameActionWA <- function(EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setBuildingID = NULL, setComment = NULL, setDateReadmissionPetitionGranted = NULL, setDateReadmissionPetitionSubmitted = NULL, setDateReengagementMeetingHeld = NULL, setDurationOfExclusionaryActionDays = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setFullName = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setPlacedInInterimAlternativeEducationalSetting = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStateAcademicServiceWAID = NULL, setStateAppealCodeWAID = NULL, setStateBehaviorServiceWAID = NULL, setStatePetitionExtensionExpulsionWAID = NULL, setStateReengagementPlanWAID = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = NULL, setTotalAmountOfExclusionaryTime = 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("Discipline", "TempIncidentOffenseNameActionWA", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameActionWA
#'
#' This function deletes a TempIncidentOffenseNameActionWA.
#'
#' @param TempIncidentOffenseNameActionWAID The id of the TempIncidentOffenseNameActionWA.\cr Run \code{\link{getAllTempIncidentOffenseNameActionWAs}} for a list of TempIncidentOffenseNameActionWAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameActionWA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameActionWA <- function(TempIncidentOffenseNameActionWAID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameActionWA", TempIncidentOffenseNameActionWAID, EntityID)
}
#' Get all TempIncidentOffenseNameActionWIs.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameActionWIs 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 Discipline
#' @return All TempIncidentOffenseNameActionWIs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameActionWIs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnBehaviorDetailedDescription = F, returnBuildingID = F, returnCausedSeriousBodilyInjury = F, returnComment = F, returnCreatedTime = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnFullName = F, returnHasEarlyReinstatementCondition = F, returnIAESRemovalType = F, returnIAESRemovalTypeCode = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStateModifiedTermWIID = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionWI", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameActionWI
#'
#' This function returns fields for a TempIncidentOffenseNameActionWI.
#'
#' @param TempIncidentOffenseNameActionWIID The id of the TempIncidentOffenseNameActionWI.\cr Run \code{\link{getAllTempIncidentOffenseNameActionWIs}} for a list of TempIncidentOffenseNameActionWIs.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameActionWI.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameActionWI <- function(TempIncidentOffenseNameActionWIID, EntityID = 1, returnTempIncidentOffenseNameActionID = F, returnActionCodeDescription = F, returnActionID = F, returnActionTypeCode = F, returnActionTypeID = F, returnBehaviorDetailedDescription = F, returnBuildingID = F, returnCausedSeriousBodilyInjury = F, returnComment = F, returnCreatedTime = F, returnDurationToServe = F, returnDurationType = F, returnDurationTypeCode = F, returnEntityID = F, returnFullName = F, returnHasEarlyReinstatementCondition = F, returnIAESRemovalType = F, returnIAESRemovalTypeCode = F, returnInvolvementType = F, returnIsGuardianNotified = F, returnIsPrimaryOffense = F, returnLocationID = F, returnModifiedTime = F, returnOffenseCodeDescription = F, returnOrderedDate = F, returnPerceivedMotivationCodeDescription = F, returnRoomID = F, returnStaffIDAuthorizedBy = F, returnStaffIDAuthorizedByName = F, returnStaffIDFollowUpOfficer = F, returnStartTime = F, returnStateModifiedTermWIID = F, returnStatus = F, returnStatusCode = F, returnStudentNumber = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionWI", TempIncidentOffenseNameActionWIID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameActionWI
#'
#' This function modifies fields for a TempIncidentOffenseNameActionWI.
#'
#' @param TempIncidentOffenseNameActionWIID The id of the TempIncidentOffenseNameActionWI to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameActionWIs}} for a list of TempIncidentOffenseNameActionWIs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameActionWI.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameActionWI <- function(TempIncidentOffenseNameActionWIID, EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setBehaviorDetailedDescription = NULL, setBuildingID = NULL, setCausedSeriousBodilyInjury = NULL, setComment = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setFullName = NULL, setHasEarlyReinstatementCondition = NULL, setIAESRemovalType = NULL, setIAESRemovalTypeCode = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStateModifiedTermWIID = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionWI", TempIncidentOffenseNameActionWIID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameActionWI.
#'
#' This function creates a new TempIncidentOffenseNameActionWI.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameActionWI.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameActionWI <- function(EntityID = 1, setActionCodeDescription = NULL, setActionID = NULL, setActionTypeCode = NULL, setActionTypeID = NULL, setBehaviorDetailedDescription = NULL, setBuildingID = NULL, setCausedSeriousBodilyInjury = NULL, setComment = NULL, setDurationToServe = NULL, setDurationType = NULL, setDurationTypeCode = NULL, setEntityID = NULL, setFullName = NULL, setHasEarlyReinstatementCondition = NULL, setIAESRemovalType = NULL, setIAESRemovalTypeCode = NULL, setInvolvementType = NULL, setIsGuardianNotified = NULL, setIsPrimaryOffense = NULL, setLocationID = NULL, setOffenseCodeDescription = NULL, setOrderedDate = NULL, setPerceivedMotivationCodeDescription = NULL, setRoomID = NULL, setStaffIDAuthorizedBy = NULL, setStaffIDAuthorizedByName = NULL, setStaffIDFollowUpOfficer = NULL, setStartTime = NULL, setStateModifiedTermWIID = NULL, setStatus = NULL, setStatusCode = NULL, setStudentNumber = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameActionWI", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameActionWI
#'
#' This function deletes a TempIncidentOffenseNameActionWI.
#'
#' @param TempIncidentOffenseNameActionWIID The id of the TempIncidentOffenseNameActionWI.\cr Run \code{\link{getAllTempIncidentOffenseNameActionWIs}} for a list of TempIncidentOffenseNameActionWIs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameActionWI.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameActionWI <- function(TempIncidentOffenseNameActionWIID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameActionWI", TempIncidentOffenseNameActionWIID, EntityID)
}
#' Get all TempIncidentOffenseNameDrugs.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameDrugs 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 Discipline
#' @return All TempIncidentOffenseNameDrugs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameDrugs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameDrugID = F, returnCreatedTime = F, returnDrugID = F, returnIncidentOffenseNameDrugID = F, returnModifiedTime = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameDrug", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameDrug
#'
#' This function returns fields for a TempIncidentOffenseNameDrug.
#'
#' @param TempIncidentOffenseNameDrugID The id of the TempIncidentOffenseNameDrug.\cr Run \code{\link{getAllTempIncidentOffenseNameDrugs}} for a list of TempIncidentOffenseNameDrugs.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameDrug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameDrug <- function(TempIncidentOffenseNameDrugID, EntityID = 1, returnTempIncidentOffenseNameDrugID = F, returnCreatedTime = F, returnDrugID = F, returnIncidentOffenseNameDrugID = F, returnModifiedTime = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameDrug", TempIncidentOffenseNameDrugID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameDrug
#'
#' This function modifies fields for a TempIncidentOffenseNameDrug.
#'
#' @param TempIncidentOffenseNameDrugID The id of the TempIncidentOffenseNameDrug to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameDrugs}} for a list of TempIncidentOffenseNameDrugs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameDrug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameDrug <- function(TempIncidentOffenseNameDrugID, EntityID = 1, setDrugID = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameDrug", TempIncidentOffenseNameDrugID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameDrug.
#'
#' This function creates a new TempIncidentOffenseNameDrug.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameDrug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameDrug <- function(EntityID = 1, setDrugID = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameDrug", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameDrug
#'
#' This function deletes a TempIncidentOffenseNameDrug.
#'
#' @param TempIncidentOffenseNameDrugID The id of the TempIncidentOffenseNameDrug.\cr Run \code{\link{getAllTempIncidentOffenseNameDrugs}} for a list of TempIncidentOffenseNameDrugs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameDrug.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameDrug <- function(TempIncidentOffenseNameDrugID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameDrug", TempIncidentOffenseNameDrugID, EntityID)
}
#' Get all TempIncidentOffenseNameParentalInvolvementPAs.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameParentalInvolvementPAs 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 Discipline
#' @return All TempIncidentOffenseNameParentalInvolvementPAs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameParentalInvolvementPAs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameParentalInvolvementPAID = F, returnComment = F, returnCreatedTime = F, returnIncidentOffenseNameParentalInvolvementPAID = F, returnModifiedTime = F, returnStateParentalInvolvementPAID = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameParentalInvolvementPA", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameParentalInvolvementPA
#'
#' This function returns fields for a TempIncidentOffenseNameParentalInvolvementPA.
#'
#' @param TempIncidentOffenseNameParentalInvolvementPAID The id of the TempIncidentOffenseNameParentalInvolvementPA.\cr Run \code{\link{getAllTempIncidentOffenseNameParentalInvolvementPAs}} for a list of TempIncidentOffenseNameParentalInvolvementPAs.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameParentalInvolvementPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameParentalInvolvementPA <- function(TempIncidentOffenseNameParentalInvolvementPAID, EntityID = 1, returnTempIncidentOffenseNameParentalInvolvementPAID = F, returnComment = F, returnCreatedTime = F, returnIncidentOffenseNameParentalInvolvementPAID = F, returnModifiedTime = F, returnStateParentalInvolvementPAID = F, returnTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameParentalInvolvementPA", TempIncidentOffenseNameParentalInvolvementPAID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameParentalInvolvementPA
#'
#' This function modifies fields for a TempIncidentOffenseNameParentalInvolvementPA.
#'
#' @param TempIncidentOffenseNameParentalInvolvementPAID The id of the TempIncidentOffenseNameParentalInvolvementPA to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameParentalInvolvementPAs}} for a list of TempIncidentOffenseNameParentalInvolvementPAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameParentalInvolvementPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameParentalInvolvementPA <- function(TempIncidentOffenseNameParentalInvolvementPAID, EntityID = 1, setComment = NULL, setStateParentalInvolvementPAID = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameParentalInvolvementPA", TempIncidentOffenseNameParentalInvolvementPAID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameParentalInvolvementPA.
#'
#' This function creates a new TempIncidentOffenseNameParentalInvolvementPA.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameParentalInvolvementPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameParentalInvolvementPA <- function(EntityID = 1, setComment = NULL, setStateParentalInvolvementPAID = NULL, setTempIncidentOffenseNameID = 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("Discipline", "TempIncidentOffenseNameParentalInvolvementPA", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameParentalInvolvementPA
#'
#' This function deletes a TempIncidentOffenseNameParentalInvolvementPA.
#'
#' @param TempIncidentOffenseNameParentalInvolvementPAID The id of the TempIncidentOffenseNameParentalInvolvementPA.\cr Run \code{\link{getAllTempIncidentOffenseNameParentalInvolvementPAs}} for a list of TempIncidentOffenseNameParentalInvolvementPAs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameParentalInvolvementPA.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameParentalInvolvementPA <- function(TempIncidentOffenseNameParentalInvolvementPAID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameParentalInvolvementPA", TempIncidentOffenseNameParentalInvolvementPAID, EntityID)
}
#' Get all TempIncidentOffenseNameReportRunHistoryRecords.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameReportRunHistoryRecords 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 Discipline
#' @return All TempIncidentOffenseNameReportRunHistoryRecords in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameReportRunHistoryRecords <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameReportRunHistoryRecordID = F, returnColumnHeader1 = F, returnColumnHeader10 = F, returnColumnHeader2 = F, returnColumnHeader3 = F, returnColumnHeader4 = F, returnColumnHeader5 = F, returnColumnHeader6 = F, returnColumnHeader7 = F, returnColumnHeader8 = F, returnColumnHeader9 = F, returnCreatedTime = F, returnDateTime = F, returnIncident = F, returnIncidentNumber = F, returnIncidentOffenseNameID = F, returnModifiedTime = F, returnOffense = F, returnStudentID = F, returnStudentName = F, returnUnboundBody = F, returnUnboundFooter = F, returnUnboundHeader = 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("Discipline", "TempIncidentOffenseNameReportRunHistoryRecord", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameReportRunHistoryRecord
#'
#' This function returns fields for a TempIncidentOffenseNameReportRunHistoryRecord.
#'
#' @param TempIncidentOffenseNameReportRunHistoryRecordID The id of the TempIncidentOffenseNameReportRunHistoryRecord.\cr Run \code{\link{getAllTempIncidentOffenseNameReportRunHistoryRecords}} for a list of TempIncidentOffenseNameReportRunHistoryRecords.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameReportRunHistoryRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameReportRunHistoryRecord <- function(TempIncidentOffenseNameReportRunHistoryRecordID, EntityID = 1, returnTempIncidentOffenseNameReportRunHistoryRecordID = F, returnColumnHeader1 = F, returnColumnHeader10 = F, returnColumnHeader2 = F, returnColumnHeader3 = F, returnColumnHeader4 = F, returnColumnHeader5 = F, returnColumnHeader6 = F, returnColumnHeader7 = F, returnColumnHeader8 = F, returnColumnHeader9 = F, returnCreatedTime = F, returnDateTime = F, returnIncident = F, returnIncidentNumber = F, returnIncidentOffenseNameID = F, returnModifiedTime = F, returnOffense = F, returnStudentID = F, returnStudentName = F, returnUnboundBody = F, returnUnboundFooter = F, returnUnboundHeader = 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("Discipline", "TempIncidentOffenseNameReportRunHistoryRecord", TempIncidentOffenseNameReportRunHistoryRecordID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameReportRunHistoryRecord
#'
#' This function modifies fields for a TempIncidentOffenseNameReportRunHistoryRecord.
#'
#' @param TempIncidentOffenseNameReportRunHistoryRecordID The id of the TempIncidentOffenseNameReportRunHistoryRecord to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameReportRunHistoryRecords}} for a list of TempIncidentOffenseNameReportRunHistoryRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameReportRunHistoryRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameReportRunHistoryRecord <- function(TempIncidentOffenseNameReportRunHistoryRecordID, EntityID = 1, setColumnHeader1 = NULL, setColumnHeader10 = NULL, setColumnHeader2 = NULL, setColumnHeader3 = NULL, setColumnHeader4 = NULL, setColumnHeader5 = NULL, setColumnHeader6 = NULL, setColumnHeader7 = NULL, setColumnHeader8 = NULL, setColumnHeader9 = NULL, setDateTime = NULL, setIncident = NULL, setIncidentNumber = NULL, setIncidentOffenseNameID = NULL, setOffense = NULL, setStudentID = NULL, setStudentName = NULL, setUnboundBody = NULL, setUnboundFooter = NULL, setUnboundHeader = 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("Discipline", "TempIncidentOffenseNameReportRunHistoryRecord", TempIncidentOffenseNameReportRunHistoryRecordID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameReportRunHistoryRecord.
#'
#' This function creates a new TempIncidentOffenseNameReportRunHistoryRecord.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameReportRunHistoryRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameReportRunHistoryRecord <- function(EntityID = 1, setColumnHeader1 = NULL, setColumnHeader10 = NULL, setColumnHeader2 = NULL, setColumnHeader3 = NULL, setColumnHeader4 = NULL, setColumnHeader5 = NULL, setColumnHeader6 = NULL, setColumnHeader7 = NULL, setColumnHeader8 = NULL, setColumnHeader9 = NULL, setDateTime = NULL, setIncident = NULL, setIncidentNumber = NULL, setIncidentOffenseNameID = NULL, setOffense = NULL, setStudentID = NULL, setStudentName = NULL, setUnboundBody = NULL, setUnboundFooter = NULL, setUnboundHeader = 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("Discipline", "TempIncidentOffenseNameReportRunHistoryRecord", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameReportRunHistoryRecord
#'
#' This function deletes a TempIncidentOffenseNameReportRunHistoryRecord.
#'
#' @param TempIncidentOffenseNameReportRunHistoryRecordID The id of the TempIncidentOffenseNameReportRunHistoryRecord.\cr Run \code{\link{getAllTempIncidentOffenseNameReportRunHistoryRecords}} for a list of TempIncidentOffenseNameReportRunHistoryRecords.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameReportRunHistoryRecord.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameReportRunHistoryRecord <- function(TempIncidentOffenseNameReportRunHistoryRecordID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameReportRunHistoryRecord", TempIncidentOffenseNameReportRunHistoryRecordID, EntityID)
}
#' Get all TempIncidentOffenseNameWeapons.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameWeapons 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 Discipline
#' @return All TempIncidentOffenseNameWeapons in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameWeapons <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameWeaponID = F, returnCreatedTime = F, returnIncidentOffenseNameWeaponID = F, returnModifiedTime = F, returnTempIncidentOffenseNameID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWeaponCount = F, returnWeaponID = 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("Discipline", "TempIncidentOffenseNameWeapon", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameWeapon
#'
#' This function returns fields for a TempIncidentOffenseNameWeapon.
#'
#' @param TempIncidentOffenseNameWeaponID The id of the TempIncidentOffenseNameWeapon.\cr Run \code{\link{getAllTempIncidentOffenseNameWeapons}} for a list of TempIncidentOffenseNameWeapons.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameWeapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameWeapon <- function(TempIncidentOffenseNameWeaponID, EntityID = 1, returnTempIncidentOffenseNameWeaponID = F, returnCreatedTime = F, returnIncidentOffenseNameWeaponID = F, returnModifiedTime = F, returnTempIncidentOffenseNameID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWeaponCount = F, returnWeaponID = 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("Discipline", "TempIncidentOffenseNameWeapon", TempIncidentOffenseNameWeaponID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameWeapon
#'
#' This function modifies fields for a TempIncidentOffenseNameWeapon.
#'
#' @param TempIncidentOffenseNameWeaponID The id of the TempIncidentOffenseNameWeapon to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameWeapons}} for a list of TempIncidentOffenseNameWeapons.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameWeapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameWeapon <- function(TempIncidentOffenseNameWeaponID, EntityID = 1, setTempIncidentOffenseNameID = NULL, setWeaponCount = NULL, setWeaponID = 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("Discipline", "TempIncidentOffenseNameWeapon", TempIncidentOffenseNameWeaponID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameWeapon.
#'
#' This function creates a new TempIncidentOffenseNameWeapon.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameWeapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameWeapon <- function(EntityID = 1, setTempIncidentOffenseNameID = NULL, setWeaponCount = NULL, setWeaponID = 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("Discipline", "TempIncidentOffenseNameWeapon", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameWeapon
#'
#' This function deletes a TempIncidentOffenseNameWeapon.
#'
#' @param TempIncidentOffenseNameWeaponID The id of the TempIncidentOffenseNameWeapon.\cr Run \code{\link{getAllTempIncidentOffenseNameWeapons}} for a list of TempIncidentOffenseNameWeapons.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameWeapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameWeapon <- function(TempIncidentOffenseNameWeaponID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameWeapon", TempIncidentOffenseNameWeaponID, EntityID)
}
#' Get all TempIncidentOffenseNameWeaponMNs.
#'
#' This function returns a dataframe of all TempIncidentOffenseNameWeaponMNs 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 Discipline
#' @return All TempIncidentOffenseNameWeaponMNs in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempIncidentOffenseNameWeaponMNs <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempIncidentOffenseNameWeaponID = F, returnCreatedTime = F, returnGunFoundInTrunk = F, returnGunWasInCase = F, returnGunWasLoaded = F, returnIncidentOffenseNameWeaponID = F, returnMeetsFederalStatuteOfDangerousWeapon = F, returnMeetsStateStatuteOfDangerousWeapon = F, returnModifiedTime = F, returnTempIncidentOffenseNameID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWeaponCount = F, returnWeaponID = 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("Discipline", "TempIncidentOffenseNameWeaponMN", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempIncidentOffenseNameWeaponMN
#'
#' This function returns fields for a TempIncidentOffenseNameWeaponMN.
#'
#' @param TempIncidentOffenseNameWeaponMNID The id of the TempIncidentOffenseNameWeaponMN.\cr Run \code{\link{getAllTempIncidentOffenseNameWeaponMNs}} for a list of TempIncidentOffenseNameWeaponMNs.
#' @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 Discipline
#' @return Details for the TempIncidentOffenseNameWeaponMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempIncidentOffenseNameWeaponMN <- function(TempIncidentOffenseNameWeaponMNID, EntityID = 1, returnTempIncidentOffenseNameWeaponID = F, returnCreatedTime = F, returnGunFoundInTrunk = F, returnGunWasInCase = F, returnGunWasLoaded = F, returnIncidentOffenseNameWeaponID = F, returnMeetsFederalStatuteOfDangerousWeapon = F, returnMeetsStateStatuteOfDangerousWeapon = F, returnModifiedTime = F, returnTempIncidentOffenseNameID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWeaponCount = F, returnWeaponID = 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("Discipline", "TempIncidentOffenseNameWeaponMN", TempIncidentOffenseNameWeaponMNID, searchFields, EntityID)
}
#' Modify a specific TempIncidentOffenseNameWeaponMN
#'
#' This function modifies fields for a TempIncidentOffenseNameWeaponMN.
#'
#' @param TempIncidentOffenseNameWeaponMNID The id of the TempIncidentOffenseNameWeaponMN to be modified.\cr Run \code{\link{getAllTempIncidentOffenseNameWeaponMNs}} for a list of TempIncidentOffenseNameWeaponMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified TempIncidentOffenseNameWeaponMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempIncidentOffenseNameWeaponMN <- function(TempIncidentOffenseNameWeaponMNID, EntityID = 1, setGunFoundInTrunk = NULL, setGunWasInCase = NULL, setGunWasLoaded = NULL, setMeetsFederalStatuteOfDangerousWeapon = NULL, setMeetsStateStatuteOfDangerousWeapon = NULL, setTempIncidentOffenseNameID = NULL, setWeaponCount = NULL, setWeaponID = 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("Discipline", "TempIncidentOffenseNameWeaponMN", TempIncidentOffenseNameWeaponMNID, names(functionParams), functionParams, EntityID)
}
#' Create new TempIncidentOffenseNameWeaponMN.
#'
#' This function creates a new TempIncidentOffenseNameWeaponMN.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created TempIncidentOffenseNameWeaponMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempIncidentOffenseNameWeaponMN <- function(EntityID = 1, setGunFoundInTrunk = NULL, setGunWasInCase = NULL, setGunWasLoaded = NULL, setMeetsFederalStatuteOfDangerousWeapon = NULL, setMeetsStateStatuteOfDangerousWeapon = NULL, setTempIncidentOffenseNameID = NULL, setWeaponCount = NULL, setWeaponID = 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("Discipline", "TempIncidentOffenseNameWeaponMN", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempIncidentOffenseNameWeaponMN
#'
#' This function deletes a TempIncidentOffenseNameWeaponMN.
#'
#' @param TempIncidentOffenseNameWeaponMNID The id of the TempIncidentOffenseNameWeaponMN.\cr Run \code{\link{getAllTempIncidentOffenseNameWeaponMNs}} for a list of TempIncidentOffenseNameWeaponMNs.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted TempIncidentOffenseNameWeaponMN.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempIncidentOffenseNameWeaponMN <- function(TempIncidentOffenseNameWeaponMNID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "TempIncidentOffenseNameWeaponMN", TempIncidentOffenseNameWeaponMNID, EntityID)
}
#' Get all Weapons.
#'
#' This function returns a dataframe of all Weapons 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 Discipline
#' @return All Weapons in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllWeapons <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnWeaponID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnSchoolYearID = F, returnStatePelletGunTypeMNID = F, returnStateWeaponTypeMNID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWeaponIDClonedFrom = F, returnWeaponMNID = 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("Discipline", "Weapon", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Weapon
#'
#' This function returns fields for a Weapon.
#'
#' @param WeaponID The id of the Weapon.\cr Run \code{\link{getAllWeapons}} for a list of Weapons.
#' @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 Discipline
#' @return Details for the Weapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getWeapon <- function(WeaponID, EntityID = 1, returnWeaponID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnIsReadOnlyHistoricalRecord = F, returnModifiedTime = F, returnSchoolYearID = F, returnStatePelletGunTypeMNID = F, returnStateWeaponTypeMNID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWeaponIDClonedFrom = F, returnWeaponMNID = 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("Discipline", "Weapon", WeaponID, searchFields, EntityID)
}
#' Modify a specific Weapon
#'
#' This function modifies fields for a Weapon.
#'
#' @param WeaponID The id of the Weapon to be modified.\cr Run \code{\link{getAllWeapons}} for a list of Weapons.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified Weapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyWeapon <- function(WeaponID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setSchoolYearID = NULL, setStatePelletGunTypeMNID = NULL, setStateWeaponTypeMNID = NULL, setWeaponIDClonedFrom = 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("Discipline", "Weapon", WeaponID, names(functionParams), functionParams, EntityID)
}
#' Create new Weapon.
#'
#' This function creates a new Weapon.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created Weapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createWeapon <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setSchoolYearID = NULL, setStatePelletGunTypeMNID = NULL, setStateWeaponTypeMNID = NULL, setWeaponIDClonedFrom = 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("Discipline", "Weapon", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Weapon
#'
#' This function deletes a Weapon.
#'
#' @param WeaponID The id of the Weapon.\cr Run \code{\link{getAllWeapons}} for a list of Weapons.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted Weapon.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteWeapon <- function(WeaponID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "Weapon", WeaponID, EntityID)
}
#' Get all WhiteListFieldPaths.
#'
#' This function returns a dataframe of all WhiteListFieldPaths 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 Discipline
#' @return All WhiteListFieldPaths in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllWhiteListFieldPaths <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnWhiteListFieldPathID = F, returnCreatedTime = F, returnDescription = F, returnFieldPath = F, returnFriendlyName = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnUsedForType = F, returnUsedForTypeCode = 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("Discipline", "WhiteListFieldPath", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific WhiteListFieldPath
#'
#' This function returns fields for a WhiteListFieldPath.
#'
#' @param WhiteListFieldPathID The id of the WhiteListFieldPath.\cr Run \code{\link{getAllWhiteListFieldPaths}} for a list of WhiteListFieldPaths.
#' @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 Discipline
#' @return Details for the WhiteListFieldPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getWhiteListFieldPath <- function(WhiteListFieldPathID, EntityID = 1, returnWhiteListFieldPathID = F, returnCreatedTime = F, returnDescription = F, returnFieldPath = F, returnFriendlyName = F, returnModifiedTime = F, returnSkywardHash = F, returnSkywardID = F, returnUsedForType = F, returnUsedForTypeCode = 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("Discipline", "WhiteListFieldPath", WhiteListFieldPathID, searchFields, EntityID)
}
#' Modify a specific WhiteListFieldPath
#'
#' This function modifies fields for a WhiteListFieldPath.
#'
#' @param WhiteListFieldPathID The id of the WhiteListFieldPath to be modified.\cr Run \code{\link{getAllWhiteListFieldPaths}} for a list of WhiteListFieldPaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return Details of the modified WhiteListFieldPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyWhiteListFieldPath <- function(WhiteListFieldPathID, EntityID = 1, setDescription = NULL, setFieldPath = NULL, setFriendlyName = NULL, setSkywardHash = NULL, setSkywardID = NULL, setUsedForType = NULL, setUsedForTypeCode = 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("Discipline", "WhiteListFieldPath", WhiteListFieldPathID, names(functionParams), functionParams, EntityID)
}
#' Create new WhiteListFieldPath.
#'
#' This function creates a new WhiteListFieldPath.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept Discipline
#' @return The fields used to define the newly created WhiteListFieldPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createWhiteListFieldPath <- function(EntityID = 1, setDescription = NULL, setFieldPath = NULL, setFriendlyName = NULL, setSkywardHash = NULL, setSkywardID = NULL, setUsedForType = NULL, setUsedForTypeCode = 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("Discipline", "WhiteListFieldPath", names(functionParams), functionParams, EntityID)
}
#' Delete a specific WhiteListFieldPath
#'
#' This function deletes a WhiteListFieldPath.
#'
#' @param WhiteListFieldPathID The id of the WhiteListFieldPath.\cr Run \code{\link{getAllWhiteListFieldPaths}} for a list of WhiteListFieldPaths.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept Discipline
#' @return The id of the deleted WhiteListFieldPath.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteWhiteListFieldPath <- function(WhiteListFieldPathID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("Discipline", "WhiteListFieldPath", WhiteListFieldPathID, EntityID)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.