Versions Compared

Key

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

This interchange defines students and contains all their identifying information.

This entity represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency or other institution or program. A student is a person who has been enrolled in a school or other educational institution.

Prerequisites

  • None

Scenarios

  1. Create a 7-year-old Student, which will be later enrolled at Grand Bend Elementary School.
  2. Create a 15-year-old Student, which will be later enrolled at Grand Bend High School.
  3. Update the Phone number on the first Student.
  4. Update the Address on the second Student.

 

ResourcePropertyNameIsCollectionDATA_TYPE

REQUIRED/

OPTIONAL

Scenario 1

POST

Scenario 2

POST

Scenario 3

PUT

Scenario 4

PUT

StudentsstudentUniqueIdFALSEstringREQUIRED111111222222111111222222
StudentsbirthDateFALSEdateTimeREQUIRED 1/1/2009 1/1/2001 1/1/2009 1/1/2001
StudentsfirstNameFALSEstringREQUIREDAustinMadisonAustinMadison
StudentsmiddleNameFALSEstringREQUIREDSamuelMarySamuelMary
StudentslastSurnameFALSEstringREQUIREDJonesJohnsonJonesJohnson
StudentshispanicLatinoEthnicityFALSEbooleanREQUIREDfalsefalsefalsefalse
StudentssexDescriptorFALSEintegerREQUIREDMaleFemaleMaleFemale
StudentsbirthCityFALSEstringREQUIREDGrand BendGrand BendGrand BendGrand Bend
StudentsbirthCountryDescriptorFALSEstringREQUIREDAGUSAGUS
StudentsbirthInternationalProvinceFALSEstringOPTIONAL    
StudentsbirthStateAbbreviationDescriptorFALSEintegerREQUIREDTXTXTXTX
StudentscitizenshipStatusDescriptorFALSEintegerOPTIONAL    
StudentsdateEnteredUSFALSEdateTimeOPTIONAL
 
 
StudentsdisplacementStatusFALSEstringOPTIONAL    
StudentseconomicDisadvantagedeconomicDisadvantagedFALSEbooleanREQUIREDFALSEFALSEFALSEFALSE
StudentsgenerationCodeSuffixFALSEstringREQUIREDJR JR 
StudentslimitedEnglishProficiencyDescriptorlimitedEnglishProficiencyDescriptorFALSEstringREQUIREDNotLimitedNotLimitedNotLimitedNotLimited
StudentsloginIdFALSEstringOPTIONAL    
StudentsmaidenNameFALSEstringOPTIONAL    
StudentsmultipleBirthStatusFALSEbooleanOPTIONAL    
StudentsoldEthnicityDescriptorFALSEintegerOPTIONAL    
StudentspersonalTitlePrefixFALSEstringREQUIREDMr Mr 
StudentsprofileThumbnailFALSEstringOPTIONAL    
StudentsschoolFoodServicesEligibilityDescriptorschoolFoodServicesEligibilityDescriptorFALSEstringREQUIREDReduced price Reduced price 
StudentsaddressesTRUEstudentAddress[]OPTIONAL 
StudentAddressaddressTypeDescriptorFALSEstring

REQUIRED*

Temporary
Home
Temporary
Home
StudentAddresscityFALSEstring

REQUIRED*

Grand BendGrand BendGrand BendGrand Bend
StudentAddresspostalCodeFALSEstring

REQUIRED*

78834788347883478834
StudentAddressstateAbbreviationDescriptorFALSEinteger

REQUIRED*

TXTXTXTX
StudentAddressstreetNumberNameFALSEstring

REQUIRED*

654 Mission Hills
123 Cedar
654 Mission Hills
123 Cedar Street
StudentAddressapartmentRoomSuiteNumberFALSEstringOPTIONAL    
StudentAddressbeginDateFALSEdateTimeOPTIONAL    
StudentAddressbuildingSiteNumberFALSEstringOPTIONAL    
StudentAddresscountyFIPSCodeFALSEstringOPTIONAL    
StudentAddressendDateFALSEdateTimeOPTIONAL    
StudentAddresslatitudeFALSEstringOPTIONAL    
StudentAddresslongitudeFALSEstringOPTIONAL    
StudentAddressnameOfCountyFALSEstringOPTIONAL    
StudentAddress
doNotPublishIndicatorFALSEbooleanOPTIONAL



