v3 Student > Student Scenarios

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.



ResourceProperty NameIs CollectionData TypeRequired / Optional

Scenario 1
POST

Scenario 2
POST

Scenario 3
PUT

Scenario 4
PUT

StudentsstudentUniqueIdFALSEstringREQUIRED111111222222111111222222
StudentsbirthCityFALSEstringREQUIREDGrand BendGrand BendGrand BendGrand Oaks
StudentsbirthCountryDescriptorFALSEbirthCountryDescriptorREQUIREDAGUSAGUS
StudentsbirthDateFALSEdateREQUIRED 1/1/2009 1/1/2001 1/2/2009 1/1/2001
StudentsbirthInternationalProvinceFALSEstringOPTIONAL
StudentsbirthSexDescriptorFALSEstringOPTIONAL
StudentsbirthStateAbbreviationDescriptorFALSEbirthStateAbbreviationDescriptorOPTIONAL
StudentscitizenshipStatusDescriptorFALSEcitizenshipStatusDescriptorOPTIONAL
StudentsdateEnteredUSFALSEdateOPTIONAL
StudentsfirstNameFALSEstringREQUIREDAustinMadisonAustinMadison
StudentsmiddleNameFALSEstringREQUIREDSamuelMarySamuelMary
StudentslastSurnameFALSEstringREQUIREDJonesJohnsonJonesJohnson
StudentsgenerationCodeSuffixFALSEstringCONDITIONALJR
JR
StudentsmaidenNameFALSEstringOPTIONAL
StudentsmultipleBirthStatusFALSEbooleanOPTIONAL
StudentspersonalTitlePrefixFALSEstringCONDITIONALMr. Ms. Mr.Ms.
StudentsidentificationDocumentsTRUEstudentIdentificationDocument[]OPTIONAL
studentIdentificationDocumentsidentificationDocumentUseDescriptorFALSEidentificationDocumentUseDescriptorOPTIONAL
studentIdentificationDocumentspersonalInformationVerificationDescriptorFALSEpersonalInformationVerificationDescriptorOPTIONAL
studentIdentificationDocumentsdocumentExpirationDateFALSEdateOPTIONAL
studentIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL
studentIdentificationDocumentsissuerCountryDescriptorFALSEissuerCountryDescriptorOPTIONAL
studentIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL
studentIdentificationDocumentsissuerNameFALSEstringOPTIONAL
StudentsotherNamesTRUEstudentOtherName[]OPTIONAL
studentOtherNamesfirstNameFALSEstringOPTIONAL
studentOtherNameslastSurnameFALSEstringOPTIONAL
studentOtherNamesotherNameTypeDescriptorFALSEotherNameTypeDescriptorOPTIONAL
studentOtherNamesgenerationCodeSuffixFALSEstringOPTIONAL
studentOtherNamesmiddleNameFALSEstringOPTIONAL
studentOtherNamespersonalTitlePrefixFALSEstringOPTIONAL
StudentspersonalIdentificationDocumentsTRUEpersonalIdentificationDocuments[]OPTIONAL
studentPersonalIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL
studentPersonalIdentificationDocumentspersonalInformationVerificationDescriptorFALSEpersonalInformationVerificationDescriptorOPTIONAL
studentPersonalIdentificationDocumentsdocumentExpirationDateFALSEstringOPTIONAL
studentPersonalIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL
studentPersonalIdentificationDocumentsissuerNameFALSEstringOPTIONAL
studentPersonalIdentificationDocumentsissuerCountryDescriptorFALSEissuerCountryDescriptorOPTIONAL
studentPersonalIdentificationDocumentsidentificationDocumentUseDescriptorFALSEidentificationDocumentUseDescriptorOPTIONAL
StudentsvisasTRUEstudentVisa[]OPTIONAL
studentVisasvisaDescriptorFALSEvisaDescriptorOPTIONAL