complexType DescriptorType
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p413.png
namespace http://ed-fi.org/0200
type extension of ComplexObjectType
properties
base ComplexObjectType
abstract true
children CodeValue ShortDescription Description EffectiveBeginDate EffectiveEndDate PriorDescriptor Namespace
used by
complexTypes AcademicSubjectDescriptor AccommodationDescriptor AccountCodeDescriptor AchievementCategoryDescriptor AdministrativeFundingControlDescriptor AssessmentCategoryDescriptor AssessmentIdentificationSystemDescriptor AssessmentPeriodDescriptor AttendanceEventCategoryDescriptor BehaviorDescriptor CalendarEventDescriptor ClassroomPositionDescriptor CompetencyLevelDescriptor ContinuationOfServicesReasonDescriptor CountryDescriptor CourseIdentificationSystemDescriptor CredentialFieldDescriptor DiagnosisDescriptor DisabilityDescriptor DisciplineDescriptor EducationOrganizationIdentificationSystemDescriptor EmploymentStatusDescriptor EntryTypeDescriptor ExitWithdrawTypeDescriptor GradeLevelDescriptor GradingPeriodDescriptor GraduationPlanTypeDescriptor LanguageDescriptor LevelDescriptor LevelOfEducationDescriptor LimitedEnglishProficiencyDescriptor PerformanceLevelDescriptor ProgramAssignmentDescriptor ProgramCharacteristicDescriptor ReasonExitedDescriptor ReporterDescriptionDescriptor ResidencyStatusDescriptor ResponsibilityDescriptor SchoolFoodServicesEligibilityDescriptor SectionCharacteristicDescriptor SeparationReasonDescriptor ServiceDescriptor SpecialEducationSettingDescriptor StaffClassificationDescriptor StaffIdentificationSystemDescriptor StudentCharacteristicDescriptor StudentIdentificationSystemDescriptor TeachingCredentialDescriptor TermDescriptor WeaponDescriptor
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:ID        
documentation
The XML ID associated with the complex object.
annotation
documentation
This is the base for the Descriptor type.
appinfo
<ann:TypeGroup>Base</ann:TypeGroup>
<ann:EdFiId>255</ann:EdFiId>
source <xs:complexType name="DescriptorType" abstract="true">
  <xs:annotation>
    <xs:documentation>This is the base for the Descriptor type.</xs:documentation>
    <xs:appinfo>
      <ann:TypeGroup>Base</ann:TypeGroup>
      <ann:EdFiId>255</ann:EdFiId>
    </xs:appinfo>
  </xs:annotation>
  <xs:complexContent>
    <xs:extension base="ComplexObjectType">
      <xs:sequence>
        <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:appinfo>
              <ann:EdFiId>256</ann:EdFiId>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element name="ShortDescription" type="ShortDescription">
          <xs:annotation>
            <xs:documentation>A shortened description for the descriptor.</xs:documentation>
            <xs:appinfo>
              <ann:EdFiId>257</ann:EdFiId>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element name="Description" type="Description" minOccurs="0">
          <xs:annotation>
            <xs:documentation>The description of the descriptor.</xs:documentation>
            <xs:appinfo>
              <ann:EdFiId>258</ann:EdFiId>
            </xs:appinfo>
          </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:appinfo>
              <ann:EdFiId>259</ann:EdFiId>
            </xs:appinfo>
          </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:appinfo>
              <ann:EdFiId>260</ann:EdFiId>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element name="PriorDescriptor" type="DescriptorReferenceType" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Immediately prior to the date in Effective Date, the reference to the equivalent descriptor.</xs:documentation>
            <xs:appinfo>
              <ann:EdFiId>261</ann:EdFiId>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element name="Namespace" type="URI">
          <xs:annotation>
            <xs:documentation>A globally unique identifier for this descriptor.</xs:documentation>
            <xs:appinfo>
              <ann:EdFiId>262</ann:EdFiId>
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

element DescriptorType/CodeValue
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p414.png
namespace http://ed-fi.org/0200
type CodeValue
properties
content simple
facets
Kind Value Annotation
minLength 1
maxLength 50
annotation
documentation
A code or abbreviation that is used to refer to the descriptor.
appinfo
<ann:EdFiId>256</ann:EdFiId>
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:appinfo>
      <ann:EdFiId>256</ann:EdFiId>
    </xs:appinfo>
  </xs:annotation>
</xs:element>

element DescriptorType/ShortDescription
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p415.png
namespace http://ed-fi.org/0200
type ShortDescription
properties
content simple
facets
Kind Value Annotation
minLength 1
maxLength 75
annotation
documentation
A shortened description for the descriptor.
appinfo
<ann:EdFiId>257</ann:EdFiId>
source <xs:element name="ShortDescription" type="ShortDescription">
  <xs:annotation>
    <xs:documentation>A shortened description for the descriptor.</xs:documentation>
    <xs:appinfo>
      <ann:EdFiId>257</ann:EdFiId>
    </xs:appinfo>
  </xs:annotation>
</xs:element>

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

element DescriptorType/EffectiveBeginDate
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p417.png
namespace http://ed-fi.org/0200
type xs:date
properties
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.
appinfo
<ann:EdFiId>259</ann:EdFiId>
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:appinfo>
      <ann:EdFiId>259</ann:EdFiId>
    </xs:appinfo>
  </xs:annotation>
</xs:element>

element DescriptorType/EffectiveEndDate
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p418.png
namespace http://ed-fi.org/0200
type xs:date
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
The end date of the period when the descriptor is in effect.
appinfo
<ann:EdFiId>260</ann:EdFiId>
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:appinfo>
      <ann:EdFiId>260</ann:EdFiId>
    </xs:appinfo>
  </xs:annotation>
</xs:element>

element DescriptorType/PriorDescriptor
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p419.png
namespace http://ed-fi.org/0200
type DescriptorReferenceType
properties
minOcc 0
maxOcc 1
content complex
children CodeValue Namespace
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:ID        
documentation
The XML ID associated with this complex object.
ref  xs:IDREF        
documentation
The XML IDREF that references the object associated with this object.
annotation
documentation
Immediately prior to the date in Effective Date, the reference to the equivalent descriptor.
appinfo
<ann:EdFiId>261</ann:EdFiId>
source <xs:element name="PriorDescriptor" type="DescriptorReferenceType" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Immediately prior to the date in Effective Date, the reference to the equivalent descriptor.</xs:documentation>
    <xs:appinfo>
      <ann:EdFiId>261</ann:EdFiId>
    </xs:appinfo>
  </xs:annotation>
</xs:element>

element DescriptorType/Namespace
diagram Ed-Fi-Core_diagrams/Ed-Fi-Core_p420.png
namespace http://ed-fi.org/0200
type URI
properties
content simple
facets
Kind Value Annotation
minLength 5
maxLength 255
annotation
documentation
A globally unique identifier for this descriptor.
appinfo
<ann:EdFiId>262</ann:EdFiId>
source <xs:element name="Namespace" type="URI">
  <xs:annotation>
    <xs:documentation>A globally unique identifier for this descriptor.</xs:documentation>
    <xs:appinfo>
      <ann:EdFiId>262</ann:EdFiId>
    </xs:appinfo>
  </xs:annotation>
</xs:element>