Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Student Enrollment interchange describes student enrollments in schools and in sections.

This association represents student information that is specific to a student's relationship with an EducationOrganization. Enrollment relationship semantics are covered by /wiki/spaces/EDFI/pages/22450000.

Prerequisites

  • Student

Scenarios

  1. Create a Student EdOrg Association for an elementary Student at Grand Bend School District.*
  2. Create a Student EdOrg Association for a high school Student at Grand Bend School District.*
  3. Update the Phone number on the first Student.
  4. Update the Address on the second Student.

Additional Requirements

  • For these scenarios SIS system MUST demonstrate that it can provide 3 student identifiers: a SIS/district ID, a state ID, and a local ID (also known as a "student number", which students typically memorize and use for local operations). In terms of studentIdentificationSystemDescriptors, these are the "District", "State" and "Local" values in the default Ed-Fi descriptor values, respectively.
  • The SIS MUST include at least these three values in the StudentIdentificationCodes array and the studentIdentificationSystemDescriptors MUST be labeled as "District", "State" and "Local" per the definitions above.
  • If the SIS only has a subset of these values, values can be repeated as needed. For example, the SIS might use the SIS/district ID as the local ID (student number); in this case, that ID would be repeated in the array as both the "District" and "Local" values.




ResourceProperty NameIs CollectionData Type

Required / Optional

Scenario 1
POST

Scenario 2
POST

