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 Birth date on the first Student.
  4. Update the Birth City on the second Student.



Resource

...

Property Name

...

Is CollectionData TypeRequired / Optional

Scenario 1
POST

Scenario 2
POST

Scenario 3
PUT

Scenario 4
PUT

StudentsstudentUniqueIdFALSEstringREQUIRED111111222222111111222222
StudentsbirthCityFALSEstringREQUIREDGrand BendGrand BendGrand BendGrand Oaks
StudentsbirthCountryDescriptorFALSE

...

birthCountryDescriptorREQUIREDAGUSAGUS
StudentsbirthDateFALSEdateREQUIRED 1/1/2009 1/1/2001 1/2/2009 1/1/2001
StudentsbirthInternationalProvinceFALSEstringOPTIONAL
StudentsbirthSexDescriptorFALSEstringOPTIONAL
StudentsbirthStateAbbreviationDescriptorFALSE

...

birthStateAbbreviationDescriptorOPTIONAL
StudentscitizenshipStatusDescriptorFALSE

...

citizenshipStatusDescriptorOPTIONAL
StudentsdateEnteredUSFALSEdateOPTIONAL
StudentsfirstNameFALSEstringREQUIREDAustinMadisonAustinMadison
StudentsmiddleNameFALSEstringREQUIREDSamuelMarySamuelMary
StudentslastSurnameFALSEstringREQUIREDJonesJohnsonJonesJohnson
StudentsgenerationCodeSuffixFALSEstring

...

CONDITIONALJR
JR
StudentsmaidenNameFALSEstringOPTIONAL
StudentsmultipleBirthStatusFALSEbooleanOPTIONAL
StudentspersonalTitlePrefixFALSEstringCONDITIONALMr. Ms. Mr.Ms.
StudentsidentificationDocumentsTRUEstudentIdentificationDocument[]OPTIONAL
studentIdentificationDocumentsidentificationDocumentUseDescriptorFALSE

...

identificationDocumentUseDescriptorOPTIONAL
studentIdentificationDocumentspersonalInformationVerificationDescriptorFALSE

...

personalInformationVerificationDescriptorOPTIONAL
studentIdentificationDocumentsdocumentExpirationDateFALSEdateOPTIONAL
studentIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL
studentIdentificationDocumentsissuerCountryDescriptorFALSE

...

issuerCountryDescriptorOPTIONAL
studentIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL
studentIdentificationDocumentsissuerNameFALSEstringOPTIONAL
StudentsotherNamesTRUEstudentOtherName[]OPTIONAL
studentOtherNamesfirstNameFALSEstringOPTIONAL
studentOtherNameslastSurnameFALSEstringOPTIONAL
studentOtherNamesotherNameTypeDescriptorFALSE

...

otherNameTypeDescriptorOPTIONAL
studentOtherNamesgenerationCodeSuffixFALSEstringOPTIONAL
studentOtherNamesmiddleNameFALSEstringOPTIONAL
studentOtherNamespersonalTitlePrefixFALSEstringOPTIONAL
StudentspersonalIdentificationDocumentsTRUEpersonalIdentificationDocuments[]OPTIONAL
studentPersonalIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL
studentPersonalIdentificationDocumentspersonalInformationVerificationDescriptorFALSE

...

personalInformationVerificationDescriptorOPTIONAL
studentPersonalIdentificationDocumentsdocumentExpirationDateFALSEstringOPTIONAL
studentPersonalIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL
studentPersonalIdentificationDocumentsissuerNameFALSEstringOPTIONAL
studentPersonalIdentificationDocumentsissuerCountryDescriptorFALSE

...

issuerCountryDescriptorOPTIONAL
studentPersonalIdentificationDocumentsidentificationDocumentUseDescriptorFALSE

...

identificationDocumentUseDescriptorOPTIONAL
StudentsvisasTRUEstudentVisa[]OPTIONAL
studentVisasvisaDescriptorFALSE

...

visaDescriptorOPTIONAL