complexType DescriptorReferenceType
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p336.png
namespace http://ed-fi.org/0110
type extension of ReferenceType
properties
base ReferenceType
children CodeValue ShortDescription Description
used by
elements Assessment/AcademicSubject AssessmentFamily/AcademicSubject Cohort/AcademicSubject CredentialFieldDescriptor/AcademicSubject LearningObjective/AcademicSubject AssessmentIdentityType/AcademicSubject TeacherSchoolAssociation/AcademicSubjects OpenStaffPosition/AcademicSubjects StudentAssessment/Accommodation StudentAssessment/AdministrationLanguage School/AdministrativeFundingControl Assessment/AssessmentPeriod AssessmentFamily/AssessmentPeriods AttendanceEvent/AttendanceEventCategory DisciplineIncident/Behaviors StudentDisciplineIncidentAssociation/Behaviors CalendarDate/CalendarEvent TeacherSectionAssociation/ClassroomPosition StudentCompetency/CompetencyLevel StudentGradebookEntry/CompetencyLevel Course/CompetencyLevels StudentMigrantEducationProgramAssociation/ContinuationOfServicesReason Credential/CredentialField InterventionEffectiveness/Diagnosis InterventionPrescription/Diagnosis Disability/Disability DisciplineAction/Disciplines StaffEducationOrgEmploymentAssociationIdentityType/EmploymentStatus StaffEducationOrgEmploymentAssociation/EmploymentStatus OpenStaffPosition/EmploymentStatus StudentSchoolAssociation/EntryGradeLevel StudentSchoolAssociation/EntryType StudentSchoolAssociation/ExitWithdrawType InterventionEffectiveness/GradeLevel LearningStandard/GradeLevel CreditsByCourse/GradeLevel InterventionPrescription/GradeLevelAppropriateness EducationContent/GradeLevelAppropriateness AssessmentFamily/GradeLevelAssessed Assessment/GradeLevelAssessed AssessmentIdentityType/GradeLevelAssessed BellSchedule/GradeLevels InterventionStudy/GradeLevels StudentAssessment/GradeLevelWhenAssessed CourseTranscript/GradeLevelWhenTaken Course/GradesOffered School/GradesOffered GradingPeriod/GradingPeriod GradingPeriodIdentityType/GradingPeriod GraduationPlan/GraduationPlanType GraduationPlanIdentityType/GraduationPlanType Staff/HighestLevelOfEducationCompleted Student/HomeLanguages TeacherSchoolAssociation/InstructionalGradeLevels OpenStaffPosition/InstructionalGradeLevels Student/Languages Credential/Level Student/LimitedEnglishProficiency AssessmentFamily/LowestGradeLevelAssessed Assessment/LowestGradeLevelAssessed LearningObjective/ObjectiveGradeLevel StudentCompetencyObjective/ObjectiveGradeLevel DescriptorType/PriorDescriptor TeacherSchoolAssociation/ProgramAssignment OpenStaffPosition/ProgramAssignment StudentProgramAssociation/ReasonExited StudentSpecialEdProgramAssociation/ReasonExitedSpecialEducation DisciplineIncident/ReporterDescription StudentSchoolAssociation/ResidencyStatus StudentEducationOrganizationAssociation/Responsibility Student/SchoolFoodServicesEligibility Section/SectionCharacteristics EmploymentPeriod/SeparationReason StudentSpecialEdProgramAssociation/SpecialEducationSetting OpenStaffPosition/StaffClassification StaffEducationOrgAssignmentAssociation/StaffClassification LearningStandard/SubjectArea Course/SubjectArea CreditsBySubject/SubjectArea Credential/TeachingCredentialType DisciplineIncident/Weapons
complexTypes AccountCodeDescriptorReferenceType PerformanceLevelDescriptorReferenceType ServiceDescriptorReferenceType
attributes
Name  Type  Use  Default  Fixed  annotation
idxs:ID      
documentation
The XML ID associated with this complex object.
refxs:IDREF      
documentation
The XML IDREF that references the object associated with this object.
AsOfDate      
documentation
The date context in which this reference should be considered. This is important when descriptors change over time. If omitted, assumed to be the current descriptor.
namespaceURIrequired      
documentation
A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.
annotation
documentation
Provides references for descriptors during interchange. Use XML IDREF to reference a descriptor record that is included in the interchange.  To lookup when already loaded, specify either CodeValue OR Description OR ShortDescription.
appinfo
<ann:TypeGroup>Base</ann:TypeGroup>
source <xs:complexType name="DescriptorReferenceType">
 