StudentAddressPeriodsTRUE

Periods[]

OPTIONAL



PeriodBeginDateFALSEstringOPTIONAL



PeriodEndDateFALSEstringOPTIONAL



studentscharacteristicsTRUEstudentCharacteristic[]OPTIONAL 
StudentCharacteristicsdescriptorFALSEstring

REQUIRED*

Migrant Migrant 
StudentCharacteristicsbeginDateFALSEdateTimeOPTIONAL    
StudentCharacteristicsdesignatedByFALSEstringOPTIONAL    
StudentCharacteristicsendDateFALSEdateOPTIONAL    
studentscohortYearsTRUEstudentCohortYear[]OPTIONAL 
studentCohortYearscohortYearTypeDescriptorFALSEstring

OPTIONAL

    
studentCohortYearsschoolYearTypeReferenceFALSEschoolYearTypeReference

OPTIONAL

 
schoolYearTypeReferenceschoolYearFALSEinteger

OPTIONAL

    
studentsdisadisabilitiesTRUEstudentDisability[]OPTIONAL 
StudentDisabilitiesdisabilityDescriptorFALSEstring

OPTIONAL

    
studentDisabilitiesdisabilityDeterminationSourceTypeFALSEstringOPTIONAL    
StudentDisabilitiesdisabilityDiagnosisFALSEstringOPTIONAL    
StudentDisabilitiesorderOfDisabilityFALSEintegerOPTIONAL    
StudentselectronicMailsTRUEstudentElectronicMail[]REQUIRED 
StudentElectronicMailselectronicMailAddressFALSEstring

REQUIRED*

Austin@edficert.orgMadison@edficert.orgAustin@edficert.orgMadison@edficert.org
StudentElectronicMailselectronicMailTypeDescriptorFALSEinteger

REQUIRED*

OtherOtherOtherOther
StudentElectronicMailsprimaryEmailAddressIndicatorFALSEbooleanOPTIONAL    
StudentElectronicMailsdoNotPublishIndicatorFALSEbooleanOPTIONAL



studentsidentificationCodesTRUEstudentIdentificationCode[]REQUIRED 
StudentIdentificationCodesassigningOrganizationIdentificationCodeFALSEstring

REQUIRED*

StateStateStateState
StudentIdentificationCodesidentificationCodeFALSEstring

REQUIRED*

704705704705
StudentIdentificationCodesstudentIdentificationSystemDescriptorFALSEstring

REQUIRED*

StateStateStateState
studentsidentificationDocumentsTRUEstudentIdentificationDocument[]OPTIONAL 
StudentIdentificationDocumentsidentificationDocumentUseDescriptorFALSEintegeridentificationDocumentUseDescriptor

OPTIONAL

    
StudentIdentificationDocumentspersonalInformationVerificationDescriptorFALSEintegerpersonalInformationVerificationDescriptor

OPTIONAL

    
StudentIdentificationDocumentsdocumentExpirationDateFALSEdateTimedateOPTIONAL    
StudentIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL    
StudentIdentificationDocumentsissuerCountryDescriptorFALSEstringissuerCountryDescriptor
OPTIONAL    
StudentIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL    
StudentIdentificationDocumentsissuerNameFALSEstringOPTIONAL    
studentsindicatorsTRUEstudentIndicator[]OPTIONAL 
StudentIndicatorsindicatorFALSEstring

REQUIRED*

True True 
StudentIndicatorsindicatorNameFALSEstring

REQUIRED*

At Risk At Risk 
StudentIndicatorsbeginDateFALSEdateTimeOPTIONAL    
StudentIndicatorsdesignatedByFALSEstringOPTIONAL    
StudentIndicatorsendDateFALSEdatetimeOPTIONAL    
StudentIndicatorsindicatorGroupFALSEstringOPTIONAL    
studentsinternationalAddressesTRUEstudentInternationalAddress[]OPTIONAL 
StudentInternationalAddresssaddressLine1FALSEstring

OPTIONAL

    
StudentInternationalAddresssaddressTypeDescriptorFALSEinteger

OPTIONAL

    
StudentInternationalAddressscountryDescriptorFALSEstring

