getElement: Get a specific Element

In samterfa/SkywardSDK: Creates R Functions for Skyward Generic API Functions

Description

This function returns fields for an Element.

Usage

getElement(
  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
)

Arguments

ElementID	The id of the Element. Run getAllElements for a list of Elements.
EntityID	The id of the entity. Run getAllEntities for a list of entities.
returnFieldName	A TRUE or FALSE value determining whether or not to return FieldName for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.

Value

Details for the Element.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub

samterfa/SkywardSDK documentation built on Oct. 13, 2020, 6:53 a.m.