<xs:annotation>
   
<xs:documentation>Provides references for descriptors during interchange. Use XML IDREF to reference a descriptor record that is included in the interchange.  To lookup when already loaded, specify either CodeValue OR Description OR ShortDescription.</xs:documentation>
   
<xs:appinfo>
     
<ann:TypeGroup>Base</ann:TypeGroup>
   
</xs:appinfo>
 
</xs:annotation>
 
<xs:complexContent>
   
<xs:extension base="ReferenceType">
     
<xs:choice>
       
<xs:element name="CodeValue" type="CodeValue">
         
<xs:annotation>
           
<xs:documentation>A code or abbreviation that is used to refer to the descriptor</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="ShortDescription" type="ShortDescription">
         
<xs:annotation>
           
<xs:documentation>A shortened description for descriptor.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="Description" type="Description">
         
<xs:annotation>
           
<xs:documentation>The long description.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
     
</xs:choice>
     
<xs:attribute name="AsOfDate">
       
<xs:annotation>
         
<xs:documentation>The date context in which this reference should be considered. This is important when descriptors change over time. If omitted, assumed to be the current descriptor.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
     
<xs:attribute name="namespace" type="URI" use="required">
       
<xs:annotation>
         
<xs:documentation>A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.</xs:documentation>
       
</xs:annotation>
     
</xs:attribute>
   
</xs:extension>
 
</xs:complexContent>
</xs:complexType>

attribute DescriptorReferenceType/@AsOfDate
properties
isRef 0
annotation
documentation
The date context in which this reference should be considered. This is important when descriptors change over time. If omitted, assumed to be the current descriptor.
source <xs:attribute name="AsOfDate">
 
<xs:annotation>
   
<xs:documentation>The date context in which this reference should be considered. This is important when descriptors change over time. If omitted, assumed to be the current descriptor.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute DescriptorReferenceType/@namespace
type URI
properties
isRef 0
use required
facets
Kind Value annotation 
minLength 
maxLength 255 
annotation
documentation
A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.
source <xs:attribute name="namespace" type="URI" use="required">
 
<xs:annotation>
   
<xs:documentation>A globally unique namespace that identifies this descriptor set. Author is strongly encouraged to use the Universal Resource Identifier (http, ftp, file, etc.) for the source of the descriptor definition. Best practice is for this source to be the descriptor file itself, so that it can be machine-readable and be fetched in real-time, if necessary.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

element DescriptorReferenceType/CodeValue
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p337.png
namespace http://ed-fi.org/0110
type CodeValue
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 50 
annotation
documentation
A code or abbreviation that is used to refer to the descriptor
source <xs:element name="CodeValue" type="CodeValue">
 
<xs:annotation>
   
<xs:documentation>A code or abbreviation that is used to refer to the descriptor</xs:documentation>
 
</xs:annotation>
</xs:element>

element DescriptorReferenceType/ShortDescription
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p338.png
namespace http://ed-fi.org/0110
type ShortDescription
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 75 
annotation
documentation
A shortened description for descriptor.
source <xs:element name="ShortDescription" type="ShortDescription">
 
<xs:annotation>
   
<xs:documentation>A shortened description for descriptor.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DescriptorReferenceType/Description
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p339.png
namespace http://ed-fi.org/0110
type Description
properties
isRef 0
content simple
facets
Kind Value annotation 
minLength 
maxLength 1024 
annotation
documentation
The long description.
source <xs:element name="Description" type="Description">
 
<xs:annotation>
   
<xs:documentation>The long description.</xs:documentation>
 
</xs:annotation>
</xs:element>