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.

 

string
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
 
 
StudentsgenerationCodeSuffixFALSEstringREQUIREDJR JR 
StudentsloginIdFALSEstringOPTIONAL    
StudentsmaidenNameFALSEstringOPTIONAL    
StudentsmultipleBirthStatusFALSEbooleanOPTIONAL    
StudentsoldEthnicityDescriptorFALSEintegerOPTIONAL    
StudentspersonalTitlePrefixFALSEstringOPTIONAL
 
 
StudentsprofileThumbnailFALSEstringOPTIONAL    
StudentsschoolFoodServicesEligibilityDescriptorFALSEREQUIREDReduced price Reduced price StudentsaddressesTRUEstudentAddress[]OPTIONAL 
studentAddressesaddressTypeDescriptorFALSEstring

REQUIRED*

Temporary

Home

Home

Temporary

Home

Home

studentAddressescityFALSEstring

REQUIRED*

Grand BendGrand BendGrand BendGrand Bend
studentAddressespostalCodeFALSEstring

REQUIRED*

78834788347883478834
studentAddressesstateAbbreviationDescriptorFALSEinteger

REQUIRED*

TXTXTXTX
studentAddressesstreetNumberNameFALSEstring

REQUIRED*

654

Mission

Hills

123 Cedar

654

Mission

Hills

123 Cedar Street

studentAddressesapartmentRoomSuiteNumberFALSEstringOPTIONAL    
studentAddressesbuildingSiteNumberFALSEstringOPTIONAL    
studentAddressescountyFIPSCodeFALSEstringOPTIONAL    
studentAddresseslatitudeFALSEstringOPTIONAL    
studentAddresseslongitudeFALSEstringOPTIONAL    
studentAddressesnameOfCountyFALSEstringOPTIONAL    
studentAddressesdoNotPublishIndicatorFALSEbooleanOPTIONAL



studentAddressesperiodsTRUE

Periods[]

OPTIONAL



studentAddressPeriodsbeginDateFALSEstringOPTIONAL



studentAddressPeriodsendDateFALSEstringOPTIONAL



StudentscohortYearsTRUEstudentCohortYear[]OPTIONAL 
studentCohortYearscohortYearTypeDescriptorFALSEstring

OPTIONAL

    
studentCohortYearsschoolYearTypeReferenceFALSEschoolYearTypeReference

OPTIONAL

 
schoolYearTypeReferenceschoolYearFALSEinteger

OPTIONAL

    
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 
studentIdentificationDocumentsidentificationDocumentUseDescriptorFALSEidentificationDocumentUseDescriptor

OPTIONAL

    
studentIdentificationDocumentspersonalInformationVerificationDescriptorFALSEpersonalInformationVerificationDescriptor

OPTIONAL

    
studentIdentificationDocumentsdocumentExpirationDateFALSEdateOPTIONAL    
studentIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL    
studentIdentificationDocumentsissuerCountryDescriptorFALSEissuerCountryDescriptorOPTIONAL    
studentIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL    
studentIdentificationDocumentsissuerNameFALSEstringOPTIONAL    
StudentsinternationalAddressesTRUEstudentInternationalAddress[]OPTIONAL 
studentInternationalAddressesaddressLine1FALSEstring

OPTIONAL

    
studentInternationalAddressesaddressTypeDescriptorFALSEinteger

OPTIONAL

    
studentInternationalAddressescountryDescriptorFALSEstring

OPTIONAL

    
studentInternationalAddressesaddressLine2FALSEstringOPTIONAL    
studentInternationalAddressesaddressLine3FALSEstringOPTIONAL    
studentInternationalAddressesaddressLine4FALSEstringOPTIONAL    
studentInternationalAddressesbeginDateFALSEdateTimeOPTIONAL    
studentInternationalAddressesendDateFALSEdateTimeOPTIONAL    
studentInternationalAddresseslatitudeFALSEstringOPTIONAL    
studentInternationalAddresseslongitudeFALSEstringOPTIONAL    
StudentslanguagesTRUEstudentLanguage[]OPTIONAL 
studentLanguagesusesTRUEstudentLanguageUse[]OPTIONAL 
studentLanguageslanguageDescriptorFALSEstring

REQUIRED*

Spanish Spanish 
studentLanguageUseslanguageUseDescriptorFALSEstring

REQUIRED*

Home language Home language 
StudentsotherNamesTRUEstudentOtherName[]OPTIONAL    
studentOtherNamesfirstNameFALSEstring

OPTIONAL

    
studentOtherNameslastSurnameFALSEstring

OPTIONAL

    
studentOtherNamesotherNameTypeDescriptorFALSEinteger

OPTIONAL

    
studentOtherNamesgenerationCodeSuffixFALSEstringOPTIONAL    
studentOtherNamesmiddleNameFALSEstringOPTIONAL    
studentOtherNamespersonalTitlePrefixFALSEstringOPTIONAL    
StudentspersonalIdentificationDocumentsTRUEpersonalIdentificationDocuments[]OPTIONAL



studentPersonalIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL



studentPersonalIdentificationDocumentspersonalInformationVerificationDescriptorFALSEpersonalInformationVerificationDescriptorREQUIRED*



studentPersonalIdentificationDocumentsdocumentExpirationDateFALSEdateOPTIONAL



studentPersonalIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL



studentPersonalIdentificationDocumentsissuerNameFALSEstringOPTIONAL



studentPersonalIdentificationDocumentsissuerCountryDescriptorFALSEissuerCountryDescriptorOPTIONAL



studentPersonalIdentificationDocumentsidentificationDocumentUseDescriptorFALSEidentificationDocumentUseDescriptorREQUIRED*



StudentsracesTRUEstudentRace[]OPTIONAL 
studentRacesraceDescriptorFALSEintegerREQUIRED*

Black - African American

White

Black - African American

White
StudentstelephonesTRUEstudentTelephone[]OPTIONAL 
studentTelephonestelephoneNumberFALSEstring

REQUIRED*

111-222-3333 111-222-4444 
studentTelephonestelephoneNumberTypeDescriptorFALSEinteger

REQUIRED*

Home Home 
studentTelephonesorderOfPriorityFALSEintegerOPTIONAL    
studentTelephonestextMessageCapabilityIndicatorFALSEbooleanOPTIONAL    
studentTelephonesdoNotPublishIndicatorFALSEbooleanOPTIONAL



StudentsvisasTRUEstudentVisa[]OPTIONAL 
studentVisasvisaDescriptorFALSEinteger

OPTIONAL

 

    

Students

tribalAffiliations

TRUE

TribalAffiliations[]

OPTIONAL





studentTribalAffiliations

tribalAffiliationDescriptor

FALSE

String

OPTIONAL





 

...