#' Get all Elements.
#'
#' This function returns a dataframe of all Elements 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 OnlineForm
#' @return All Elements in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllElements <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnElementID = F, returnAdminCanEdit = F, returnAgreementMessage = F, returnAllowsUserInteraction = F, returnApprovalType = F, returnApprovalTypeCode = F, returnCodeListFieldName = F, returnCodeListFieldPath = F, returnCodeListType = F, returnCodeListTypeCode = F, returnCodeListTypeLabel = F, returnComboboxDefaultValue = F, returnComboboxTextValue = F, returnCommonColorPickerValue = F, returnCommonFontAlignmentValue = F, returnCommonTextValue = F, returnCommonType = F, returnCommonTypeCode = F, returnCoverageEndDate = F, returnCoverageStartDate = F, returnCreatedTime = F, returnDataGridXML = F, returnDescription = F, returnDistrictID = F, returnElementGroupID = F, returnEmbeddedLinkFullFilename = F, returnEmbeddedLinkProtocol = F, returnEmbeddedLinkProtocolCode = F, returnEmbeddedLinkURL = F, returnEmergencyContact = F, returnFieldDisplayName = F, returnFieldGroup = F, returnFieldGroupCode = F, returnFieldID = F, returnFieldIsRelationship = F, returnFieldLabel = F, returnFieldName = F, returnFieldPath = F, returnFieldRelationship = F, returnGUIDFieldPath = F, returnHasBackingObject = F, returnHasSharedValue = F, returnHealthConditionIDs = F, returnHealthProviderExcludeDentalInsurance = F, returnHealthProviderExcludeDentist = F, returnHealthProviderExcludeDentistOffice = F, returnHealthProviderExcludeEmail = F, returnHealthProviderExcludeHealthInsurance = F, returnHealthProviderExcludeHospital = F, returnHealthProviderExcludePhone = F, returnHealthProviderExcludePrimaryPhysician = F, returnHtmlDescription = F, returnHtmlLabel = F, returnHtmlOptions = F, returnIncludeCECSInStudentSelector = F, returnIsNewStudentEnrollmentElement = F, returnIsRequiredElement = F, returnLabelOverrides = F, returnLanguageOption = F, returnLanguageOptionCode = F, returnLinkProtocol = F, returnLinkProtocolCode = F, returnMaxNumberEmergencyContacts = F, returnMaxUploadFileSize = F, returnMaxUploadFileSizeUnit = F, returnMaxUploadFileSizeUnitCode = F, returnMediaID = F, returnMergeMarkupSet = F, returnMergeMarkupSetDescription = F, returnMergeMarkupSetLabel = F, returnModifiedTime = F, returnNewStudentEnrollmentGuardianRequireDriversLicense = F, returnNewStudentEnrollmentGuardianUseVehicleInformation = F, returnNewStudentEnrollmentRelationshipRequired = F, returnNewStudentEnrollmentShowCustodialInformation = F, returnNewStudentEnrollmentUseAddSecondFamily = F, returnOrder = F, returnParameterData = F, returnParameters = F, returnPaymentEndDate = F, returnPaymentStartDate = F, returnPlanID = F, returnPostfixText = F, returnPrefixText = F, returnRaceEthnicityMessage = F, returnRaceEthnicityMessageInSpanish = F, returnRelationshipRequiredOnFamilyInformation = F, returnRenderAgreement = F, returnRenderInstructions = F, returnRenderLanguageOptions = F, returnRenderWeight = F, returnRequireDriversLicenseIfAllowStudentPickupOnEmergencyContact = F, returnRequireDriversLicenseIfAllowStudentPickupOnFamilyInformation = F, returnSharedValueUsesNotShared = F, returnShowCustodialOnFamilyInformation = F, returnShowVehicleInformationOnEmergencyContact = F, returnShowVehicleOnFamilyInformation = F, returnStepID = F, returnSupportsLabelOverrides = F, returnType = F, returnTypeCode = F, returnUploadType = F, returnUploadTypeCode = F, returnUrl = F, returnUrlDisplayName = F, returnUserDownloadDisplayText = F, returnUserDownloadInstructions = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserUploadDescription = F, returnUserUploadLabel = F, returnValidUploadFileTypes = F, returnYesNoResponse = F, returnYesNoResponseCode = 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("OnlineForm", "Element", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Element
#'
#' This function returns fields for an Element.
#'
#' @param ElementID The id of the Element.\cr Run \code{\link{getAllElements}} for a list of Elements.
#' @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 OnlineForm
#' @return Details for the Element.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getElement <- function(ElementID, EntityID = 1, returnElementID = F, returnAdminCanEdit = F, returnAgreementMessage = F, returnAllowsUserInteraction = F, returnApprovalType = F, returnApprovalTypeCode = F, returnCodeListFieldName = F, returnCodeListFieldPath = F, returnCodeListType = F, returnCodeListTypeCode = F, returnCodeListTypeLabel = F, returnComboboxDefaultValue = F, returnComboboxTextValue = F, returnCommonColorPickerValue = F, returnCommonFontAlignmentValue = F, returnCommonTextValue = F, returnCommonType = F, returnCommonTypeCode = F, returnCoverageEndDate = F, returnCoverageStartDate = F, returnCreatedTime = F, returnDataGridXML = F, returnDescription = F, returnDistrictID = F, returnElementGroupID = F, returnEmbeddedLinkFullFilename = F, returnEmbeddedLinkProtocol = F, returnEmbeddedLinkProtocolCode = F, returnEmbeddedLinkURL = F, returnEmergencyContact = F, returnFieldDisplayName = F, returnFieldGroup = F, returnFieldGroupCode = F, returnFieldID = F, returnFieldIsRelationship = F, returnFieldLabel = F, returnFieldName = F, returnFieldPath = F, returnFieldRelationship = F, returnGUIDFieldPath = F, returnHasBackingObject = F, returnHasSharedValue = F, returnHealthConditionIDs = F, returnHealthProviderExcludeDentalInsurance = F, returnHealthProviderExcludeDentist = F, returnHealthProviderExcludeDentistOffice = F, returnHealthProviderExcludeEmail = F, returnHealthProviderExcludeHealthInsurance = F, returnHealthProviderExcludeHospital = F, returnHealthProviderExcludePhone = F, returnHealthProviderExcludePrimaryPhysician = F, returnHtmlDescription = F, returnHtmlLabel = F, returnHtmlOptions = F, returnIncludeCECSInStudentSelector = F, returnIsNewStudentEnrollmentElement = F, returnIsRequiredElement = F, returnLabelOverrides = F, returnLanguageOption = F, returnLanguageOptionCode = F, returnLinkProtocol = F, returnLinkProtocolCode = F, returnMaxNumberEmergencyContacts = F, returnMaxUploadFileSize = F, returnMaxUploadFileSizeUnit = F, returnMaxUploadFileSizeUnitCode = F, returnMediaID = F, returnMergeMarkupSet = F, returnMergeMarkupSetDescription = F, returnMergeMarkupSetLabel = F, returnModifiedTime = F, returnNewStudentEnrollmentGuardianRequireDriversLicense = F, returnNewStudentEnrollmentGuardianUseVehicleInformation = F, returnNewStudentEnrollmentRelationshipRequired = F, returnNewStudentEnrollmentShowCustodialInformation = F, returnNewStudentEnrollmentUseAddSecondFamily = F, returnOrder = F, returnParameterData = F, returnParameters = F, returnPaymentEndDate = F, returnPaymentStartDate = F, returnPlanID = F, returnPostfixText = F, returnPrefixText = F, returnRaceEthnicityMessage = F, returnRaceEthnicityMessageInSpanish = F, returnRelationshipRequiredOnFamilyInformation = F, returnRenderAgreement = F, returnRenderInstructions = F, returnRenderLanguageOptions = F, returnRenderWeight = F, returnRequireDriversLicenseIfAllowStudentPickupOnEmergencyContact = F, returnRequireDriversLicenseIfAllowStudentPickupOnFamilyInformation = F, returnSharedValueUsesNotShared = F, returnShowCustodialOnFamilyInformation = F, returnShowVehicleInformationOnEmergencyContact = F, returnShowVehicleOnFamilyInformation = F, returnStepID = F, returnSupportsLabelOverrides = F, returnType = F, returnTypeCode = F, returnUploadType = F, returnUploadTypeCode = F, returnUrl = F, returnUrlDisplayName = F, returnUserDownloadDisplayText = F, returnUserDownloadInstructions = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserUploadDescription = F, returnUserUploadLabel = F, returnValidUploadFileTypes = F, returnYesNoResponse = F, returnYesNoResponseCode = 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("OnlineForm", "Element", ElementID, searchFields, EntityID)
}
#' Modify a specific Element
#'
#' This function modifies fields for an Element.
#'
#' @param ElementID The id of the Element to be modified.\cr Run \code{\link{getAllElements}} for a list of Elements.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified Element.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyElement <- function(ElementID, EntityID = 1, setAgreementMessage = NULL, setApprovalType = NULL, setApprovalTypeCode = NULL, setCodeListType = NULL, setCodeListTypeCode = NULL, setCodeListTypeLabel = NULL, setComboboxDefaultValue = NULL, setComboboxTextValue = NULL, setCommonColorPickerValue = NULL, setCommonFontAlignmentValue = NULL, setCommonTextValue = NULL, setCommonType = NULL, setCommonTypeCode = NULL, setCoverageEndDate = NULL, setCoverageStartDate = NULL, setDataGridXML = NULL, setDistrictID = NULL, setElementGroupID = NULL, setEmbeddedLinkProtocol = NULL, setEmbeddedLinkProtocolCode = NULL, setEmbeddedLinkURL = NULL, setEmergencyContact = NULL, setFieldDisplayName = NULL, setFieldGroup = NULL, setFieldGroupCode = NULL, setFieldID = NULL, setFieldIsRelationship = NULL, setFieldLabel = NULL, setFieldName = NULL, setFieldPath = NULL, setGUIDFieldPath = NULL, setHealthConditionIDs = NULL, setHealthProviderExcludeDentalInsurance = NULL, setHealthProviderExcludeDentist = NULL, setHealthProviderExcludeDentistOffice = NULL, setHealthProviderExcludeEmail = NULL, setHealthProviderExcludeHealthInsurance = NULL, setHealthProviderExcludeHospital = NULL, setHealthProviderExcludePhone = NULL, setHealthProviderExcludePrimaryPhysician = NULL, setHtmlDescription = NULL, setHtmlLabel = NULL, setHtmlOptions = NULL, setIncludeCECSInStudentSelector = NULL, setIsRequiredElement = NULL, setLabelOverrides = NULL, setLanguageOption = NULL, setLanguageOptionCode = NULL, setLinkProtocol = NULL, setLinkProtocolCode = NULL, setMaxNumberEmergencyContacts = NULL, setMaxUploadFileSize = NULL, setMaxUploadFileSizeUnit = NULL, setMaxUploadFileSizeUnitCode = NULL, setMediaID = NULL, setMergeMarkupSet = NULL, setMergeMarkupSetDescription = NULL, setMergeMarkupSetLabel = NULL, setNewStudentEnrollmentGuardianRequireDriversLicense = NULL, setNewStudentEnrollmentGuardianUseVehicleInformation = NULL, setNewStudentEnrollmentRelationshipRequired = NULL, setNewStudentEnrollmentShowCustodialInformation = NULL, setNewStudentEnrollmentUseAddSecondFamily = NULL, setOrder = NULL, setParameterData = NULL, setParameters = NULL, setPaymentEndDate = NULL, setPaymentStartDate = NULL, setPlanID = NULL, setPostfixText = NULL, setPrefixText = NULL, setRaceEthnicityMessage = NULL, setRaceEthnicityMessageInSpanish = NULL, setRelationshipRequiredOnFamilyInformation = NULL, setRenderAgreement = NULL, setRenderInstructions = NULL, setRenderLanguageOptions = NULL, setRequireDriversLicenseIfAllowStudentPickupOnEmergencyContact = NULL, setRequireDriversLicenseIfAllowStudentPickupOnFamilyInformation = NULL, setShowCustodialOnFamilyInformation = NULL, setShowVehicleInformationOnEmergencyContact = NULL, setShowVehicleOnFamilyInformation = NULL, setStepID = NULL, setType = NULL, setTypeCode = NULL, setUploadType = NULL, setUploadTypeCode = NULL, setUrl = NULL, setUrlDisplayName = NULL, setUserDownloadDisplayText = NULL, setUserDownloadInstructions = NULL, setUserUploadDescription = NULL, setUserUploadLabel = NULL, setValidUploadFileTypes = NULL, setYesNoResponse = NULL, setYesNoResponseCode = 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("OnlineForm", "Element", ElementID, names(functionParams), functionParams, EntityID)
}
#' Create new Element.
#'
#' This function creates a new Element.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created Element.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createElement <- function(EntityID = 1, setAgreementMessage = NULL, setApprovalType = NULL, setApprovalTypeCode = NULL, setCodeListType = NULL, setCodeListTypeCode = NULL, setCodeListTypeLabel = NULL, setComboboxDefaultValue = NULL, setComboboxTextValue = NULL, setCommonColorPickerValue = NULL, setCommonFontAlignmentValue = NULL, setCommonTextValue = NULL, setCommonType = NULL, setCommonTypeCode = NULL, setCoverageEndDate = NULL, setCoverageStartDate = NULL, setDataGridXML = NULL, setDistrictID = NULL, setElementGroupID = NULL, setEmbeddedLinkProtocol = NULL, setEmbeddedLinkProtocolCode = NULL, setEmbeddedLinkURL = NULL, setEmergencyContact = NULL, setFieldDisplayName = NULL, setFieldGroup = NULL, setFieldGroupCode = NULL, setFieldID = NULL, setFieldIsRelationship = NULL, setFieldLabel = NULL, setFieldName = NULL, setFieldPath = NULL, setGUIDFieldPath = NULL, setHealthConditionIDs = NULL, setHealthProviderExcludeDentalInsurance = NULL, setHealthProviderExcludeDentist = NULL, setHealthProviderExcludeDentistOffice = NULL, setHealthProviderExcludeEmail = NULL, setHealthProviderExcludeHealthInsurance = NULL, setHealthProviderExcludeHospital = NULL, setHealthProviderExcludePhone = NULL, setHealthProviderExcludePrimaryPhysician = NULL, setHtmlDescription = NULL, setHtmlLabel = NULL, setHtmlOptions = NULL, setIncludeCECSInStudentSelector = NULL, setIsRequiredElement = NULL, setLabelOverrides = NULL, setLanguageOption = NULL, setLanguageOptionCode = NULL, setLinkProtocol = NULL, setLinkProtocolCode = NULL, setMaxNumberEmergencyContacts = NULL, setMaxUploadFileSize = NULL, setMaxUploadFileSizeUnit = NULL, setMaxUploadFileSizeUnitCode = NULL, setMediaID = NULL, setMergeMarkupSet = NULL, setMergeMarkupSetDescription = NULL, setMergeMarkupSetLabel = NULL, setNewStudentEnrollmentGuardianRequireDriversLicense = NULL, setNewStudentEnrollmentGuardianUseVehicleInformation = NULL, setNewStudentEnrollmentRelationshipRequired = NULL, setNewStudentEnrollmentShowCustodialInformation = NULL, setNewStudentEnrollmentUseAddSecondFamily = NULL, setOrder = NULL, setParameterData = NULL, setParameters = NULL, setPaymentEndDate = NULL, setPaymentStartDate = NULL, setPlanID = NULL, setPostfixText = NULL, setPrefixText = NULL, setRaceEthnicityMessage = NULL, setRaceEthnicityMessageInSpanish = NULL, setRelationshipRequiredOnFamilyInformation = NULL, setRenderAgreement = NULL, setRenderInstructions = NULL, setRenderLanguageOptions = NULL, setRequireDriversLicenseIfAllowStudentPickupOnEmergencyContact = NULL, setRequireDriversLicenseIfAllowStudentPickupOnFamilyInformation = NULL, setShowCustodialOnFamilyInformation = NULL, setShowVehicleInformationOnEmergencyContact = NULL, setShowVehicleOnFamilyInformation = NULL, setStepID = NULL, setType = NULL, setTypeCode = NULL, setUploadType = NULL, setUploadTypeCode = NULL, setUrl = NULL, setUrlDisplayName = NULL, setUserDownloadDisplayText = NULL, setUserDownloadInstructions = NULL, setUserUploadDescription = NULL, setUserUploadLabel = NULL, setValidUploadFileTypes = NULL, setYesNoResponse = NULL, setYesNoResponseCode = 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("OnlineForm", "Element", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Element
#'
#' This function deletes an Element.
#'
#' @param ElementID The id of the Element.\cr Run \code{\link{getAllElements}} for a list of Elements.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted Element.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteElement <- function(ElementID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "Element", ElementID, EntityID)
}
#' Get all ElementGroups.
#'
#' This function returns a dataframe of all ElementGroups 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 OnlineForm
#' @return All ElementGroups in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllElementGroups <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnElementGroupID = F, returnCreatedTime = F, returnModifiedTime = F, returnName = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("OnlineForm", "ElementGroup", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ElementGroup
#'
#' This function returns fields for an ElementGroup.
#'
#' @param ElementGroupID The id of the ElementGroup.\cr Run \code{\link{getAllElementGroups}} for a list of ElementGroups.
#' @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 OnlineForm
#' @return Details for the ElementGroup.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getElementGroup <- function(ElementGroupID, EntityID = 1, returnElementGroupID = F, returnCreatedTime = F, returnModifiedTime = F, returnName = F, returnSkywardHash = F, returnSkywardID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("OnlineForm", "ElementGroup", ElementGroupID, searchFields, EntityID)
}
#' Modify a specific ElementGroup
#'
#' This function modifies fields for an ElementGroup.
#'
#' @param ElementGroupID The id of the ElementGroup to be modified.\cr Run \code{\link{getAllElementGroups}} for a list of ElementGroups.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified ElementGroup.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyElementGroup <- function(ElementGroupID, EntityID = 1, setName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("OnlineForm", "ElementGroup", ElementGroupID, names(functionParams), functionParams, EntityID)
}
#' Create new ElementGroup.
#'
#' This function creates a new ElementGroup.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created ElementGroup.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createElementGroup <- function(EntityID = 1, setName = NULL, setSkywardHash = NULL, setSkywardID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("OnlineForm", "ElementGroup", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ElementGroup
#'
#' This function deletes an ElementGroup.
#'
#' @param ElementGroupID The id of the ElementGroup.\cr Run \code{\link{getAllElementGroups}} for a list of ElementGroups.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted ElementGroup.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteElementGroup <- function(ElementGroupID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "ElementGroup", ElementGroupID, EntityID)
}
#' Get all ElementGroupTemplates.
#'
#' This function returns a dataframe of all ElementGroupTemplates 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 OnlineForm
#' @return All ElementGroupTemplates in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllElementGroupTemplates <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnElementGroupTemplateID = F, returnCreatedTime = F, returnElementGroupID = F, returnModifiedTime = F, returnOrder = F, returnParameterData = F, returnSkywardHash = F, returnSkywardID = 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("OnlineForm", "ElementGroupTemplate", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ElementGroupTemplate
#'
#' This function returns fields for an ElementGroupTemplate.
#'
#' @param ElementGroupTemplateID The id of the ElementGroupTemplate.\cr Run \code{\link{getAllElementGroupTemplates}} for a list of ElementGroupTemplates.
#' @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 OnlineForm
#' @return Details for the ElementGroupTemplate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getElementGroupTemplate <- function(ElementGroupTemplateID, EntityID = 1, returnElementGroupTemplateID = F, returnCreatedTime = F, returnElementGroupID = F, returnModifiedTime = F, returnOrder = F, returnParameterData = F, returnSkywardHash = F, returnSkywardID = 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("OnlineForm", "ElementGroupTemplate", ElementGroupTemplateID, searchFields, EntityID)
}
#' Modify a specific ElementGroupTemplate
#'
#' This function modifies fields for an ElementGroupTemplate.
#'
#' @param ElementGroupTemplateID The id of the ElementGroupTemplate to be modified.\cr Run \code{\link{getAllElementGroupTemplates}} for a list of ElementGroupTemplates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified ElementGroupTemplate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyElementGroupTemplate <- function(ElementGroupTemplateID, EntityID = 1, setElementGroupID = NULL, setOrder = NULL, setParameterData = NULL, setSkywardHash = NULL, setSkywardID = 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("OnlineForm", "ElementGroupTemplate", ElementGroupTemplateID, names(functionParams), functionParams, EntityID)
}
#' Create new ElementGroupTemplate.
#'
#' This function creates a new ElementGroupTemplate.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created ElementGroupTemplate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createElementGroupTemplate <- function(EntityID = 1, setElementGroupID = NULL, setOrder = NULL, setParameterData = NULL, setSkywardHash = NULL, setSkywardID = 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("OnlineForm", "ElementGroupTemplate", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ElementGroupTemplate
#'
#' This function deletes an ElementGroupTemplate.
#'
#' @param ElementGroupTemplateID The id of the ElementGroupTemplate.\cr Run \code{\link{getAllElementGroupTemplates}} for a list of ElementGroupTemplates.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted ElementGroupTemplate.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteElementGroupTemplate <- function(ElementGroupTemplateID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "ElementGroupTemplate", ElementGroupTemplateID, EntityID)
}
#' Get all ElementStatuses.
#'
#' This function returns a dataframe of all ElementStatuses 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 OnlineForm
#' @return All ElementStatuses in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllElementStatuses <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnElementStatusID = F, returnCreatedTime = F, returnDenialMessage = F, returnElementID = F, returnFieldGroupLabelAndFieldFieldGroupOriginalValue = F, returnFieldGroupLabelAndFieldFieldGroupRequestedValue = F, returnIsReadOnly = F, returnMediaIDAttachment = F, returnModifiedTime = F, returnNeedsAdminReviewSave = F, returnOriginalValue = F, returnReportDataOriginalValue = F, returnReportDataRequestedValue = F, returnRequestedValue = F, returnSharedElementStatusID = F, returnStatusType = F, returnStatusTypeCode = F, returnStepStatusID = F, returnUserIDApprover = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserSubmitted = F, returnValidationMessage = 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("OnlineForm", "ElementStatus", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ElementStatus
#'
#' This function returns fields for an ElementStatus.
#'
#' @param ElementStatusID The id of the ElementStatus.\cr Run \code{\link{getAllElementStatuses}} for a list of ElementStatuses.
#' @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 OnlineForm
#' @return Details for the ElementStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getElementStatus <- function(ElementStatusID, EntityID = 1, returnElementStatusID = F, returnCreatedTime = F, returnDenialMessage = F, returnElementID = F, returnFieldGroupLabelAndFieldFieldGroupOriginalValue = F, returnFieldGroupLabelAndFieldFieldGroupRequestedValue = F, returnIsReadOnly = F, returnMediaIDAttachment = F, returnModifiedTime = F, returnNeedsAdminReviewSave = F, returnOriginalValue = F, returnReportDataOriginalValue = F, returnReportDataRequestedValue = F, returnRequestedValue = F, returnSharedElementStatusID = F, returnStatusType = F, returnStatusTypeCode = F, returnStepStatusID = F, returnUserIDApprover = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserSubmitted = F, returnValidationMessage = 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("OnlineForm", "ElementStatus", ElementStatusID, searchFields, EntityID)
}
#' Modify a specific ElementStatus
#'
#' This function modifies fields for an ElementStatus.
#'
#' @param ElementStatusID The id of the ElementStatus to be modified.\cr Run \code{\link{getAllElementStatuses}} for a list of ElementStatus.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified ElementStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyElementStatus <- function(ElementStatusID, EntityID = 1, setDenialMessage = NULL, setElementID = NULL, setIsReadOnly = NULL, setMediaIDAttachment = NULL, setOriginalValue = NULL, setRequestedValue = NULL, setSharedElementStatusID = NULL, setStatusType = NULL, setStatusTypeCode = NULL, setStepStatusID = NULL, setUserIDApprover = NULL, setUserSubmitted = NULL, setValidationMessage = 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("OnlineForm", "ElementStatus", ElementStatusID, names(functionParams), functionParams, EntityID)
}
#' Create new ElementStatus.
#'
#' This function creates a new ElementStatus.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created ElementStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createElementStatus <- function(EntityID = 1, setDenialMessage = NULL, setElementID = NULL, setIsReadOnly = NULL, setMediaIDAttachment = NULL, setOriginalValue = NULL, setRequestedValue = NULL, setSharedElementStatusID = NULL, setStatusType = NULL, setStatusTypeCode = NULL, setStepStatusID = NULL, setUserIDApprover = NULL, setUserSubmitted = NULL, setValidationMessage = 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("OnlineForm", "ElementStatus", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ElementStatus
#'
#' This function deletes an ElementStatus.
#'
#' @param ElementStatusID The id of the ElementStatus.\cr Run \code{\link{getAllElementStatuses}} for a list of ElementStatuses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted ElementStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteElementStatus <- function(ElementStatusID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "ElementStatus", ElementStatusID, EntityID)
}
#' Get all ElementStatusSurveyAnswers.
#'
#' This function returns a dataframe of all ElementStatusSurveyAnswers 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 OnlineForm
#' @return All ElementStatusSurveyAnswers in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllElementStatusSurveyAnswers <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnElementStatusSurveyAnswerID = F, returnColumnName = F, returnCreatedTime = F, returnElementStatusID = F, returnModifiedTime = F, returnNameID = F, returnOnlineFormID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValue = 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("OnlineForm", "ElementStatusSurveyAnswer", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific ElementStatusSurveyAnswer
#'
#' This function returns fields for an ElementStatusSurveyAnswer.
#'
#' @param ElementStatusSurveyAnswerID The id of the ElementStatusSurveyAnswer.\cr Run \code{\link{getAllElementStatusSurveyAnswers}} for a list of ElementStatusSurveyAnswers.
#' @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 OnlineForm
#' @return Details for the ElementStatusSurveyAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getElementStatusSurveyAnswer <- function(ElementStatusSurveyAnswerID, EntityID = 1, returnElementStatusSurveyAnswerID = F, returnColumnName = F, returnCreatedTime = F, returnElementStatusID = F, returnModifiedTime = F, returnNameID = F, returnOnlineFormID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValue = 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("OnlineForm", "ElementStatusSurveyAnswer", ElementStatusSurveyAnswerID, searchFields, EntityID)
}
#' Modify a specific ElementStatusSurveyAnswer
#'
#' This function modifies fields for an ElementStatusSurveyAnswer.
#'
#' @param ElementStatusSurveyAnswerID The id of the ElementStatusSurveyAnswer to be modified.\cr Run \code{\link{getAllElementStatusSurveyAnswers}} for a list of ElementStatusSurveyAnswers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified ElementStatusSurveyAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyElementStatusSurveyAnswer <- function(ElementStatusSurveyAnswerID, EntityID = 1, setColumnName = NULL, setElementStatusID = NULL, setNameID = NULL, setOnlineFormID = NULL, setValue = 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("OnlineForm", "ElementStatusSurveyAnswer", ElementStatusSurveyAnswerID, names(functionParams), functionParams, EntityID)
}
#' Create new ElementStatusSurveyAnswer.
#'
#' This function creates a new ElementStatusSurveyAnswer.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created ElementStatusSurveyAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createElementStatusSurveyAnswer <- function(EntityID = 1, setColumnName = NULL, setElementStatusID = NULL, setNameID = NULL, setOnlineFormID = NULL, setValue = 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("OnlineForm", "ElementStatusSurveyAnswer", names(functionParams), functionParams, EntityID)
}
#' Delete a specific ElementStatusSurveyAnswer
#'
#' This function deletes an ElementStatusSurveyAnswer.
#'
#' @param ElementStatusSurveyAnswerID The id of the ElementStatusSurveyAnswer.\cr Run \code{\link{getAllElementStatusSurveyAnswers}} for a list of ElementStatusSurveyAnswers.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted ElementStatusSurveyAnswer.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteElementStatusSurveyAnswer <- function(ElementStatusSurveyAnswerID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "ElementStatusSurveyAnswer", ElementStatusSurveyAnswerID, EntityID)
}
#' Get all MassPrintHistories.
#'
#' This function returns a dataframe of all MassPrintHistories 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 OnlineForm
#' @return All MassPrintHistories in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllMassPrintHistories <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnMassPrintHistoryID = F, returnCreatedTime = F, returnMediaID = F, returnModifiedTime = F, returnOnlineFormID = F, returnRequestIdentifier = F, returnSendMessageOnComplete = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWorkflowInstanceID = 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("OnlineForm", "MassPrintHistory", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific MassPrintHistory
#'
#' This function returns fields for a MassPrintHistory.
#'
#' @param MassPrintHistoryID The id of the MassPrintHistory.\cr Run \code{\link{getAllMassPrintHistories}} for a list of MassPrintHistories.
#' @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 OnlineForm
#' @return Details for the MassPrintHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getMassPrintHistory <- function(MassPrintHistoryID, EntityID = 1, returnMassPrintHistoryID = F, returnCreatedTime = F, returnMediaID = F, returnModifiedTime = F, returnOnlineFormID = F, returnRequestIdentifier = F, returnSendMessageOnComplete = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWorkflowInstanceID = 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("OnlineForm", "MassPrintHistory", MassPrintHistoryID, searchFields, EntityID)
}
#' Modify a specific MassPrintHistory
#'
#' This function modifies fields for a MassPrintHistory.
#'
#' @param MassPrintHistoryID The id of the MassPrintHistory to be modified.\cr Run \code{\link{getAllMassPrintHistories}} for a list of MassPrintHistorys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified MassPrintHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyMassPrintHistory <- function(MassPrintHistoryID, EntityID = 1, setMediaID = NULL, setOnlineFormID = NULL, setRequestIdentifier = NULL, setSendMessageOnComplete = NULL, setWorkflowInstanceID = 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("OnlineForm", "MassPrintHistory", MassPrintHistoryID, names(functionParams), functionParams, EntityID)
}
#' Create new MassPrintHistory.
#'
#' This function creates a new MassPrintHistory.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created MassPrintHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createMassPrintHistory <- function(EntityID = 1, setMediaID = NULL, setOnlineFormID = NULL, setRequestIdentifier = NULL, setSendMessageOnComplete = NULL, setWorkflowInstanceID = 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("OnlineForm", "MassPrintHistory", names(functionParams), functionParams, EntityID)
}
#' Delete a specific MassPrintHistory
#'
#' This function deletes a MassPrintHistory.
#'
#' @param MassPrintHistoryID The id of the MassPrintHistory.\cr Run \code{\link{getAllMassPrintHistories}} for a list of MassPrintHistories.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted MassPrintHistory.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteMassPrintHistory <- function(MassPrintHistoryID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "MassPrintHistory", MassPrintHistoryID, EntityID)
}
#' Get all NewStudentEnrollmentGuardianDatas.
#'
#' This function returns a dataframe of all NewStudentEnrollmentGuardianDatas 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 OnlineForm
#' @return All NewStudentEnrollmentGuardianDatas in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllNewStudentEnrollmentGuardianDatas <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnNewStudentEnrollmentGuardianDataID = F, returnAddGuardian = F, returnAllowStudentPickup = F, returnColor = F, returnCreatedTime = F, returnCreateNewGuardian = F, returnDeleteGuardian = F, returnDriversLicenseNumber = F, returnFamilyGuardianID = F, returnFirstName = F, returnGender = F, returnGenderCode = F, returnIsCustodialGuardian = F, returnLastName = F, returnLicensePlateNumber = F, returnMakeModel = F, returnMiddleName = F, returnModifiedTime = F, returnNameID = F, returnNameSuffixID = F, returnNameVehicleID = F, returnOnScreenID = F, returnRank = F, returnRelationshipID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnVehicleID = F, returnVIN = F, returnYear = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("OnlineForm", "NewStudentEnrollmentGuardianData", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific NewStudentEnrollmentGuardianData
#'
#' This function returns fields for a NewStudentEnrollmentGuardianData.
#'
#' @param NewStudentEnrollmentGuardianDataID The id of the NewStudentEnrollmentGuardianData.\cr Run \code{\link{getAllNewStudentEnrollmentGuardianDatas}} for a list of NewStudentEnrollmentGuardianDatas.
#' @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 OnlineForm
#' @return Details for the NewStudentEnrollmentGuardianData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getNewStudentEnrollmentGuardianData <- function(NewStudentEnrollmentGuardianDataID, EntityID = 1, returnNewStudentEnrollmentGuardianDataID = F, returnAddGuardian = F, returnAllowStudentPickup = F, returnColor = F, returnCreatedTime = F, returnCreateNewGuardian = F, returnDeleteGuardian = F, returnDriversLicenseNumber = F, returnFamilyGuardianID = F, returnFirstName = F, returnGender = F, returnGenderCode = F, returnIsCustodialGuardian = F, returnLastName = F, returnLicensePlateNumber = F, returnMakeModel = F, returnMiddleName = F, returnModifiedTime = F, returnNameID = F, returnNameSuffixID = F, returnNameVehicleID = F, returnOnScreenID = F, returnRank = F, returnRelationshipID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnVehicleID = F, returnVIN = F, returnYear = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("OnlineForm", "NewStudentEnrollmentGuardianData", NewStudentEnrollmentGuardianDataID, searchFields, EntityID)
}
#' Modify a specific NewStudentEnrollmentGuardianData
#'
#' This function modifies fields for a NewStudentEnrollmentGuardianData.
#'
#' @param NewStudentEnrollmentGuardianDataID The id of the NewStudentEnrollmentGuardianData to be modified.\cr Run \code{\link{getAllNewStudentEnrollmentGuardianDatas}} for a list of NewStudentEnrollmentGuardianDatas.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified NewStudentEnrollmentGuardianData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyNewStudentEnrollmentGuardianData <- function(NewStudentEnrollmentGuardianDataID, EntityID = 1, setAddGuardian = NULL, setAllowStudentPickup = NULL, setColor = NULL, setCreateNewGuardian = NULL, setDeleteGuardian = NULL, setDriversLicenseNumber = NULL, setFamilyGuardianID = NULL, setFirstName = NULL, setGenderCode = NULL, setIsCustodialGuardian = NULL, setLastName = NULL, setLicensePlateNumber = NULL, setMakeModel = NULL, setMiddleName = NULL, setNameID = NULL, setNameSuffixID = NULL, setNameVehicleID = NULL, setOnScreenID = NULL, setRank = NULL, setRelationshipID = NULL, setVehicleID = NULL, setVIN = NULL, setYear = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("OnlineForm", "NewStudentEnrollmentGuardianData", NewStudentEnrollmentGuardianDataID, names(functionParams), functionParams, EntityID)
}
#' Create new NewStudentEnrollmentGuardianData.
#'
#' This function creates a new NewStudentEnrollmentGuardianData.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created NewStudentEnrollmentGuardianData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createNewStudentEnrollmentGuardianData <- function(EntityID = 1, setAddGuardian = NULL, setAllowStudentPickup = NULL, setColor = NULL, setCreateNewGuardian = NULL, setDeleteGuardian = NULL, setDriversLicenseNumber = NULL, setFamilyGuardianID = NULL, setFirstName = NULL, setGenderCode = NULL, setIsCustodialGuardian = NULL, setLastName = NULL, setLicensePlateNumber = NULL, setMakeModel = NULL, setMiddleName = NULL, setNameID = NULL, setNameSuffixID = NULL, setNameVehicleID = NULL, setOnScreenID = NULL, setRank = NULL, setRelationshipID = NULL, setVehicleID = NULL, setVIN = NULL, setYear = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("OnlineForm", "NewStudentEnrollmentGuardianData", names(functionParams), functionParams, EntityID)
}
#' Delete a specific NewStudentEnrollmentGuardianData
#'
#' This function deletes a NewStudentEnrollmentGuardianData.
#'
#' @param NewStudentEnrollmentGuardianDataID The id of the NewStudentEnrollmentGuardianData.\cr Run \code{\link{getAllNewStudentEnrollmentGuardianDatas}} for a list of NewStudentEnrollmentGuardianDatas.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted NewStudentEnrollmentGuardianData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteNewStudentEnrollmentGuardianData <- function(NewStudentEnrollmentGuardianDataID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "NewStudentEnrollmentGuardianData", NewStudentEnrollmentGuardianDataID, EntityID)
}
#' Get all NewStudentEnrollmentUserDatas.
#'
#' This function returns a dataframe of all NewStudentEnrollmentUserDatas 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 OnlineForm
#' @return All NewStudentEnrollmentUserDatas in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllNewStudentEnrollmentUserDatas <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnNewStudentEnrollmentUserDataID = F, returnCity = F, returnCreatedTime = F, returnEmailAddress = F, returnModifiedTime = F, returnPhoneNumber = F, returnPhysicalStreetName = F, returnPhysicalStreetNumber = F, returnPreviouslyInDistrict = F, returnState = F, returnUnit = F, returnUnitNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDSubmittedBy = F, returnZipCode = 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("OnlineForm", "NewStudentEnrollmentUserData", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific NewStudentEnrollmentUserData
#'
#' This function returns fields for a NewStudentEnrollmentUserData.
#'
#' @param NewStudentEnrollmentUserDataID The id of the NewStudentEnrollmentUserData.\cr Run \code{\link{getAllNewStudentEnrollmentUserDatas}} for a list of NewStudentEnrollmentUserDatas.
#' @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 OnlineForm
#' @return Details for the NewStudentEnrollmentUserData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getNewStudentEnrollmentUserData <- function(NewStudentEnrollmentUserDataID, EntityID = 1, returnNewStudentEnrollmentUserDataID = F, returnCity = F, returnCreatedTime = F, returnEmailAddress = F, returnModifiedTime = F, returnPhoneNumber = F, returnPhysicalStreetName = F, returnPhysicalStreetNumber = F, returnPreviouslyInDistrict = F, returnState = F, returnUnit = F, returnUnitNumber = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDSubmittedBy = F, returnZipCode = 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("OnlineForm", "NewStudentEnrollmentUserData", NewStudentEnrollmentUserDataID, searchFields, EntityID)
}
#' Modify a specific NewStudentEnrollmentUserData
#'
#' This function modifies fields for a NewStudentEnrollmentUserData.
#'
#' @param NewStudentEnrollmentUserDataID The id of the NewStudentEnrollmentUserData to be modified.\cr Run \code{\link{getAllNewStudentEnrollmentUserDatas}} for a list of NewStudentEnrollmentUserDatas.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified NewStudentEnrollmentUserData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyNewStudentEnrollmentUserData <- function(NewStudentEnrollmentUserDataID, EntityID = 1, setCity = NULL, setEmailAddress = NULL, setPhoneNumber = NULL, setPhysicalStreetName = NULL, setPhysicalStreetNumber = NULL, setPreviouslyInDistrict = NULL, setState = NULL, setUnit = NULL, setUnitNumber = NULL, setUserIDSubmittedBy = NULL, setZipCode = 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("OnlineForm", "NewStudentEnrollmentUserData", NewStudentEnrollmentUserDataID, names(functionParams), functionParams, EntityID)
}
#' Create new NewStudentEnrollmentUserData.
#'
#' This function creates a new NewStudentEnrollmentUserData.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created NewStudentEnrollmentUserData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createNewStudentEnrollmentUserData <- function(EntityID = 1, setCity = NULL, setEmailAddress = NULL, setPhoneNumber = NULL, setPhysicalStreetName = NULL, setPhysicalStreetNumber = NULL, setPreviouslyInDistrict = NULL, setState = NULL, setUnit = NULL, setUnitNumber = NULL, setUserIDSubmittedBy = NULL, setZipCode = 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("OnlineForm", "NewStudentEnrollmentUserData", names(functionParams), functionParams, EntityID)
}
#' Delete a specific NewStudentEnrollmentUserData
#'
#' This function deletes a NewStudentEnrollmentUserData.
#'
#' @param NewStudentEnrollmentUserDataID The id of the NewStudentEnrollmentUserData.\cr Run \code{\link{getAllNewStudentEnrollmentUserDatas}} for a list of NewStudentEnrollmentUserDatas.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted NewStudentEnrollmentUserData.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteNewStudentEnrollmentUserData <- function(NewStudentEnrollmentUserDataID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "NewStudentEnrollmentUserData", NewStudentEnrollmentUserDataID, EntityID)
}
#' Get all OnlineForms.
#'
#' This function returns a dataframe of all OnlineForms 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 OnlineForm
#' @return All OnlineForms in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOnlineForms <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlineFormID = F, returnActivitiesSearchConditionFilter = F, returnAdministrativeSearchConditionFilter = F, returnAllowContact = F, returnAllowMultipleFormsPerUser = F, returnContactHash = F, returnCreatedTime = F, returnCutoffTime = F, returnDescription = F, returnDisplayForNonPrimaryFamily = F, returnEmployeeSearchConditionFilter = F, returnEmployeeStandardFilterCollectionJson = F, returnEndDate = F, returnFamilySearchConditionFilter = F, returnFilter = F, returnFilterSubType = F, returnFilterSubTypeCode = F, returnHideCurrentValueOnApproval = F, returnIconCode = F, returnIncludeAdobeAcrobatLink = F, returnIncludeInActivitiesPortal = F, returnIncludeInAdministrativePortal = F, returnIncludeInEmployeePortal = F, returnIncludeInFamilyPortal = F, returnIncludeInNewStudentEnrollmentPortal = F, returnIncludeInStudentPortal = F, returnIncludeInTeacherPortal = F, returnInUseByUsers = F, returnIsPublished = F, returnIsUserInitiated = F, returnLimitToOnePerDay = F, returnMainPageEmbeddedLinkFullFilename = F, returnMainPageEmbeddedLinkProtocol = F, returnMainPageEmbeddedLinkProtocolCode = F, returnMainPageEmbeddedLinkUrl = F, returnMessage = F, returnMessageAfterSubmission = F, returnMessageForNonPrimaryFamily = F, returnModifiedTime = F, returnModule = F, returnName = F, returnNewStudentEnrollmentSearchConditionFilter = F, returnNoApprovalNeeded = F, returnObject = F, returnOnlineFormIDClonedFrom = F, returnOnlineFormStatusExistsToday = F, returnOnlineFormTypeID = F, returnPortals = F, returnPortalsIncludedIn = F, returnPortalType = F, returnPortalTypeCode = F, returnReviewStepMessage = F, returnSchoolYearID = F, returnSendFamilyAccessEmail = F, returnShowDescriptionOnTile = F, returnSkipInstructionsPage = F, returnSkipReviewPage = F, returnSkipThankYouPage = F, returnStartDate = F, returnStudentSearchConditionFilter = F, returnTeacherSearchConditionFilter = F, returnThankYouPageLinkFullFilename = F, returnThankYouPageLinkProtocol = F, returnThankYouPageLinkProtocolCode = F, returnThankYouPageLinkUrl = F, returnThankYouPageLinkUrlDisplayName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithinCutoffTime = F, returnYearType = F, returnYearTypeCode = 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("OnlineForm", "OnlineForm", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OnlineForm
#'
#' This function returns fields for an OnlineForm.
#'
#' @param OnlineFormID The id of the OnlineForm.\cr Run \code{\link{getAllOnlineForms}} for a list of OnlineForms.
#' @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 OnlineForm
#' @return Details for the OnlineForm.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOnlineForm <- function(OnlineFormID, EntityID = 1, returnOnlineFormID = F, returnActivitiesSearchConditionFilter = F, returnAdministrativeSearchConditionFilter = F, returnAllowContact = F, returnAllowMultipleFormsPerUser = F, returnContactHash = F, returnCreatedTime = F, returnCutoffTime = F, returnDescription = F, returnDisplayForNonPrimaryFamily = F, returnEmployeeSearchConditionFilter = F, returnEmployeeStandardFilterCollectionJson = F, returnEndDate = F, returnFamilySearchConditionFilter = F, returnFilter = F, returnFilterSubType = F, returnFilterSubTypeCode = F, returnHideCurrentValueOnApproval = F, returnIconCode = F, returnIncludeAdobeAcrobatLink = F, returnIncludeInActivitiesPortal = F, returnIncludeInAdministrativePortal = F, returnIncludeInEmployeePortal = F, returnIncludeInFamilyPortal = F, returnIncludeInNewStudentEnrollmentPortal = F, returnIncludeInStudentPortal = F, returnIncludeInTeacherPortal = F, returnInUseByUsers = F, returnIsPublished = F, returnIsUserInitiated = F, returnLimitToOnePerDay = F, returnMainPageEmbeddedLinkFullFilename = F, returnMainPageEmbeddedLinkProtocol = F, returnMainPageEmbeddedLinkProtocolCode = F, returnMainPageEmbeddedLinkUrl = F, returnMessage = F, returnMessageAfterSubmission = F, returnMessageForNonPrimaryFamily = F, returnModifiedTime = F, returnModule = F, returnName = F, returnNewStudentEnrollmentSearchConditionFilter = F, returnNoApprovalNeeded = F, returnObject = F, returnOnlineFormIDClonedFrom = F, returnOnlineFormStatusExistsToday = F, returnOnlineFormTypeID = F, returnPortals = F, returnPortalsIncludedIn = F, returnPortalType = F, returnPortalTypeCode = F, returnReviewStepMessage = F, returnSchoolYearID = F, returnSendFamilyAccessEmail = F, returnShowDescriptionOnTile = F, returnSkipInstructionsPage = F, returnSkipReviewPage = F, returnSkipThankYouPage = F, returnStartDate = F, returnStudentSearchConditionFilter = F, returnTeacherSearchConditionFilter = F, returnThankYouPageLinkFullFilename = F, returnThankYouPageLinkProtocol = F, returnThankYouPageLinkProtocolCode = F, returnThankYouPageLinkUrl = F, returnThankYouPageLinkUrlDisplayName = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnWithinCutoffTime = F, returnYearType = F, returnYearTypeCode = 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("OnlineForm", "OnlineForm", OnlineFormID, searchFields, EntityID)
}
#' Modify a specific OnlineForm
#'
#' This function modifies fields for an OnlineForm.
#'
#' @param OnlineFormID The id of the OnlineForm to be modified.\cr Run \code{\link{getAllOnlineForms}} for a list of OnlineForms.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified OnlineForm.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOnlineForm <- function(OnlineFormID, EntityID = 1, setActivitiesSearchConditionFilter = NULL, setAdministrativeSearchConditionFilter = NULL, setAllowContact = NULL, setAllowMultipleFormsPerUser = NULL, setCutoffTime = NULL, setDescription = NULL, setDisplayForNonPrimaryFamily = NULL, setEmployeeSearchConditionFilter = NULL, setEmployeeStandardFilterCollectionJson = NULL, setEndDate = NULL, setFamilySearchConditionFilter = NULL, setFilter = NULL, setFilterSubType = NULL, setFilterSubTypeCode = NULL, setHideCurrentValueOnApproval = NULL, setIconCode = NULL, setIncludeAdobeAcrobatLink = NULL, setIsPublished = NULL, setIsUserInitiated = NULL, setLimitToOnePerDay = NULL, setMainPageEmbeddedLinkProtocol = NULL, setMainPageEmbeddedLinkProtocolCode = NULL, setMainPageEmbeddedLinkUrl = NULL, setMessage = NULL, setMessageAfterSubmission = NULL, setMessageForNonPrimaryFamily = NULL, setName = NULL, setNewStudentEnrollmentSearchConditionFilter = NULL, setNoApprovalNeeded = NULL, setOnlineFormIDClonedFrom = NULL, setOnlineFormTypeID = NULL, setPortalType = NULL, setPortalTypeCode = NULL, setReviewStepMessage = NULL, setSchoolYearID = NULL, setSendFamilyAccessEmail = NULL, setShowDescriptionOnTile = NULL, setSkipInstructionsPage = NULL, setSkipReviewPage = NULL, setSkipThankYouPage = NULL, setStartDate = NULL, setStudentSearchConditionFilter = NULL, setTeacherSearchConditionFilter = NULL, setThankYouPageLinkProtocol = NULL, setThankYouPageLinkProtocolCode = NULL, setThankYouPageLinkUrl = NULL, setThankYouPageLinkUrlDisplayName = NULL, setYearType = NULL, setYearTypeCode = 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("OnlineForm", "OnlineForm", OnlineFormID, names(functionParams), functionParams, EntityID)
}
#' Create new OnlineForm.
#'
#' This function creates a new OnlineForm.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created OnlineForm.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOnlineForm <- function(EntityID = 1, setActivitiesSearchConditionFilter = NULL, setAdministrativeSearchConditionFilter = NULL, setAllowContact = NULL, setAllowMultipleFormsPerUser = NULL, setCutoffTime = NULL, setDescription = NULL, setDisplayForNonPrimaryFamily = NULL, setEmployeeSearchConditionFilter = NULL, setEmployeeStandardFilterCollectionJson = NULL, setEndDate = NULL, setFamilySearchConditionFilter = NULL, setFilter = NULL, setFilterSubType = NULL, setFilterSubTypeCode = NULL, setHideCurrentValueOnApproval = NULL, setIconCode = NULL, setIncludeAdobeAcrobatLink = NULL, setIsPublished = NULL, setIsUserInitiated = NULL, setLimitToOnePerDay = NULL, setMainPageEmbeddedLinkProtocol = NULL, setMainPageEmbeddedLinkProtocolCode = NULL, setMainPageEmbeddedLinkUrl = NULL, setMessage = NULL, setMessageAfterSubmission = NULL, setMessageForNonPrimaryFamily = NULL, setName = NULL, setNewStudentEnrollmentSearchConditionFilter = NULL, setNoApprovalNeeded = NULL, setOnlineFormIDClonedFrom = NULL, setOnlineFormTypeID = NULL, setPortalType = NULL, setPortalTypeCode = NULL, setReviewStepMessage = NULL, setSchoolYearID = NULL, setSendFamilyAccessEmail = NULL, setShowDescriptionOnTile = NULL, setSkipInstructionsPage = NULL, setSkipReviewPage = NULL, setSkipThankYouPage = NULL, setStartDate = NULL, setStudentSearchConditionFilter = NULL, setTeacherSearchConditionFilter = NULL, setThankYouPageLinkProtocol = NULL, setThankYouPageLinkProtocolCode = NULL, setThankYouPageLinkUrl = NULL, setThankYouPageLinkUrlDisplayName = NULL, setYearType = NULL, setYearTypeCode = 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("OnlineForm", "OnlineForm", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OnlineForm
#'
#' This function deletes an OnlineForm.
#'
#' @param OnlineFormID The id of the OnlineForm.\cr Run \code{\link{getAllOnlineForms}} for a list of OnlineForms.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted OnlineForm.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOnlineForm <- function(OnlineFormID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "OnlineForm", OnlineFormID, EntityID)
}
#' Get all OnlineFormClearances.
#'
#' This function returns a dataframe of all OnlineFormClearances 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 OnlineForm
#' @return All OnlineFormClearances in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOnlineFormClearances <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlineFormClearanceID = F, returnCreatedTime = F, returnGroupIDSecurity = F, returnModifiedTime = F, returnOnlineFormID = 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("OnlineForm", "OnlineFormClearance", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OnlineFormClearance
#'
#' This function returns fields for an OnlineFormClearance.
#'
#' @param OnlineFormClearanceID The id of the OnlineFormClearance.\cr Run \code{\link{getAllOnlineFormClearances}} for a list of OnlineFormClearances.
#' @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 OnlineForm
#' @return Details for the OnlineFormClearance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOnlineFormClearance <- function(OnlineFormClearanceID, EntityID = 1, returnOnlineFormClearanceID = F, returnCreatedTime = F, returnGroupIDSecurity = F, returnModifiedTime = F, returnOnlineFormID = 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("OnlineForm", "OnlineFormClearance", OnlineFormClearanceID, searchFields, EntityID)
}
#' Modify a specific OnlineFormClearance
#'
#' This function modifies fields for an OnlineFormClearance.
#'
#' @param OnlineFormClearanceID The id of the OnlineFormClearance to be modified.\cr Run \code{\link{getAllOnlineFormClearances}} for a list of OnlineFormClearances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified OnlineFormClearance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOnlineFormClearance <- function(OnlineFormClearanceID, EntityID = 1, setGroupIDSecurity = NULL, setOnlineFormID = 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("OnlineForm", "OnlineFormClearance", OnlineFormClearanceID, names(functionParams), functionParams, EntityID)
}
#' Create new OnlineFormClearance.
#'
#' This function creates a new OnlineFormClearance.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created OnlineFormClearance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOnlineFormClearance <- function(EntityID = 1, setGroupIDSecurity = NULL, setOnlineFormID = 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("OnlineForm", "OnlineFormClearance", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OnlineFormClearance
#'
#' This function deletes an OnlineFormClearance.
#'
#' @param OnlineFormClearanceID The id of the OnlineFormClearance.\cr Run \code{\link{getAllOnlineFormClearances}} for a list of OnlineFormClearances.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted OnlineFormClearance.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOnlineFormClearance <- function(OnlineFormClearanceID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "OnlineFormClearance", OnlineFormClearanceID, EntityID)
}
#' Get all OnlineFormDateExceptions.
#'
#' This function returns a dataframe of all OnlineFormDateExceptions 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 OnlineForm
#' @return All OnlineFormDateExceptions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOnlineFormDateExceptions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlineFormDateExceptionID = F, returnCreatedTime = F, returnModifiedTime = F, returnObjectID = F, returnObjectPrimaryKey = F, returnOnlineFormID = 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("OnlineForm", "OnlineFormDateException", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OnlineFormDateException
#'
#' This function returns fields for an OnlineFormDateException.
#'
#' @param OnlineFormDateExceptionID The id of the OnlineFormDateException.\cr Run \code{\link{getAllOnlineFormDateExceptions}} for a list of OnlineFormDateExceptions.
#' @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 OnlineForm
#' @return Details for the OnlineFormDateException.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOnlineFormDateException <- function(OnlineFormDateExceptionID, EntityID = 1, returnOnlineFormDateExceptionID = F, returnCreatedTime = F, returnModifiedTime = F, returnObjectID = F, returnObjectPrimaryKey = F, returnOnlineFormID = 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("OnlineForm", "OnlineFormDateException", OnlineFormDateExceptionID, searchFields, EntityID)
}
#' Modify a specific OnlineFormDateException
#'
#' This function modifies fields for an OnlineFormDateException.
#'
#' @param OnlineFormDateExceptionID The id of the OnlineFormDateException to be modified.\cr Run \code{\link{getAllOnlineFormDateExceptions}} for a list of OnlineFormDateExceptions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified OnlineFormDateException.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOnlineFormDateException <- function(OnlineFormDateExceptionID, EntityID = 1, setObjectID = NULL, setObjectPrimaryKey = NULL, setOnlineFormID = 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("OnlineForm", "OnlineFormDateException", OnlineFormDateExceptionID, names(functionParams), functionParams, EntityID)
}
#' Create new OnlineFormDateException.
#'
#' This function creates a new OnlineFormDateException.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created OnlineFormDateException.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOnlineFormDateException <- function(EntityID = 1, setObjectID = NULL, setObjectPrimaryKey = NULL, setOnlineFormID = 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("OnlineForm", "OnlineFormDateException", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OnlineFormDateException
#'
#' This function deletes an OnlineFormDateException.
#'
#' @param OnlineFormDateExceptionID The id of the OnlineFormDateException.\cr Run \code{\link{getAllOnlineFormDateExceptions}} for a list of OnlineFormDateExceptions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted OnlineFormDateException.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOnlineFormDateException <- function(OnlineFormDateExceptionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "OnlineFormDateException", OnlineFormDateExceptionID, EntityID)
}
#' Get all OnlineFormEntities.
#'
#' This function returns a dataframe of all OnlineFormEntities 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 OnlineForm
#' @return All OnlineFormEntities in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOnlineFormEntities <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlineFormEntityID = F, returnCreatedTime = F, returnEntityID = F, returnModifiedTime = F, returnOnlineFormID = 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("OnlineForm", "OnlineFormEntity", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OnlineFormEntity
#'
#' This function returns fields for an OnlineFormEntity.
#'
#' @param OnlineFormEntityID The id of the OnlineFormEntity.\cr Run \code{\link{getAllOnlineFormEntities}} for a list of OnlineFormEntities.
#' @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 OnlineForm
#' @return Details for the OnlineFormEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOnlineFormEntity <- function(OnlineFormEntityID, EntityID = 1, returnOnlineFormEntityID = F, returnCreatedTime = F, returnEntityID = F, returnModifiedTime = F, returnOnlineFormID = 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("OnlineForm", "OnlineFormEntity", OnlineFormEntityID, searchFields, EntityID)
}
#' Modify a specific OnlineFormEntity
#'
#' This function modifies fields for an OnlineFormEntity.
#'
#' @param OnlineFormEntityID The id of the OnlineFormEntity to be modified.\cr Run \code{\link{getAllOnlineFormEntities}} for a list of OnlineFormEntitys.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified OnlineFormEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOnlineFormEntity <- function(OnlineFormEntityID, EntityID = 1, setEntityID = NULL, setOnlineFormID = 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("OnlineForm", "OnlineFormEntity", OnlineFormEntityID, names(functionParams), functionParams, EntityID)
}
#' Create new OnlineFormEntity.
#'
#' This function creates a new OnlineFormEntity.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created OnlineFormEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOnlineFormEntity <- function(EntityID = 1, setEntityID = NULL, setOnlineFormID = 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("OnlineForm", "OnlineFormEntity", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OnlineFormEntity
#'
#' This function deletes an OnlineFormEntity.
#'
#' @param OnlineFormEntityID The id of the OnlineFormEntity.\cr Run \code{\link{getAllOnlineFormEntities}} for a list of OnlineFormEntities.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted OnlineFormEntity.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOnlineFormEntity <- function(OnlineFormEntityID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "OnlineFormEntity", OnlineFormEntityID, EntityID)
}
#' Get all OnlineFormStatuses.
#'
#' This function returns a dataframe of all OnlineFormStatuses 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 OnlineForm
#' @return All OnlineFormStatuses in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOnlineFormStatuses <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlineFormStatusID = F, returnApprovalRevoked = F, returnCompletedByAdmin = F, returnCreatedTime = F, returnDenialDateTime = F, returnDenialMessage = F, returnFullNameLFMSubmittedFor = F, returnFullNameLFMSubmittedForOverride = F, returnIsOutsideAddressRanges = F, returnIsOutsideAddressRangeSchoolPaths = F, returnModifiedTime = F, returnNameID = F, returnOnlineFormEntityID = F, returnSecondaryID = F, returnStatusType = F, returnStatusTypeCode = F, returnSubmittedDateTime = F, returnUserIDApprover = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDSubmittedBy = F, returnWithinCutoffTime = 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("OnlineForm", "OnlineFormStatus", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OnlineFormStatus
#'
#' This function returns fields for an OnlineFormStatus.
#'
#' @param OnlineFormStatusID The id of the OnlineFormStatus.\cr Run \code{\link{getAllOnlineFormStatuses}} for a list of OnlineFormStatuses.
#' @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 OnlineForm
#' @return Details for the OnlineFormStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOnlineFormStatus <- function(OnlineFormStatusID, EntityID = 1, returnOnlineFormStatusID = F, returnApprovalRevoked = F, returnCompletedByAdmin = F, returnCreatedTime = F, returnDenialDateTime = F, returnDenialMessage = F, returnFullNameLFMSubmittedFor = F, returnFullNameLFMSubmittedForOverride = F, returnIsOutsideAddressRanges = F, returnIsOutsideAddressRangeSchoolPaths = F, returnModifiedTime = F, returnNameID = F, returnOnlineFormEntityID = F, returnSecondaryID = F, returnStatusType = F, returnStatusTypeCode = F, returnSubmittedDateTime = F, returnUserIDApprover = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnUserIDSubmittedBy = F, returnWithinCutoffTime = 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("OnlineForm", "OnlineFormStatus", OnlineFormStatusID, searchFields, EntityID)
}
#' Modify a specific OnlineFormStatus
#'
#' This function modifies fields for an OnlineFormStatus.
#'
#' @param OnlineFormStatusID The id of the OnlineFormStatus to be modified.\cr Run \code{\link{getAllOnlineFormStatuses}} for a list of OnlineFormStatus.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified OnlineFormStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOnlineFormStatus <- function(OnlineFormStatusID, EntityID = 1, setApprovalRevoked = NULL, setCompletedByAdmin = NULL, setDenialDateTime = NULL, setDenialMessage = NULL, setFullNameLFMSubmittedForOverride = NULL, setIsOutsideAddressRanges = NULL, setIsOutsideAddressRangeSchoolPaths = NULL, setNameID = NULL, setOnlineFormEntityID = NULL, setSecondaryID = NULL, setStatusType = NULL, setStatusTypeCode = NULL, setSubmittedDateTime = NULL, setUserIDApprover = NULL, setUserIDSubmittedBy = 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("OnlineForm", "OnlineFormStatus", OnlineFormStatusID, names(functionParams), functionParams, EntityID)
}
#' Create new OnlineFormStatus.
#'
#' This function creates a new OnlineFormStatus.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created OnlineFormStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOnlineFormStatus <- function(EntityID = 1, setApprovalRevoked = NULL, setCompletedByAdmin = NULL, setDenialDateTime = NULL, setDenialMessage = NULL, setFullNameLFMSubmittedForOverride = NULL, setIsOutsideAddressRanges = NULL, setIsOutsideAddressRangeSchoolPaths = NULL, setNameID = NULL, setOnlineFormEntityID = NULL, setSecondaryID = NULL, setStatusType = NULL, setStatusTypeCode = NULL, setSubmittedDateTime = NULL, setUserIDApprover = NULL, setUserIDSubmittedBy = 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("OnlineForm", "OnlineFormStatus", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OnlineFormStatus
#'
#' This function deletes an OnlineFormStatus.
#'
#' @param OnlineFormStatusID The id of the OnlineFormStatus.\cr Run \code{\link{getAllOnlineFormStatuses}} for a list of OnlineFormStatuses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted OnlineFormStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOnlineFormStatus <- function(OnlineFormStatusID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "OnlineFormStatus", OnlineFormStatusID, EntityID)
}
#' Get all OnlineFormStatusNames.
#'
#' This function returns a dataframe of all OnlineFormStatusNames 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 OnlineForm
#' @return All OnlineFormStatusNames in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOnlineFormStatusNames <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlineFormStatusNameID = F, returnCreatedTime = F, returnElementID = F, returnModifiedTime = F, returnNameID = F, returnOnlineFormStatusID = 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("OnlineForm", "OnlineFormStatusName", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OnlineFormStatusName
#'
#' This function returns fields for an OnlineFormStatusName.
#'
#' @param OnlineFormStatusNameID The id of the OnlineFormStatusName.\cr Run \code{\link{getAllOnlineFormStatusNames}} for a list of OnlineFormStatusNames.
#' @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 OnlineForm
#' @return Details for the OnlineFormStatusName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOnlineFormStatusName <- function(OnlineFormStatusNameID, EntityID = 1, returnOnlineFormStatusNameID = F, returnCreatedTime = F, returnElementID = F, returnModifiedTime = F, returnNameID = F, returnOnlineFormStatusID = 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("OnlineForm", "OnlineFormStatusName", OnlineFormStatusNameID, searchFields, EntityID)
}
#' Modify a specific OnlineFormStatusName
#'
#' This function modifies fields for an OnlineFormStatusName.
#'
#' @param OnlineFormStatusNameID The id of the OnlineFormStatusName to be modified.\cr Run \code{\link{getAllOnlineFormStatusNames}} for a list of OnlineFormStatusNames.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified OnlineFormStatusName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOnlineFormStatusName <- function(OnlineFormStatusNameID, EntityID = 1, setElementID = NULL, setNameID = NULL, setOnlineFormStatusID = 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("OnlineForm", "OnlineFormStatusName", OnlineFormStatusNameID, names(functionParams), functionParams, EntityID)
}
#' Create new OnlineFormStatusName.
#'
#' This function creates a new OnlineFormStatusName.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created OnlineFormStatusName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOnlineFormStatusName <- function(EntityID = 1, setElementID = NULL, setNameID = NULL, setOnlineFormStatusID = 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("OnlineForm", "OnlineFormStatusName", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OnlineFormStatusName
#'
#' This function deletes an OnlineFormStatusName.
#'
#' @param OnlineFormStatusNameID The id of the OnlineFormStatusName.\cr Run \code{\link{getAllOnlineFormStatusNames}} for a list of OnlineFormStatusNames.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted OnlineFormStatusName.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOnlineFormStatusName <- function(OnlineFormStatusNameID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "OnlineFormStatusName", OnlineFormStatusNameID, EntityID)
}
#' Get all OnlineFormTypes.
#'
#' This function returns a dataframe of all OnlineFormTypes 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 OnlineForm
#' @return All OnlineFormTypes in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllOnlineFormTypes <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlineFormTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnLimitUsersToOneFormOfThisTypePerYear = 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("OnlineForm", "OnlineFormType", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific OnlineFormType
#'
#' This function returns fields for an OnlineFormType.
#'
#' @param OnlineFormTypeID The id of the OnlineFormType.\cr Run \code{\link{getAllOnlineFormTypes}} for a list of OnlineFormTypes.
#' @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 OnlineForm
#' @return Details for the OnlineFormType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getOnlineFormType <- function(OnlineFormTypeID, EntityID = 1, returnOnlineFormTypeID = F, returnCode = F, returnCodeDescription = F, returnCreatedTime = F, returnDescription = F, returnDistrictID = F, returnLimitUsersToOneFormOfThisTypePerYear = 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("OnlineForm", "OnlineFormType", OnlineFormTypeID, searchFields, EntityID)
}
#' Modify a specific OnlineFormType
#'
#' This function modifies fields for an OnlineFormType.
#'
#' @param OnlineFormTypeID The id of the OnlineFormType to be modified.\cr Run \code{\link{getAllOnlineFormTypes}} for a list of OnlineFormTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified OnlineFormType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyOnlineFormType <- function(OnlineFormTypeID, EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setLimitUsersToOneFormOfThisTypePerYear = 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("OnlineForm", "OnlineFormType", OnlineFormTypeID, names(functionParams), functionParams, EntityID)
}
#' Create new OnlineFormType.
#'
#' This function creates a new OnlineFormType.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created OnlineFormType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createOnlineFormType <- function(EntityID = 1, setCode = NULL, setDescription = NULL, setDistrictID = NULL, setLimitUsersToOneFormOfThisTypePerYear = 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("OnlineForm", "OnlineFormType", names(functionParams), functionParams, EntityID)
}
#' Delete a specific OnlineFormType
#'
#' This function deletes an OnlineFormType.
#'
#' @param OnlineFormTypeID The id of the OnlineFormType.\cr Run \code{\link{getAllOnlineFormTypes}} for a list of OnlineFormTypes.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted OnlineFormType.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteOnlineFormType <- function(OnlineFormTypeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "OnlineFormType", OnlineFormTypeID, EntityID)
}
#' Get all SharedElementStatuses.
#'
#' This function returns a dataframe of all SharedElementStatuses 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 OnlineForm
#' @return All SharedElementStatuses in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSharedElementStatuses <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnSharedElementStatusID = F, returnCreatedTime = F, returnElementType = F, returnElementTypeCode = F, returnFieldGroupType = F, returnFieldGroupTypeCode = F, returnMediaIDAttachment = F, returnModifiedTime = F, returnNameID = F, returnSchoolYearID = F, returnSecondaryID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValue = 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("OnlineForm", "SharedElementStatus", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific SharedElementStatus
#'
#' This function returns fields for a SharedElementStatus.
#'
#' @param SharedElementStatusID The id of the SharedElementStatus.\cr Run \code{\link{getAllSharedElementStatuses}} for a list of SharedElementStatuses.
#' @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 OnlineForm
#' @return Details for the SharedElementStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getSharedElementStatus <- function(SharedElementStatusID, EntityID = 1, returnSharedElementStatusID = F, returnCreatedTime = F, returnElementType = F, returnElementTypeCode = F, returnFieldGroupType = F, returnFieldGroupTypeCode = F, returnMediaIDAttachment = F, returnModifiedTime = F, returnNameID = F, returnSchoolYearID = F, returnSecondaryID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValue = 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("OnlineForm", "SharedElementStatus", SharedElementStatusID, searchFields, EntityID)
}
#' Modify a specific SharedElementStatus
#'
#' This function modifies fields for a SharedElementStatus.
#'
#' @param SharedElementStatusID The id of the SharedElementStatus to be modified.\cr Run \code{\link{getAllSharedElementStatuses}} for a list of SharedElementStatus.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified SharedElementStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifySharedElementStatus <- function(SharedElementStatusID, EntityID = 1, setElementType = NULL, setElementTypeCode = NULL, setFieldGroupType = NULL, setFieldGroupTypeCode = NULL, setMediaIDAttachment = NULL, setNameID = NULL, setSchoolYearID = NULL, setSecondaryID = NULL, setValue = 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("OnlineForm", "SharedElementStatus", SharedElementStatusID, names(functionParams), functionParams, EntityID)
}
#' Create new SharedElementStatus.
#'
#' This function creates a new SharedElementStatus.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created SharedElementStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createSharedElementStatus <- function(EntityID = 1, setElementType = NULL, setElementTypeCode = NULL, setFieldGroupType = NULL, setFieldGroupTypeCode = NULL, setMediaIDAttachment = NULL, setNameID = NULL, setSchoolYearID = NULL, setSecondaryID = NULL, setValue = 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("OnlineForm", "SharedElementStatus", names(functionParams), functionParams, EntityID)
}
#' Delete a specific SharedElementStatus
#'
#' This function deletes a SharedElementStatus.
#'
#' @param SharedElementStatusID The id of the SharedElementStatus.\cr Run \code{\link{getAllSharedElementStatuses}} for a list of SharedElementStatuses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted SharedElementStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteSharedElementStatus <- function(SharedElementStatusID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "SharedElementStatus", SharedElementStatusID, EntityID)
}
#' Get all StaffContacts.
#'
#' This function returns a dataframe of all StaffContacts 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 OnlineForm
#' @return All StaffContacts in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStaffContacts <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStaffContactID = F, returnCreatedTime = F, returnModifiedTime = F, returnOnlineFormID = F, returnStaffID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getAllDataObjectsForObject("OnlineForm", "StaffContact", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StaffContact
#'
#' This function returns fields for a StaffContact.
#'
#' @param StaffContactID The id of the StaffContact.\cr Run \code{\link{getAllStaffContacts}} for a list of StaffContacts.
#' @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 OnlineForm
#' @return Details for the StaffContact.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStaffContact <- function(StaffContactID, EntityID = 1, returnStaffContactID = F, returnCreatedTime = F, returnModifiedTime = F, returnOnlineFormID = F, returnStaffID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
searchFields <- names(functionParams)[(unlist(lapply(functionParams, function(x) ifelse(length(x) == 1, x == T, F)))) & (names(functionParams) %>% stringr::str_detect("^return"))]
if(length(searchFields) == 0) searchFields <- names(functionParams)[names(functionParams) %>% stringr::str_detect("^return")]
searchFields <- searchFields %>% stringr::str_replace("return", "")
getDataObject("OnlineForm", "StaffContact", StaffContactID, searchFields, EntityID)
}
#' Modify a specific StaffContact
#'
#' This function modifies fields for a StaffContact.
#'
#' @param StaffContactID The id of the StaffContact to be modified.\cr Run \code{\link{getAllStaffContacts}} for a list of StaffContacts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified StaffContact.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStaffContact <- function(StaffContactID, EntityID = 1, setOnlineFormID = NULL, setStaffID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-(1:2)]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
modifyDataObject("OnlineForm", "StaffContact", StaffContactID, names(functionParams), functionParams, EntityID)
}
#' Create new StaffContact.
#'
#' This function creates a new StaffContact.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created StaffContact.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStaffContact <- function(EntityID = 1, setOnlineFormID = NULL, setStaffID = NULL){
suppressMessages(suppressWarnings(require(dplyr)))
functionParams <- as.list(environment())[-1]
functionParams <- functionParams[which(unlist(lapply(functionParams, function(x) length(x) > 0)))]
names(functionParams) <- names(functionParams) %>% stringr::str_replace("set", "")
createDataObject("OnlineForm", "StaffContact", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StaffContact
#'
#' This function deletes a StaffContact.
#'
#' @param StaffContactID The id of the StaffContact.\cr Run \code{\link{getAllStaffContacts}} for a list of StaffContacts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted StaffContact.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStaffContact <- function(StaffContactID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "StaffContact", StaffContactID, EntityID)
}
#' Get all Steps.
#'
#' This function returns a dataframe of all Steps 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 OnlineForm
#' @return All Steps in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllSteps <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStepID = F, returnCreatedTime = F, returnIsActive = F, returnIsReadOnlyForNonPrimaryFamily = F, returnIsRequired = F, returnMessage = F, returnModifiedTime = F, returnName = F, returnOnlineFormID = F, returnOrder = 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("OnlineForm", "Step", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific Step
#'
#' This function returns fields for a Step.
#'
#' @param StepID The id of the Step.\cr Run \code{\link{getAllSteps}} for a list of Steps.
#' @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 OnlineForm
#' @return Details for the Step.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStep <- function(StepID, EntityID = 1, returnStepID = F, returnCreatedTime = F, returnIsActive = F, returnIsReadOnlyForNonPrimaryFamily = F, returnIsRequired = F, returnMessage = F, returnModifiedTime = F, returnName = F, returnOnlineFormID = F, returnOrder = 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("OnlineForm", "Step", StepID, searchFields, EntityID)
}
#' Modify a specific Step
#'
#' This function modifies fields for a Step.
#'
#' @param StepID The id of the Step to be modified.\cr Run \code{\link{getAllSteps}} for a list of Steps.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified Step.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStep <- function(StepID, EntityID = 1, setIsActive = NULL, setIsReadOnlyForNonPrimaryFamily = NULL, setIsRequired = NULL, setMessage = NULL, setName = NULL, setOnlineFormID = NULL, setOrder = 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("OnlineForm", "Step", StepID, names(functionParams), functionParams, EntityID)
}
#' Create new Step.
#'
#' This function creates a new Step.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created Step.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStep <- function(EntityID = 1, setIsActive = NULL, setIsReadOnlyForNonPrimaryFamily = NULL, setIsRequired = NULL, setMessage = NULL, setName = NULL, setOnlineFormID = NULL, setOrder = 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("OnlineForm", "Step", names(functionParams), functionParams, EntityID)
}
#' Delete a specific Step
#'
#' This function deletes a Step.
#'
#' @param StepID The id of the Step.\cr Run \code{\link{getAllSteps}} for a list of Steps.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted Step.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStep <- function(StepID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "Step", StepID, EntityID)
}
#' Get all StepStatuses.
#'
#' This function returns a dataframe of all StepStatuses 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 OnlineForm
#' @return All StepStatuses in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllStepStatuses <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnStepStatusID = F, returnCreatedTime = F, returnDenialMessage = F, returnHasNextStepStatus = F, returnHasPreviousStepStatus = F, returnModifiedTime = F, returnNextStepStatusID = F, returnOnlineFormStatusID = F, returnPreviousStepStatusID = F, returnStatusType = F, returnStatusTypeCode = F, returnStepID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValidationMessage = 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("OnlineForm", "StepStatus", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific StepStatus
#'
#' This function returns fields for a StepStatus.
#'
#' @param StepStatusID The id of the StepStatus.\cr Run \code{\link{getAllStepStatuses}} for a list of StepStatuses.
#' @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 OnlineForm
#' @return Details for the StepStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getStepStatus <- function(StepStatusID, EntityID = 1, returnStepStatusID = F, returnCreatedTime = F, returnDenialMessage = F, returnHasNextStepStatus = F, returnHasPreviousStepStatus = F, returnModifiedTime = F, returnNextStepStatusID = F, returnOnlineFormStatusID = F, returnPreviousStepStatusID = F, returnStatusType = F, returnStatusTypeCode = F, returnStepID = F, returnUserIDCreatedBy = F, returnUserIDModifiedBy = F, returnValidationMessage = 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("OnlineForm", "StepStatus", StepStatusID, searchFields, EntityID)
}
#' Modify a specific StepStatus
#'
#' This function modifies fields for a StepStatus.
#'
#' @param StepStatusID The id of the StepStatus to be modified.\cr Run \code{\link{getAllStepStatuses}} for a list of StepStatus.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified StepStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyStepStatus <- function(StepStatusID, EntityID = 1, setDenialMessage = NULL, setOnlineFormStatusID = NULL, setStatusType = NULL, setStatusTypeCode = NULL, setStepID = NULL, setValidationMessage = 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("OnlineForm", "StepStatus", StepStatusID, names(functionParams), functionParams, EntityID)
}
#' Create new StepStatus.
#'
#' This function creates a new StepStatus.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created StepStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createStepStatus <- function(EntityID = 1, setDenialMessage = NULL, setOnlineFormStatusID = NULL, setStatusType = NULL, setStatusTypeCode = NULL, setStepID = NULL, setValidationMessage = 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("OnlineForm", "StepStatus", names(functionParams), functionParams, EntityID)
}
#' Delete a specific StepStatus
#'
#' This function deletes a StepStatus.
#'
#' @param StepStatusID The id of the StepStatus.\cr Run \code{\link{getAllStepStatuses}} for a list of StepStatuses.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted StepStatus.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteStepStatus <- function(StepStatusID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "StepStatus", StepStatusID, EntityID)
}
#' Get all TeacherOnlineForms.
#'
#' This function returns a dataframe of all TeacherOnlineForms 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 OnlineForm
#' @return All TeacherOnlineForms in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTeacherOnlineForms <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnOnlineFormEntityID = F, returnCreatedTime = F, returnDisplayPeriodID = F, returnEntityID = F, returnFilterInformation = F, returnModifiedTime = F, returnNameID = F, returnNoFormsExistOfSameType = F, returnNoStartedFormsExist = F, returnOnlineFormID = F, returnOnlineFormStatusExistsToday = F, returnOnlineFormStatusID = F, returnOnlineFormTypeID = F, returnSchoolYearID = F, returnSecondaryID = F, returnSectionID = F, returnStatusType = F, returnStatusTypeCode = F, returnStatusTypeSortable = 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("OnlineForm", "TeacherOnlineForm", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TeacherOnlineForm
#'
#' This function returns fields for a TeacherOnlineForm.
#'
#' @param TeacherOnlineFormID The id of the TeacherOnlineForm.\cr Run \code{\link{getAllTeacherOnlineForms}} for a list of TeacherOnlineForms.
#' @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 OnlineForm
#' @return Details for the TeacherOnlineForm.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTeacherOnlineForm <- function(TeacherOnlineFormID, EntityID = 1, returnOnlineFormEntityID = F, returnCreatedTime = F, returnDisplayPeriodID = F, returnEntityID = F, returnFilterInformation = F, returnModifiedTime = F, returnNameID = F, returnNoFormsExistOfSameType = F, returnNoStartedFormsExist = F, returnOnlineFormID = F, returnOnlineFormStatusExistsToday = F, returnOnlineFormStatusID = F, returnOnlineFormTypeID = F, returnSchoolYearID = F, returnSecondaryID = F, returnSectionID = F, returnStatusType = F, returnStatusTypeCode = F, returnStatusTypeSortable = 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("OnlineForm", "TeacherOnlineForm", TeacherOnlineFormID, searchFields, EntityID)
}
#' Modify a specific TeacherOnlineForm
#'
#' This function modifies fields for a TeacherOnlineForm.
#'
#' @param TeacherOnlineFormID The id of the TeacherOnlineForm to be modified.\cr Run \code{\link{getAllTeacherOnlineForms}} for a list of TeacherOnlineForms.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TeacherOnlineForm.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTeacherOnlineForm <- function(TeacherOnlineFormID, EntityID = 1, setStatusType = NULL, setStatusTypeCode = 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("OnlineForm", "TeacherOnlineForm", TeacherOnlineFormID, names(functionParams), functionParams, EntityID)
}
#' Create new TeacherOnlineForm.
#'
#' This function creates a new TeacherOnlineForm.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TeacherOnlineForm.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTeacherOnlineForm <- function(EntityID = 1, setStatusType = NULL, setStatusTypeCode = 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("OnlineForm", "TeacherOnlineForm", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TeacherOnlineForm
#'
#' This function deletes a TeacherOnlineForm.
#'
#' @param TeacherOnlineFormID The id of the TeacherOnlineForm.\cr Run \code{\link{getAllTeacherOnlineForms}} for a list of TeacherOnlineForms.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TeacherOnlineForm.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTeacherOnlineForm <- function(TeacherOnlineFormID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TeacherOnlineForm", TeacherOnlineFormID, EntityID)
}
#' Get all TempCertifications.
#'
#' This function returns a dataframe of all TempCertifications 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 OnlineForm
#' @return All TempCertifications in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempCertificationsOnlineForm <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempCertificationID = F, returnCertificationID = F, returnCertificationNumber = F, returnCertificationTypeID = F, returnCreatedTime = F, returnEmployeeID = F, returnExpirationDate = F, returnInstitutionID = F, returnIsDelete = F, returnIssueDate = F, returnModifiedTime = F, returnOnScreenCount = F, returnStateID = 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("OnlineForm", "TempCertification", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempCertification
#'
#' This function returns fields for a TempCertification.
#'
#' @param TempCertificationID The id of the TempCertification.\cr Run \code{\link{getAllTempCertifications}} for a list of TempCertifications.
#' @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 OnlineForm
#' @return Details for the TempCertification.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempCertificationOnlineForm <- function(TempCertificationID, EntityID = 1, returnTempCertificationID = F, returnCertificationID = F, returnCertificationNumber = F, returnCertificationTypeID = F, returnCreatedTime = F, returnEmployeeID = F, returnExpirationDate = F, returnInstitutionID = F, returnIsDelete = F, returnIssueDate = F, returnModifiedTime = F, returnOnScreenCount = F, returnStateID = 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("OnlineForm", "TempCertification", TempCertificationID, searchFields, EntityID)
}
#' Modify a specific TempCertification
#'
#' This function modifies fields for a TempCertification.
#'
#' @param TempCertificationID The id of the TempCertification to be modified.\cr Run \code{\link{getAllTempCertifications}} for a list of TempCertifications.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempCertification.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempCertificationOnlineForm <- function(TempCertificationID, EntityID = 1, setCertificationID = NULL, setCertificationNumber = NULL, setCertificationTypeID = NULL, setEmployeeID = NULL, setExpirationDate = NULL, setInstitutionID = NULL, setIsDelete = NULL, setIssueDate = NULL, setOnScreenCount = NULL, setStateID = 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("OnlineForm", "TempCertification", TempCertificationID, names(functionParams), functionParams, EntityID)
}
#' Create new TempCertification.
#'
#' This function creates a new TempCertification.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempCertification.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempCertificationOnlineForm <- function(EntityID = 1, setCertificationID = NULL, setCertificationNumber = NULL, setCertificationTypeID = NULL, setEmployeeID = NULL, setExpirationDate = NULL, setInstitutionID = NULL, setIsDelete = NULL, setIssueDate = NULL, setOnScreenCount = NULL, setStateID = 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("OnlineForm", "TempCertification", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempCertification
#'
#' This function deletes a TempCertification.
#'
#' @param TempCertificationID The id of the TempCertification.\cr Run \code{\link{getAllTempCertifications}} for a list of TempCertifications.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempCertification.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempCertificationOnlineForm <- function(TempCertificationID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempCertification", TempCertificationID, EntityID)
}
#' Get all TempDataGridRows.
#'
#' This function returns a dataframe of all TempDataGridRows 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 OnlineForm
#' @return All TempDataGridRows in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempDataGridRows <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempDataGridRowID = F, returnColumnHeader = F, returnControlType = F, returnControlTypeCode = F, returnCreatedTime = F, returnDefaultValue = F, returnModifiedTime = F, returnOptions = 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("OnlineForm", "TempDataGridRow", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempDataGridRow
#'
#' This function returns fields for a TempDataGridRow.
#'
#' @param TempDataGridRowID The id of the TempDataGridRow.\cr Run \code{\link{getAllTempDataGridRows}} for a list of TempDataGridRows.
#' @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 OnlineForm
#' @return Details for the TempDataGridRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempDataGridRow <- function(TempDataGridRowID, EntityID = 1, returnTempDataGridRowID = F, returnColumnHeader = F, returnControlType = F, returnControlTypeCode = F, returnCreatedTime = F, returnDefaultValue = F, returnModifiedTime = F, returnOptions = 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("OnlineForm", "TempDataGridRow", TempDataGridRowID, searchFields, EntityID)
}
#' Modify a specific TempDataGridRow
#'
#' This function modifies fields for a TempDataGridRow.
#'
#' @param TempDataGridRowID The id of the TempDataGridRow to be modified.\cr Run \code{\link{getAllTempDataGridRows}} for a list of TempDataGridRows.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempDataGridRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempDataGridRow <- function(TempDataGridRowID, EntityID = 1, setColumnHeader = NULL, setControlType = NULL, setControlTypeCode = NULL, setDefaultValue = NULL, setOptions = 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("OnlineForm", "TempDataGridRow", TempDataGridRowID, names(functionParams), functionParams, EntityID)
}
#' Create new TempDataGridRow.
#'
#' This function creates a new TempDataGridRow.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempDataGridRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempDataGridRow <- function(EntityID = 1, setColumnHeader = NULL, setControlType = NULL, setControlTypeCode = NULL, setDefaultValue = NULL, setOptions = 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("OnlineForm", "TempDataGridRow", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempDataGridRow
#'
#' This function deletes a TempDataGridRow.
#'
#' @param TempDataGridRowID The id of the TempDataGridRow.\cr Run \code{\link{getAllTempDataGridRows}} for a list of TempDataGridRows.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempDataGridRow.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempDataGridRow <- function(TempDataGridRowID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempDataGridRow", TempDataGridRowID, EntityID)
}
#' Get all TempDegrees.
#'
#' This function returns a dataframe of all TempDegrees 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 OnlineForm
#' @return All TempDegrees in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempDegrees <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempDegreeID = F, returnAdditionalCredits = F, returnApprovedDate = F, returnCreatedTime = F, returnCredits = F, returnDegreeID = F, returnDegreeTypeID = F, returnEmployeeID = F, returnGPA = F, returnInstitutionID = F, returnIsDelete = F, returnModifiedTime = F, returnOnScreenCount = F, returnReceivedDate = 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("OnlineForm", "TempDegree", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempDegree
#'
#' This function returns fields for a TempDegree.
#'
#' @param TempDegreeID The id of the TempDegree.\cr Run \code{\link{getAllTempDegrees}} for a list of TempDegrees.
#' @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 OnlineForm
#' @return Details for the TempDegree.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempDegree <- function(TempDegreeID, EntityID = 1, returnTempDegreeID = F, returnAdditionalCredits = F, returnApprovedDate = F, returnCreatedTime = F, returnCredits = F, returnDegreeID = F, returnDegreeTypeID = F, returnEmployeeID = F, returnGPA = F, returnInstitutionID = F, returnIsDelete = F, returnModifiedTime = F, returnOnScreenCount = F, returnReceivedDate = 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("OnlineForm", "TempDegree", TempDegreeID, searchFields, EntityID)
}
#' Modify a specific TempDegree
#'
#' This function modifies fields for a TempDegree.
#'
#' @param TempDegreeID The id of the TempDegree to be modified.\cr Run \code{\link{getAllTempDegrees}} for a list of TempDegrees.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempDegree.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempDegree <- function(TempDegreeID, EntityID = 1, setAdditionalCredits = NULL, setApprovedDate = NULL, setCredits = NULL, setDegreeID = NULL, setDegreeTypeID = NULL, setEmployeeID = NULL, setGPA = NULL, setInstitutionID = NULL, setIsDelete = NULL, setOnScreenCount = NULL, setReceivedDate = 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("OnlineForm", "TempDegree", TempDegreeID, names(functionParams), functionParams, EntityID)
}
#' Create new TempDegree.
#'
#' This function creates a new TempDegree.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempDegree.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempDegree <- function(EntityID = 1, setAdditionalCredits = NULL, setApprovedDate = NULL, setCredits = NULL, setDegreeID = NULL, setDegreeTypeID = NULL, setEmployeeID = NULL, setGPA = NULL, setInstitutionID = NULL, setIsDelete = NULL, setOnScreenCount = NULL, setReceivedDate = 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("OnlineForm", "TempDegree", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempDegree
#'
#' This function deletes a TempDegree.
#'
#' @param TempDegreeID The id of the TempDegree.\cr Run \code{\link{getAllTempDegrees}} for a list of TempDegrees.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempDegree.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempDegree <- function(TempDegreeID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempDegree", TempDegreeID, EntityID)
}
#' Get all TempDependents.
#'
#' This function returns a dataframe of all TempDependents 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 OnlineForm
#' @return All TempDependents in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempDependents <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempDependentID = F, returnBirthDate = F, returnCreatedTime = F, returnDependentID = F, returnFirstName = F, returnIsDelete = F, returnIsExistingRecord = F, returnLastName = F, returnMiddleName = F, returnModifiedTime = F, returnOnScreenCount = F, returnRelationshipID = F, returnSocialSecurityNumber = 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("OnlineForm", "TempDependent", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempDependent
#'
#' This function returns fields for a TempDependent.
#'
#' @param TempDependentID The id of the TempDependent.\cr Run \code{\link{getAllTempDependents}} for a list of TempDependents.
#' @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 OnlineForm
#' @return Details for the TempDependent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempDependent <- function(TempDependentID, EntityID = 1, returnTempDependentID = F, returnBirthDate = F, returnCreatedTime = F, returnDependentID = F, returnFirstName = F, returnIsDelete = F, returnIsExistingRecord = F, returnLastName = F, returnMiddleName = F, returnModifiedTime = F, returnOnScreenCount = F, returnRelationshipID = F, returnSocialSecurityNumber = 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("OnlineForm", "TempDependent", TempDependentID, searchFields, EntityID)
}
#' Modify a specific TempDependent
#'
#' This function modifies fields for a TempDependent.
#'
#' @param TempDependentID The id of the TempDependent to be modified.\cr Run \code{\link{getAllTempDependents}} for a list of TempDependents.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempDependent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempDependent <- function(TempDependentID, EntityID = 1, setBirthDate = NULL, setDependentID = NULL, setFirstName = NULL, setIsDelete = NULL, setIsExistingRecord = NULL, setLastName = NULL, setMiddleName = NULL, setOnScreenCount = NULL, setRelationshipID = NULL, setSocialSecurityNumber = 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("OnlineForm", "TempDependent", TempDependentID, names(functionParams), functionParams, EntityID)
}
#' Create new TempDependent.
#'
#' This function creates a new TempDependent.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempDependent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempDependent <- function(EntityID = 1, setBirthDate = NULL, setDependentID = NULL, setFirstName = NULL, setIsDelete = NULL, setIsExistingRecord = NULL, setLastName = NULL, setMiddleName = NULL, setOnScreenCount = NULL, setRelationshipID = NULL, setSocialSecurityNumber = 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("OnlineForm", "TempDependent", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempDependent
#'
#' This function deletes a TempDependent.
#'
#' @param TempDependentID The id of the TempDependent.\cr Run \code{\link{getAllTempDependents}} for a list of TempDependents.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempDependent.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempDependent <- function(TempDependentID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempDependent", TempDependentID, EntityID)
}
#' Get all TempEmergencyContacts.
#'
#' This function returns a dataframe of all TempEmergencyContacts 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 OnlineForm
#' @return All TempEmergencyContacts in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempEmergencyContactsOnlineForm <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempEmergencyContactID = F, returnAddEmergencyContact = F, returnAllowStudentPickup = F, returnComment = F, returnCreatedTime = F, returnCreateNewEmergencyContactName = F, returnDeleteEmergencyContact = F, returnDriversLicenseNumber = F, returnEmergencyContactID = F, returnFirstName = F, returnForSecondFamily = F, returnIsAlsoGuardian = F, returnIsBusiness = F, returnIsHealthProfessionalName = F, returnLastName = F, returnMiddleName = F, returnModifiedTime = F, returnNameID = F, returnOnScreenID = F, returnPrimaryEmailEmailAddress = F, returnPrimaryEmailEmailTypeID = F, returnPrimaryEmailNameEmailID = F, returnPrimaryEmailPreventFamilyStudentAccessUpdates = F, returnPrimaryPhoneExtension = F, returnPrimaryPhoneNamePhoneID = F, returnPrimaryPhonePhoneNumber = F, returnPrimaryPhonePhoneTypeID = F, returnPrimaryPhonePreventFamilyStudentAccessUpdates = F, returnRank = F, returnRelationshipID = F, returnSecondEmailEmailAddress = F, returnSecondEmailEmailTypeID = F, returnSecondEmailNameEmailID = F, returnSecondEmailPreventFamilyStudentAccessUpdates = F, returnSecondPhoneExtension = F, returnSecondPhoneNamePhoneID = F, returnSecondPhonePhoneNumber = F, returnSecondPhonePhoneTypeID = F, returnSecondPhonePreventFamilyStudentAccessUpdates = F, returnThirdEmailEmailAddress = F, returnThirdEmailEmailTypeID = F, returnThirdEmailNameEmailID = F, returnThirdEmailPreventFamilyStudentAccessUpdates = F, returnThirdPhoneExtension = F, returnThirdPhoneNamePhoneID = F, returnThirdPhonePhoneNumber = F, returnThirdPhonePhoneTypeID = F, returnThirdPhonePreventFamilyStudentAccessUpdates = 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("OnlineForm", "TempEmergencyContact", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempEmergencyContact
#'
#' This function returns fields for a TempEmergencyContact.
#'
#' @param TempEmergencyContactID The id of the TempEmergencyContact.\cr Run \code{\link{getAllTempEmergencyContacts}} for a list of TempEmergencyContacts.
#' @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 OnlineForm
#' @return Details for the TempEmergencyContact.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempEmergencyContactOnlineForm <- function(TempEmergencyContactID, EntityID = 1, returnTempEmergencyContactID = F, returnAddEmergencyContact = F, returnAllowStudentPickup = F, returnComment = F, returnCreatedTime = F, returnCreateNewEmergencyContactName = F, returnDeleteEmergencyContact = F, returnDriversLicenseNumber = F, returnEmergencyContactID = F, returnFirstName = F, returnForSecondFamily = F, returnIsAlsoGuardian = F, returnIsBusiness = F, returnIsHealthProfessionalName = F, returnLastName = F, returnMiddleName = F, returnModifiedTime = F, returnNameID = F, returnOnScreenID = F, returnPrimaryEmailEmailAddress = F, returnPrimaryEmailEmailTypeID = F, returnPrimaryEmailNameEmailID = F, returnPrimaryEmailPreventFamilyStudentAccessUpdates = F, returnPrimaryPhoneExtension = F, returnPrimaryPhoneNamePhoneID = F, returnPrimaryPhonePhoneNumber = F, returnPrimaryPhonePhoneTypeID = F, returnPrimaryPhonePreventFamilyStudentAccessUpdates = F, returnRank = F, returnRelationshipID = F, returnSecondEmailEmailAddress = F, returnSecondEmailEmailTypeID = F, returnSecondEmailNameEmailID = F, returnSecondEmailPreventFamilyStudentAccessUpdates = F, returnSecondPhoneExtension = F, returnSecondPhoneNamePhoneID = F, returnSecondPhonePhoneNumber = F, returnSecondPhonePhoneTypeID = F, returnSecondPhonePreventFamilyStudentAccessUpdates = F, returnThirdEmailEmailAddress = F, returnThirdEmailEmailTypeID = F, returnThirdEmailNameEmailID = F, returnThirdEmailPreventFamilyStudentAccessUpdates = F, returnThirdPhoneExtension = F, returnThirdPhoneNamePhoneID = F, returnThirdPhonePhoneNumber = F, returnThirdPhonePhoneTypeID = F, returnThirdPhonePreventFamilyStudentAccessUpdates = 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("OnlineForm", "TempEmergencyContact", TempEmergencyContactID, searchFields, EntityID)
}
#' Modify a specific TempEmergencyContact
#'
#' This function modifies fields for a TempEmergencyContact.
#'
#' @param TempEmergencyContactID The id of the TempEmergencyContact to be modified.\cr Run \code{\link{getAllTempEmergencyContacts}} for a list of TempEmergencyContacts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempEmergencyContact.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempEmergencyContactOnlineForm <- function(TempEmergencyContactID, EntityID = 1, setAddEmergencyContact = NULL, setAllowStudentPickup = NULL, setComment = NULL, setCreateNewEmergencyContactName = NULL, setDeleteEmergencyContact = NULL, setDriversLicenseNumber = NULL, setEmergencyContactID = NULL, setFirstName = NULL, setForSecondFamily = NULL, setIsAlsoGuardian = NULL, setIsBusiness = NULL, setIsHealthProfessionalName = NULL, setLastName = NULL, setMiddleName = NULL, setNameID = NULL, setOnScreenID = NULL, setPrimaryEmailEmailAddress = NULL, setPrimaryEmailEmailTypeID = NULL, setPrimaryEmailNameEmailID = NULL, setPrimaryEmailPreventFamilyStudentAccessUpdates = NULL, setPrimaryPhoneExtension = NULL, setPrimaryPhoneNamePhoneID = NULL, setPrimaryPhonePhoneNumber = NULL, setPrimaryPhonePhoneTypeID = NULL, setPrimaryPhonePreventFamilyStudentAccessUpdates = NULL, setRank = NULL, setRelationshipID = NULL, setSecondEmailEmailAddress = NULL, setSecondEmailEmailTypeID = NULL, setSecondEmailNameEmailID = NULL, setSecondEmailPreventFamilyStudentAccessUpdates = NULL, setSecondPhoneExtension = NULL, setSecondPhoneNamePhoneID = NULL, setSecondPhonePhoneNumber = NULL, setSecondPhonePhoneTypeID = NULL, setSecondPhonePreventFamilyStudentAccessUpdates = NULL, setThirdEmailEmailAddress = NULL, setThirdEmailEmailTypeID = NULL, setThirdEmailNameEmailID = NULL, setThirdEmailPreventFamilyStudentAccessUpdates = NULL, setThirdPhoneExtension = NULL, setThirdPhoneNamePhoneID = NULL, setThirdPhonePhoneNumber = NULL, setThirdPhonePhoneTypeID = NULL, setThirdPhonePreventFamilyStudentAccessUpdates = 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("OnlineForm", "TempEmergencyContact", TempEmergencyContactID, names(functionParams), functionParams, EntityID)
}
#' Create new TempEmergencyContact.
#'
#' This function creates a new TempEmergencyContact.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempEmergencyContact.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempEmergencyContactOnlineForm <- function(EntityID = 1, setAddEmergencyContact = NULL, setAllowStudentPickup = NULL, setComment = NULL, setCreateNewEmergencyContactName = NULL, setDeleteEmergencyContact = NULL, setDriversLicenseNumber = NULL, setEmergencyContactID = NULL, setFirstName = NULL, setForSecondFamily = NULL, setIsAlsoGuardian = NULL, setIsBusiness = NULL, setIsHealthProfessionalName = NULL, setLastName = NULL, setMiddleName = NULL, setNameID = NULL, setOnScreenID = NULL, setPrimaryEmailEmailAddress = NULL, setPrimaryEmailEmailTypeID = NULL, setPrimaryEmailNameEmailID = NULL, setPrimaryEmailPreventFamilyStudentAccessUpdates = NULL, setPrimaryPhoneExtension = NULL, setPrimaryPhoneNamePhoneID = NULL, setPrimaryPhonePhoneNumber = NULL, setPrimaryPhonePhoneTypeID = NULL, setPrimaryPhonePreventFamilyStudentAccessUpdates = NULL, setRank = NULL, setRelationshipID = NULL, setSecondEmailEmailAddress = NULL, setSecondEmailEmailTypeID = NULL, setSecondEmailNameEmailID = NULL, setSecondEmailPreventFamilyStudentAccessUpdates = NULL, setSecondPhoneExtension = NULL, setSecondPhoneNamePhoneID = NULL, setSecondPhonePhoneNumber = NULL, setSecondPhonePhoneTypeID = NULL, setSecondPhonePreventFamilyStudentAccessUpdates = NULL, setThirdEmailEmailAddress = NULL, setThirdEmailEmailTypeID = NULL, setThirdEmailNameEmailID = NULL, setThirdEmailPreventFamilyStudentAccessUpdates = NULL, setThirdPhoneExtension = NULL, setThirdPhoneNamePhoneID = NULL, setThirdPhonePhoneNumber = NULL, setThirdPhonePhoneTypeID = NULL, setThirdPhonePreventFamilyStudentAccessUpdates = 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("OnlineForm", "TempEmergencyContact", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempEmergencyContact
#'
#' This function deletes a TempEmergencyContact.
#'
#' @param TempEmergencyContactID The id of the TempEmergencyContact.\cr Run \code{\link{getAllTempEmergencyContacts}} for a list of TempEmergencyContacts.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempEmergencyContact.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempEmergencyContactOnlineForm <- function(TempEmergencyContactID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempEmergencyContact", TempEmergencyContactID, EntityID)
}
#' Get all TempErrors.
#'
#' This function returns a dataframe of all TempErrors 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 OnlineForm
#' @return All TempErrors in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempErrors <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempErrorID = F, returnCreatedTime = F, returnDescription = F, returnMessage = 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("OnlineForm", "TempError", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempError
#'
#' This function returns fields for a TempError.
#'
#' @param TempErrorID The id of the TempError.\cr Run \code{\link{getAllTempErrors}} for a list of TempErrors.
#' @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 OnlineForm
#' @return Details for the TempError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempError <- function(TempErrorID, EntityID = 1, returnTempErrorID = F, returnCreatedTime = F, returnDescription = F, returnMessage = 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("OnlineForm", "TempError", TempErrorID, searchFields, EntityID)
}
#' Modify a specific TempError
#'
#' This function modifies fields for a TempError.
#'
#' @param TempErrorID The id of the TempError to be modified.\cr Run \code{\link{getAllTempErrors}} for a list of TempErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempError <- function(TempErrorID, EntityID = 1, setDescription = NULL, setMessage = 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("OnlineForm", "TempError", TempErrorID, names(functionParams), functionParams, EntityID)
}
#' Create new TempError.
#'
#' This function creates a new TempError.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempError <- function(EntityID = 1, setDescription = NULL, setMessage = 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("OnlineForm", "TempError", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempError
#'
#' This function deletes a TempError.
#'
#' @param TempErrorID The id of the TempError.\cr Run \code{\link{getAllTempErrors}} for a list of TempErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempError <- function(TempErrorID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempError", TempErrorID, EntityID)
}
#' Get all TempNewStudentEnrollmentGuardianEmails.
#'
#' This function returns a dataframe of all TempNewStudentEnrollmentGuardianEmails 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 OnlineForm
#' @return All TempNewStudentEnrollmentGuardianEmails in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempNewStudentEnrollmentGuardianEmails <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempNewStudentEnrollmentGuardianEmailID = F, returnAddEmail = F, returnCreatedTime = F, returnCreateNewEmail = F, returnDeleteEmail = F, returnEmailAddress = F, returnEmailPreventFamilyStudentAccessUpdates = F, returnEmailTypeID = F, returnModifiedTime = F, returnNameEmailID = F, returnOnScreenID = F, returnParentOnScreenID = F, returnRank = 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("OnlineForm", "TempNewStudentEnrollmentGuardianEmail", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempNewStudentEnrollmentGuardianEmail
#'
#' This function returns fields for a TempNewStudentEnrollmentGuardianEmail.
#'
#' @param TempNewStudentEnrollmentGuardianEmailID The id of the TempNewStudentEnrollmentGuardianEmail.\cr Run \code{\link{getAllTempNewStudentEnrollmentGuardianEmails}} for a list of TempNewStudentEnrollmentGuardianEmails.
#' @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 OnlineForm
#' @return Details for the TempNewStudentEnrollmentGuardianEmail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempNewStudentEnrollmentGuardianEmail <- function(TempNewStudentEnrollmentGuardianEmailID, EntityID = 1, returnTempNewStudentEnrollmentGuardianEmailID = F, returnAddEmail = F, returnCreatedTime = F, returnCreateNewEmail = F, returnDeleteEmail = F, returnEmailAddress = F, returnEmailPreventFamilyStudentAccessUpdates = F, returnEmailTypeID = F, returnModifiedTime = F, returnNameEmailID = F, returnOnScreenID = F, returnParentOnScreenID = F, returnRank = 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("OnlineForm", "TempNewStudentEnrollmentGuardianEmail", TempNewStudentEnrollmentGuardianEmailID, searchFields, EntityID)
}
#' Modify a specific TempNewStudentEnrollmentGuardianEmail
#'
#' This function modifies fields for a TempNewStudentEnrollmentGuardianEmail.
#'
#' @param TempNewStudentEnrollmentGuardianEmailID The id of the TempNewStudentEnrollmentGuardianEmail to be modified.\cr Run \code{\link{getAllTempNewStudentEnrollmentGuardianEmails}} for a list of TempNewStudentEnrollmentGuardianEmails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempNewStudentEnrollmentGuardianEmail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempNewStudentEnrollmentGuardianEmail <- function(TempNewStudentEnrollmentGuardianEmailID, EntityID = 1, setAddEmail = NULL, setCreateNewEmail = NULL, setDeleteEmail = NULL, setEmailAddress = NULL, setEmailPreventFamilyStudentAccessUpdates = NULL, setEmailTypeID = NULL, setNameEmailID = NULL, setOnScreenID = NULL, setParentOnScreenID = NULL, setRank = 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("OnlineForm", "TempNewStudentEnrollmentGuardianEmail", TempNewStudentEnrollmentGuardianEmailID, names(functionParams), functionParams, EntityID)
}
#' Create new TempNewStudentEnrollmentGuardianEmail.
#'
#' This function creates a new TempNewStudentEnrollmentGuardianEmail.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempNewStudentEnrollmentGuardianEmail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempNewStudentEnrollmentGuardianEmail <- function(EntityID = 1, setAddEmail = NULL, setCreateNewEmail = NULL, setDeleteEmail = NULL, setEmailAddress = NULL, setEmailPreventFamilyStudentAccessUpdates = NULL, setEmailTypeID = NULL, setNameEmailID = NULL, setOnScreenID = NULL, setParentOnScreenID = NULL, setRank = 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("OnlineForm", "TempNewStudentEnrollmentGuardianEmail", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempNewStudentEnrollmentGuardianEmail
#'
#' This function deletes a TempNewStudentEnrollmentGuardianEmail.
#'
#' @param TempNewStudentEnrollmentGuardianEmailID The id of the TempNewStudentEnrollmentGuardianEmail.\cr Run \code{\link{getAllTempNewStudentEnrollmentGuardianEmails}} for a list of TempNewStudentEnrollmentGuardianEmails.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempNewStudentEnrollmentGuardianEmail.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempNewStudentEnrollmentGuardianEmail <- function(TempNewStudentEnrollmentGuardianEmailID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempNewStudentEnrollmentGuardianEmail", TempNewStudentEnrollmentGuardianEmailID, EntityID)
}
#' Get all TempNewStudentEnrollmentGuardianPhones.
#'
#' This function returns a dataframe of all TempNewStudentEnrollmentGuardianPhones 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 OnlineForm
#' @return All TempNewStudentEnrollmentGuardianPhones in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempNewStudentEnrollmentGuardianPhones <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempNewStudentEnrollmentGuardianPhoneID = F, returnAddPhone = F, returnCreatedTime = F, returnCreateNewPhone = F, returnDeletePhone = F, returnExtension = F, returnIsConfidential = F, returnModifiedTime = F, returnNamePhoneID = F, returnOnScreenID = F, returnParentOnScreenID = F, returnPhoneNumber = F, returnPhonePreventFamilyStudentAccessUpdates = F, returnPhoneTypeID = F, returnRank = 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("OnlineForm", "TempNewStudentEnrollmentGuardianPhone", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempNewStudentEnrollmentGuardianPhone
#'
#' This function returns fields for a TempNewStudentEnrollmentGuardianPhone.
#'
#' @param TempNewStudentEnrollmentGuardianPhoneID The id of the TempNewStudentEnrollmentGuardianPhone.\cr Run \code{\link{getAllTempNewStudentEnrollmentGuardianPhones}} for a list of TempNewStudentEnrollmentGuardianPhones.
#' @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 OnlineForm
#' @return Details for the TempNewStudentEnrollmentGuardianPhone.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempNewStudentEnrollmentGuardianPhone <- function(TempNewStudentEnrollmentGuardianPhoneID, EntityID = 1, returnTempNewStudentEnrollmentGuardianPhoneID = F, returnAddPhone = F, returnCreatedTime = F, returnCreateNewPhone = F, returnDeletePhone = F, returnExtension = F, returnIsConfidential = F, returnModifiedTime = F, returnNamePhoneID = F, returnOnScreenID = F, returnParentOnScreenID = F, returnPhoneNumber = F, returnPhonePreventFamilyStudentAccessUpdates = F, returnPhoneTypeID = F, returnRank = 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("OnlineForm", "TempNewStudentEnrollmentGuardianPhone", TempNewStudentEnrollmentGuardianPhoneID, searchFields, EntityID)
}
#' Modify a specific TempNewStudentEnrollmentGuardianPhone
#'
#' This function modifies fields for a TempNewStudentEnrollmentGuardianPhone.
#'
#' @param TempNewStudentEnrollmentGuardianPhoneID The id of the TempNewStudentEnrollmentGuardianPhone to be modified.\cr Run \code{\link{getAllTempNewStudentEnrollmentGuardianPhones}} for a list of TempNewStudentEnrollmentGuardianPhones.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempNewStudentEnrollmentGuardianPhone.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempNewStudentEnrollmentGuardianPhone <- function(TempNewStudentEnrollmentGuardianPhoneID, EntityID = 1, setAddPhone = NULL, setCreateNewPhone = NULL, setDeletePhone = NULL, setExtension = NULL, setIsConfidential = NULL, setNamePhoneID = NULL, setOnScreenID = NULL, setParentOnScreenID = NULL, setPhoneNumber = NULL, setPhonePreventFamilyStudentAccessUpdates = NULL, setPhoneTypeID = NULL, setRank = 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("OnlineForm", "TempNewStudentEnrollmentGuardianPhone", TempNewStudentEnrollmentGuardianPhoneID, names(functionParams), functionParams, EntityID)
}
#' Create new TempNewStudentEnrollmentGuardianPhone.
#'
#' This function creates a new TempNewStudentEnrollmentGuardianPhone.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempNewStudentEnrollmentGuardianPhone.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempNewStudentEnrollmentGuardianPhone <- function(EntityID = 1, setAddPhone = NULL, setCreateNewPhone = NULL, setDeletePhone = NULL, setExtension = NULL, setIsConfidential = NULL, setNamePhoneID = NULL, setOnScreenID = NULL, setParentOnScreenID = NULL, setPhoneNumber = NULL, setPhonePreventFamilyStudentAccessUpdates = NULL, setPhoneTypeID = NULL, setRank = 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("OnlineForm", "TempNewStudentEnrollmentGuardianPhone", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempNewStudentEnrollmentGuardianPhone
#'
#' This function deletes a TempNewStudentEnrollmentGuardianPhone.
#'
#' @param TempNewStudentEnrollmentGuardianPhoneID The id of the TempNewStudentEnrollmentGuardianPhone.\cr Run \code{\link{getAllTempNewStudentEnrollmentGuardianPhones}} for a list of TempNewStudentEnrollmentGuardianPhones.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempNewStudentEnrollmentGuardianPhone.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempNewStudentEnrollmentGuardianPhone <- function(TempNewStudentEnrollmentGuardianPhoneID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempNewStudentEnrollmentGuardianPhone", TempNewStudentEnrollmentGuardianPhoneID, EntityID)
}
#' Get all TempSteps.
#'
#' This function returns a dataframe of all TempSteps 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 OnlineForm
#' @return All TempSteps in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempSteps <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStepID = F, returnCreatedTime = F, returnEntityGroupKey = F, returnErrorCount = F, returnIsActive = F, returnIsReadOnlyForNonPrimaryFamily = F, returnIsRequired = F, returnMessage = F, returnModifiedTime = F, returnName = F, returnOnlineFormID = F, returnOrder = F, returnStepID = 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("OnlineForm", "TempStep", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStep
#'
#' This function returns fields for a TempStep.
#'
#' @param TempStepID The id of the TempStep.\cr Run \code{\link{getAllTempSteps}} for a list of TempSteps.
#' @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 OnlineForm
#' @return Details for the TempStep.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStep <- function(TempStepID, EntityID = 1, returnTempStepID = F, returnCreatedTime = F, returnEntityGroupKey = F, returnErrorCount = F, returnIsActive = F, returnIsReadOnlyForNonPrimaryFamily = F, returnIsRequired = F, returnMessage = F, returnModifiedTime = F, returnName = F, returnOnlineFormID = F, returnOrder = F, returnStepID = 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("OnlineForm", "TempStep", TempStepID, searchFields, EntityID)
}
#' Modify a specific TempStep
#'
#' This function modifies fields for a TempStep.
#'
#' @param TempStepID The id of the TempStep to be modified.\cr Run \code{\link{getAllTempSteps}} for a list of TempSteps.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempStep.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStep <- function(TempStepID, EntityID = 1, setEntityGroupKey = NULL, setErrorCount = NULL, setIsActive = NULL, setIsReadOnlyForNonPrimaryFamily = NULL, setIsRequired = NULL, setMessage = NULL, setName = NULL, setOnlineFormID = NULL, setOrder = NULL, setStepID = 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("OnlineForm", "TempStep", TempStepID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStep.
#'
#' This function creates a new TempStep.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempStep.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStep <- function(EntityID = 1, setEntityGroupKey = NULL, setErrorCount = NULL, setIsActive = NULL, setIsReadOnlyForNonPrimaryFamily = NULL, setIsRequired = NULL, setMessage = NULL, setName = NULL, setOnlineFormID = NULL, setOrder = NULL, setStepID = 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("OnlineForm", "TempStep", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStep
#'
#' This function deletes a TempStep.
#'
#' @param TempStepID The id of the TempStep.\cr Run \code{\link{getAllTempSteps}} for a list of TempSteps.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempStep.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStep <- function(TempStepID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempStep", TempStepID, EntityID)
}
#' Get all TempStepErrors.
#'
#' This function returns a dataframe of all TempStepErrors 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 OnlineForm
#' @return All TempStepErrors in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStepErrors <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStepErrorID = F, returnCreatedTime = F, returnError = F, returnErrorMessage = F, returnModifiedTime = F, returnTempStepID = 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("OnlineForm", "TempStepError", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStepError
#'
#' This function returns fields for a TempStepError.
#'
#' @param TempStepErrorID The id of the TempStepError.\cr Run \code{\link{getAllTempStepErrors}} for a list of TempStepErrors.
#' @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 OnlineForm
#' @return Details for the TempStepError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStepError <- function(TempStepErrorID, EntityID = 1, returnTempStepErrorID = F, returnCreatedTime = F, returnError = F, returnErrorMessage = F, returnModifiedTime = F, returnTempStepID = 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("OnlineForm", "TempStepError", TempStepErrorID, searchFields, EntityID)
}
#' Modify a specific TempStepError
#'
#' This function modifies fields for a TempStepError.
#'
#' @param TempStepErrorID The id of the TempStepError to be modified.\cr Run \code{\link{getAllTempStepErrors}} for a list of TempStepErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempStepError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStepError <- function(TempStepErrorID, EntityID = 1, setError = NULL, setErrorMessage = NULL, setTempStepID = 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("OnlineForm", "TempStepError", TempStepErrorID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStepError.
#'
#' This function creates a new TempStepError.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempStepError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStepError <- function(EntityID = 1, setError = NULL, setErrorMessage = NULL, setTempStepID = 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("OnlineForm", "TempStepError", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStepError
#'
#' This function deletes a TempStepError.
#'
#' @param TempStepErrorID The id of the TempStepError.\cr Run \code{\link{getAllTempStepErrors}} for a list of TempStepErrors.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempStepError.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStepError <- function(TempStepErrorID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempStepError", TempStepErrorID, EntityID)
}
#' Get all TempStudentHealthConditions.
#'
#' This function returns a dataframe of all TempStudentHealthConditions 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 OnlineForm
#' @return All TempStudentHealthConditions in the database.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getAllTempStudentHealthConditions <- function(EntityID = 1, searchConditionsList = NULL, searchConditionsGroupType = "And", searchSortFieldNamesList = NULL, searchSortFieldNamesDescendingList = rep(F, length(searchSortFieldNamesList)), page = 1, pageSize = "100000", returnTempStudentHealthConditionID = F, returnCreatedTime = F, returnHealthConditionID = F, returnIsDelete = F, returnIsExistingStudentHealthCondition = F, returnIsExistingStudentHealthConditionNote = F, returnModifiedTime = F, returnNote = F, returnOnScreenCount = F, returnStartDate = F, returnStudentHealthConditionID = F, returnStudentHealthConditionNoteID = 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("OnlineForm", "TempStudentHealthCondition", searchFields, EntityID, searchConditionsList, searchConditionsGroupType, searchSortFieldNamesList, searchSortFieldNamesDescendingList, page, pageSize)
}
#' Get a specific TempStudentHealthCondition
#'
#' This function returns fields for a TempStudentHealthCondition.
#'
#' @param TempStudentHealthConditionID The id of the TempStudentHealthCondition.\cr Run \code{\link{getAllTempStudentHealthConditions}} for a list of TempStudentHealthConditions.
#' @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 OnlineForm
#' @return Details for the TempStudentHealthCondition.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
getTempStudentHealthCondition <- function(TempStudentHealthConditionID, EntityID = 1, returnTempStudentHealthConditionID = F, returnCreatedTime = F, returnHealthConditionID = F, returnIsDelete = F, returnIsExistingStudentHealthCondition = F, returnIsExistingStudentHealthConditionNote = F, returnModifiedTime = F, returnNote = F, returnOnScreenCount = F, returnStartDate = F, returnStudentHealthConditionID = F, returnStudentHealthConditionNoteID = 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("OnlineForm", "TempStudentHealthCondition", TempStudentHealthConditionID, searchFields, EntityID)
}
#' Modify a specific TempStudentHealthCondition
#'
#' This function modifies fields for a TempStudentHealthCondition.
#'
#' @param TempStudentHealthConditionID The id of the TempStudentHealthCondition to be modified.\cr Run \code{\link{getAllTempStudentHealthConditions}} for a list of TempStudentHealthConditions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return Details of the modified TempStudentHealthCondition.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
modifyTempStudentHealthCondition <- function(TempStudentHealthConditionID, EntityID = 1, setHealthConditionID = NULL, setIsDelete = NULL, setIsExistingStudentHealthCondition = NULL, setIsExistingStudentHealthConditionNote = NULL, setNote = NULL, setOnScreenCount = NULL, setStartDate = NULL, setStudentHealthConditionID = NULL, setStudentHealthConditionNoteID = 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("OnlineForm", "TempStudentHealthCondition", TempStudentHealthConditionID, names(functionParams), functionParams, EntityID)
}
#' Create new TempStudentHealthCondition.
#'
#' This function creates a new TempStudentHealthCondition.
#'
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @param set{FieldName} Values to set {FieldName} to for the given object. Defaults to NULL for all set fields which does not set the field's value.
#' @concept OnlineForm
#' @return The fields used to define the newly created TempStudentHealthCondition.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
createTempStudentHealthCondition <- function(EntityID = 1, setHealthConditionID = NULL, setIsDelete = NULL, setIsExistingStudentHealthCondition = NULL, setIsExistingStudentHealthConditionNote = NULL, setNote = NULL, setOnScreenCount = NULL, setStartDate = NULL, setStudentHealthConditionID = NULL, setStudentHealthConditionNoteID = 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("OnlineForm", "TempStudentHealthCondition", names(functionParams), functionParams, EntityID)
}
#' Delete a specific TempStudentHealthCondition
#'
#' This function deletes a TempStudentHealthCondition.
#'
#' @param TempStudentHealthConditionID The id of the TempStudentHealthCondition.\cr Run \code{\link{getAllTempStudentHealthConditions}} for a list of TempStudentHealthConditions.
#' @param EntityID The id of the entity. Run \code{\link{getAllEntities}} for a list of entities.
#' @concept OnlineForm
#' @return The id of the deleted TempStudentHealthCondition.
#' @section References:
#' \{yourApiUrl\}/swagger\cr\cr
#' \href{https://help.skyward.com/}{Skyward's Knowledge Hub}
#' @export
deleteTempStudentHealthCondition <- function(TempStudentHealthConditionID, EntityID = 1){
suppressMessages(suppressWarnings(require(dplyr)))
deleteDataObject("OnlineForm", "TempStudentHealthCondition", TempStudentHealthConditionID, EntityID)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.