Scenario 3
POST/PUT
Scenario 4 POST/PUT
StudentEducationOrganizationAssociationseducationOrganizationReferenceFALSEeducationOrganizationReferenceREQUIRED  
educationOrganizationReferenceeducationOrganizationIdFALSEintegerREQUIRED255901  255901255901 255901 
StudentEducationOrganizationAssociationsstudentReferenceFALSEstudentReferenceREQUIRED
studentReferencestudentUniqueIdFALSEstringREQUIRED111111222222111111222222
StudentEducationOrganizationAssociationslimitedEnglishProficiencyDescriptorFALSEstringlimitedEnglishProficiencyDescriptorREQUIREDNotLimitedNotLimitedNotLimitedNotLimited
StudentEducationOrganizationAssociationsdisabilitiesTRUEdisability[]OPTIONAL
studentEducationOrganizationAssociationDisabilitiesdisabilityDescriptorFALSEstringdisabilityDescriptorOPTIONAL
studentEducationOrganizationAssociationDisabilitiesdisabilityDeterminationSourceTypeFALSEstringOPTIONAL
studentEducationOrganizationAssociationDisabilitiesdisabilityDiagnosisFALSEstringOPTIONAL
studentEducationOrganizationAssociationDisabilitiesorderOfDisabilityFALSEintegerOPTIONAL
studentEducationOrganizationAssociationDisabilitiesdesignationsTRUEdesignations[]OPTIONAL
studentEducationOrganizationAssociationDisabilityDesignationsdisabilityDesignationDescriptorFALSEstringdisabilityDesignationDescriptorOPTIONAL
StudentEducationOrganizationAssociationsprogramParticipationsTRUEprogramParticipations[]OPTIONAL
studentEducationOrganizationAssociationProgramParticipationsprogramTypeDescriptorFALSEstringprogramTypeDescriptorOPTIONAL
studentEducationOrganizationAssociationProgramParticipationsbeginDateFALSEstringOPTIONAL
studentEducationOrganizationAssociationProgramParticipationsdesignatedByFALSEstringOPTIONAL
studentEducationOrganizationAssociationProgramParticipationsendDateFALSEstringOPTIONAL
studentEducationOrganizationAssociationProgramParticipationsprogramCharacteristicsTRUEprogramCharacteristicsOPTIONAL
studentEducationOrganizationAssociationProgramParticipationProgramCharacteristicsprogramCharacteristicDescriptorFALSEstringprogramCharacteristicDescriptorOPTIONAL
StudentEducationOrganizationAssociationsstudentCharacteristicsTRUEstudentCharacteristics[]REQUIRED
studentEducationOrganizationAssociationStudentCharacteristicsstudentCharacteristicDescriptorFALSEstringstudentCharacteristicDescriptorREQUIREDImmigrantEconomic DisadvantagedImmigrantEconomic Disadvantaged
studentEducationOrganizationAssociationStudentCharacteristicsdesignatedByFALSEstringOPTIONAL
studentEducationOrganizationAssociationStudentCharacteristicsperiodsTRUEperiods[]OPTIONAL
studentEducationOrganizationAssociationStudentCharacteristicPeriodsbeginDateFALSEstringOPTIONAL
studentEducationOrganizationAssociationStudentCharacteristicPeriodsendDateFALSEstringOPTIONAL
StudentEducationOrganizationAssociationsstudentIndicatorsTRUEstudentIndicators[]OPTIONAL
studentEducationOrganizationAssociationStudentIndicatorsindicatorNameFALSEstringOPTIONAL
studentEducationOrganizationAssociationStudentIndicatorsindicatorGroupFALSEstringOPTIONAL
studentEducationOrganizationAssociationStudentIndicatorsindicatorFALSEstringOPTIONAL
studentEducationOrganizationAssociationStudentIndicatorsdesignatedByFALSEstringOPTIONAL
studentEducationOrganizationAssociationStudentIndicatorsperiodsTRUEperiodsOPTIONAL
studentEducationOrganizationAssociationStudentIndicatorPeriodsbeginDateFALSEstringOPTIONAL
studentEducationOrganizationAssociationStudentIndicatorPeriodsendDateFALSEstringOPTIONAL
studentEducationOrganizationAssociationsStudentIdentificationCodesTRUE studentIdentificationCodes [ ] REQUIRED
studentEducationOrganizationAssociationsStudentIdentificationCodesassigningOrganizationIdentificationCodeFALSEstringREQUIREDState, District, and Local (CONDITIONAL)State, District, and Local (CONDITIONAL)State, District, and Local (CONDITIONAL)State, District, and Local (CONDITIONAL)
studentEducationOrganizationAssociationsStudentIdentificationCodesidentificationCodeFALSEstringREQUIRED[system values]
[system values]
[system values][system values]
studentEducationOrganizationAssociationsStudentIdentificationCodesstudentIdentificationSystemDescriptorFALSEstringstudentIdentificationSystemDescriptorREQUIREDState, District, and Local (CONDITIONAL)State, District, and Local (CONDITIONAL)State, District, and Local (CONDITIONAL)State, District, and Local (CONDITIONAL)
studentEducationOrganizationAssociationssexDescriptorFALSEstringsexDescriptorREQUIREDMaleFemaleMaleFemale
studentEducationOrganizationAssociationsAddressesaddressesTRUEaddresses[]REQUIRED
studentEducationOrganizationAssociationsAddressesaddressTypeDescriptorFALSEstringaddressTypeDescriptorCONDITIONALHomeHomeHomeHome
studentEducationOrganizationAssociationsAddressescityFALSEstringREQUIREDGrand BendGrand BendGrand BendGrand Bend
studentEducationOrganizationAssociationsAddressespostalCodeFALSEstringREQUIRED78834788347883478834
studentEducationOrganizationAssociationsAddressesstateAbbreviationDescriptorFALSEstringstateAbbreviationDescriptorREQUIREDTXTXTXTX
studentEducationOrganizationAssociationsAddressesstreetNumberNameFALSEstringREQUIRED654 Mission Hills123 Cedar Street654 Mission Hills123 Cedar Circle
studentEducationOrganizationAssociationsAddressesapartmentRoomSuiteNumberFALSEstringOPTIONAL
studentEducationOrganizationAssociationsAddressesbuildingSiteNumberFALSEstringOPTIONAL
studentEducationOrganizationAssociationsAddressescountyFIPSCodeFALSEstringOPTIONAL
studentEducationOrganizationAssociationsAddresseslatitudeFALSEstringOPTIONAL
studentEducationOrganizationAssociationsAddresseslongitudeFALSEstringOPTIONAL
studentEducationOrganizationAssociationsAddressesnameOfCFALSEstringOPTIONAL
studentEducationOrganizationAssociationsAddressesdoNotPublishIndicatorFALSEbooleanOPTIONAL
studentEducationOrganizationAssociationsAddressesperiodsTRUEPeriods[]OPTIONAL
studentEducationOrganizationAssociationsAddressPeriodsbeginDateFALSEstringOPTIONAL
studentEducationOrganizationAssociationsAddressPeriodsendDateFALSEstringOPTIONAL
StudstudentEducationOrganizationAssociationsinternationalAddressesTRUEstudentInternationalAddress[]OPTIONAL
studentEducationOrganizationAssociationsInternationalAddressesaddressLine1FALSEstringOPTIONAL
studentEducationOrganizationAssociationsInternationalAddressesaddressTypeDescriptorFALSEstringaddressTypeDescriptorOPTIONAL
studentEducationOrganizationAssociationsInternationalAddressescountryDescriptorFALSEstringcountryDescriptorOPTIONAL
studentEducationOrganizationAssociationsInternationalAddressesaddressLine2FALSEstringOPTIONAL
studentEducationOrganizationAssociationsInternationalAddressesaddressLine3FALSEstringOPTIONAL
studentEducationOrganizationAssociationsInternationalAddressesaddressLine4FALSEstringOPTIONAL
studentEducationOrganizationAssociationsInternationalAddressesbeginDateFALSEdateOPTIONAL
studentEducationOrganizationAssociationsInternationalAddressesendDateFALSEdateOPTIONAL
studentEducationOrganizationAssociationsInternationalAddresseslatitudeFALSEstringOPTIONAL
studentEducationOrganizationAssociationsInternationalAddresseslongitudeFALSEstringOPTIONAL
StudstudentEducationOrganizationAssociationstelephonesTRUEstudentTelephone[]REQUIRED
studentEducationOrganizationAssociationsTelephonestelephoneNumberFALSEstringREQUIRED111-222-3333
111-222-4444
studentEducationOrganizationAssociationsTelephonestelephoneNumberTypeDescriptorFALSEstringtelephoneNumberTypeDescriptorREQUIREDHome
Home
studentEducationOrganizationAssociationsTelephonesorderOfPriorityFALSEintegerOPTIONAL
studentEducationOrganizationAssociationsTelephonestextMessageCapabilityIndicatorFALSEbooleanOPTIONAL
studentEducationOrganizationAssociationsTelephonesdoNotPublishIndicatorFALSEbooleanOPTIONAL
studentEducationOrganizationAssociationselectronicMailsTRUEElectronicMail[]REQUIRED
studentEducationOrganizationAssociationsElectronicMailselectronicMailAddressFALSEstringREQUIREDAustin@edficert.orgMadison@edficert.orgAustin@edficert.orgMadison@edficert.org
studentEducationOrganizationAssociationsElectronicMailselectronicMailTypeDescriptorFALSEstringelectronicMailTypeDescriptorREQUIREDOtherOtherOtherOther
studentEducationOrganizationAssociationsElectronicMailsprimaryEmailAddressIndicatorFALSEbooleanOPTIONAL
studentEducationOrganizationAssociationsElectronicMailsdoNotPublishIndicatorFALSEbooleanOPTIONAL
studentEducationOrganizationAssociationsprofileThumbnailFALSEstringOPTIONAL
studentEducationOrganizationAssociationshispanicLatinoEthnicityFALSEbooleanREQUIREDFALSEFALSEFALSEFALSE
studentEducationOrganizationAssociationsoldEthnicityDescriptorFALSEstringoldEthnicityDescriptorOPTIONAL
studentEducationOrganizationAssociationsracesTRUEstudentRace[]OPTIONAL
studentEducationOrganizationAssociationsRacesraceDescriptorFALSEintegerraceDescriptorREQUIREDBlack - African AmericanWhiteBlack - African AmericanWhite
studentEducationOrganizationAssociationstribalAffiliationsTRUEtribalAffiliations[]OPTIONAL
studentEducationOrganizationAssociationsStudentTribalAffiliationstribalAffiliationDescriptorFALSEStringtribalAffiliationDescriptorOPTIONAL
studentEducationOrganizationAssociationslanguagesTRUEstudentLanguage[]OPTIONAL
studentEducationOrganizationAssociationsStudentLanguageslanguageDescriptorFALSEstringlanguageDescriptorREQUIREDspa
spa
studentEducationOrganizationAssociationsStudentLanguagesusesTRUEstudentLanguageUse[]OPTIONAL
studentEducationOrganizationAssociationsLanguageUseslanguageUseDescriptorFALSEstringlanguageUseDescriptorREQUIREDHome language
Home language
studentEducationOrganizationAssociationscohortYearsTRUEstudentCohortYear[]OPTIONAL
studentEducationOrganizationAssociationsCohortYearscohortYearTypeDescriptorFALSEstringcohortYearTypeDescriptorOPTIONAL
studentEducationOrganizationAssociationsCohortYearsschoolYearTypeReferenceFALSEschoolYearTypeReferenceOPTIONAL