OPTIONAL

    
StudentInternationalAddresssaddressLine2FALSEstringOPTIONAL    
StudentInternationalAddresssaddressLine3FALSEstringOPTIONAL    
StudentInternationalAddresssaddressLine4FALSEstringOPTIONAL    
StudentInternationalAddresssbeginDateFALSEdateTimeOPTIONAL    
StudentInternationalAddresssendDateFALSEdateTimeOPTIONAL    
StudentInternationalAddressslatitudeFALSEstringOPTIONAL    
StudentInternationalAddressslongitudeFALSEstringOPTIONAL    
studentslanguagesTRUEstudentLanguage[]OPTIONAL 
StudentLanguagesusesTRUEstudentLanguageUse[]OPTIONAL 
StudentLanguageslanguageDescriptorFALSEstring

REQUIRED*

Spanish Spanish 
StudentLanguageUseslanguageUseslanguageUseDescriptorFALSEstring

REQUIRED*

Home language Home language 
StudentslearningStyleFALSEstudentLearningStyleOPTIONAL    
StudentLearningStylesauditoryLearningFALSEdecimal

OPTIONAL

    
StudentLearningStylestactileLearningFALSEdecimal

OPTIONAL

    
StudentLearningStylesvisualLearningFALSEdecimal

OPTIONAL

    
StudentsotherNamesTRUEstudentOtherName[]OPTIONAL    
StudentOtherNamesfirstNameFALSEstring

OPTIONAL

    
StudentOtherNameslastSurnameFALSEstring

OPTIONAL

    
StudentOtherNamesotherNameotherNameTypeDescriptorFALSEinteger

OPTIONAL

    
StudentOtherNamesgenerationCodeSuffixFALSEstringOPTIONAL    
StudentOtherNamesmiddleNameFALSEstringOPTIONAL    
StudentOtherNamespersonalTitlePrefixFALSEstringOPTIONAL    
StudentspersonalIdentificationDocumentsTRUEpersonalIdentificationDocuments[]OPTIONAL



StudentPersonalIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL



StudentPersonalIdentificationDocumentspersonalInformationVerificationDescriptorFALSEpersonalInformationVerificationDescriptorREQUIRED*



StudentPersonalIdentificationDocumentsdocumentExpirationDateFALSEdateOPTIONAL



StudentPersonalIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL



StudentPersonalIdentificationDocumentsissuerNameFALSEstringOPTIONAL



StudentPersonalIdentificationDocumentsissuerCountryDescriptorFALSEissuerCountryDescriptorOPTIONAL



StudentPersonalIdentificationDocumentsidentificationDocumentUseDescriptorFALSEidentificationDocumentUseDescriptorREQUIRED*



StudentsprogramParticipationsTRUEstudentProgramParticipation[]OPTIONAL    
StudentProgramParticipationsprogramTypeFALSEintegerOPTIONAL    
StudentProgramParticipationsbeginDateFALSEdatetimeOPTIONAL    
StudentProgramParticipationsdesignatedByFALSEstringOPTIONAL    
StudentProgramParticipationsendDateFALSEdatetimeOPTIONAL    
studentProgramParticipationsprogramCharacteristicsTRUE

studentProgramParticipationProgramCharacteristic[]

OPTIONAL 
studentProgramParticipationProgramCharacteristicprogramCharacteristicDescriptorFALSEstring

OPTIONAL

    
StudentsracesTRUEstudentRace[]OPTIONAL 
StudentRacesraceDescriptorFALSEintegerREQUIRED*

Black - African American

White

Black - African American

White
studentstelephonesTRUEstudentTelephone[]OPTIONAL 
StudentTelephonestelephoneNumberFALSEstring

REQUIRED*

111-222-3333 111-222-4444 
StudentTelephonestelephoneNumberTypeDescriptor FALSEinteger

REQUIRED*

Home Home 
StudentTelephonesorderOfPriorityFALSEintegerOPTIONAL    
StudentTelephonestextMessageCapabilityIndicatorFALSEbooleanOPTIONAL    
StudentTelephonesdoNotPublishIndicatorFALSEbooleanOPTIONAL



studentsvisasTRUEstudentVisa[]OPTIONAL 
StudentVisasvisaDescriptorFALSEinteger

OPTIONAL

 

    

students

TribalAffiliations[]

TRUE

TribalAffiliations[]

OPTIONAL





TribalAffiliations

tribalAffiliationDescriptor

FalseFALSE

String

OPTIONAL