complexType DescriptorType
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p340.png
namespace http://ed-fi.org/0110
type extension of ComplexObjectType
properties
base ComplexObjectType
children CodeValue ShortDescription Description EffectiveBeginDate EffectiveEndDate PriorDescriptor
used by
complexTypes AcademicSubjectDescriptor AccommodationDescriptor AccountCodeDescriptor AdministrativeFundingControlDescriptor AssessmentPeriodDescriptor AttendanceEventCategoryDescriptor BehaviorDescriptor CalendarEventDescriptor ClassroomPositionDescriptor CompetencyLevelDescriptor ContinuationOfServicesReasonDescriptor CredentialFieldDescriptor DiagnosisDescriptor DisabilityDescriptor DisciplineDescriptor EmploymentStatusDescriptor EntryTypeDescriptor ExitWithdrawTypeDescriptor GradeLevelDescriptor GradingPeriodDescriptor GraduationPlanTypeDescriptor LanguageDescriptor LevelDescriptor LevelOfEducationDescriptor LimitedEnglishProficiencyDescriptor PerformanceLevelDescriptor ProgramAssignmentDescriptor ReasonExitedDescriptor ReporterDescriptionDescriptor ResidencyStatusDescriptor ResponsibilityDescriptor SchoolFoodServiceEligibilityDescriptor SectionCharacteristicsDescriptor SeparationReasonDescriptor ServiceDescriptor SpecialEducationSettingDescriptor StaffClassificationDescriptor TeachingCredentialTypeDescriptor WeaponDescriptor
attributes
Name  Type  Use  Default  Fixed  annotation
idxs:ID      
documentation
The XML ID associated with the complex object.
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
This is the base for the Descriptor type
appinfo
<ann:TypeGroup>Base</ann:TypeGroup>
source <xs:complexType name="DescriptorType">
 
<xs:annotation>
   
<xs:documentation>This is the base for the Descriptor type</xs:documentation>
   
<xs:appinfo>
     
<ann:TypeGroup>Base</ann:TypeGroup>
   
</xs:appinfo>
 
</xs:annotation>
 
<xs:complexContent>
   
<xs:extension base="ComplexObjectType">
     
<xs:sequence>
       
<xs:element name="CodeValue" type="CodeValue" minOccurs="0">
         
<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 the descriptor.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="Description" type="Description" minOccurs="0">
         
<xs:annotation>
           
<xs:documentation>The description of the descriptor.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="EffectiveBeginDate" type="xs:date" minOccurs="0">
         
<xs:annotation>
           
<xs:documentation>The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="EffectiveEndDate" type="xs:date" minOccurs="0">
         
<xs:annotation>
           
<xs:documentation>The end date of the period when the descriptor is in effect.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
       
<xs:element name="PriorDescriptor" type="DescriptorReferenceType" minOccurs="0">
         
<xs:annotation>
           
<xs:documentation>Immediately prior to the date in EffectiveDate, the reference to the equivalent descriptor.</xs:documentation>
         
</xs:annotation>
       
</xs:element>
     
</xs:sequence>
     
<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 DescriptorType/@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 DescriptorType/CodeValue
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p341.png
namespace http://ed-fi.org/0110
type CodeValue
properties
isRef 0
minOcc 0
maxOcc 1
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" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>A code or abbreviation that is used to refer to the descriptor.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DescriptorType/ShortDescription
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p342.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 the descriptor.
source <xs:element name="ShortDescription" type="ShortDescription">
 
<xs:annotation>
   
<xs:documentation>A shortened description for the descriptor.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DescriptorType/Description
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p343.png
namespace http://ed-fi.org/0110
type Description
properties
isRef 0
minOcc 0
maxOcc 1
content simple
facets
Kind Value annotation 
minLength 
maxLength 1024 
annotation
documentation
The description of the descriptor.
source <xs:element name="Description" type="Description" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The description of the descriptor.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DescriptorType/EffectiveBeginDate
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p344.png
namespace http://ed-fi.org/0110
type xs:date
properties
isRef 0
minOcc 0
maxOcc 1
content simple
annotation
documentation
The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.
source <xs:element name="EffectiveBeginDate" type="xs:date" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The beginning date of the period when the descriptor is in effect. If omitted, the default is immediate effectiveness.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DescriptorType/EffectiveEndDate
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p345.png
namespace http://ed-fi.org/0110
type xs:date
properties
isRef 0
minOcc 0
maxOcc 1
content simple
annotation
documentation
The end date of the period when the descriptor is in effect.
source <xs:element name="EffectiveEndDate" type="xs:date" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>The end date of the period when the descriptor is in effect.</xs:documentation>
 
</xs:annotation>
</xs:element>

element DescriptorType/PriorDescriptor
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p346.png
namespace http://ed-fi.org/0110
type DescriptorReferenceType
properties
isRef 0
minOcc 0
maxOcc 1
content complex
children CodeValue ShortDescription Description
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
Immediately prior to the date in EffectiveDate, the reference to the equivalent descriptor.
source <xs:element name="PriorDescriptor" type="DescriptorReferenceType" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Immediately prior to the date in EffectiveDate, the reference to the equivalent descriptor.</xs:documentation>
 
</xs:annotation>
</xs:element>