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

...

  1. Birth date on the first Student.
  2. Update the

...

  1. Birth City on the second Student.

 



Resource

...

Property Name

...

REQUIRED/

OPTIONAL

Is CollectionData TypeRequired / Optional

Scenario 1
POST

Scenario 2
POST

Scenario 3
PUT

Scenario 4
PUT

StudentsstudentUniqueIdFALSEstringREQUIRED111111222222111111222222

...

...

Students

...

birthCityFALSEstringREQUIREDGrand BendGrand BendGrand BendGrand

...

Oaks
StudentsbirthCountryDescriptorFALSE

...

birthCountryDescriptorREQUIREDAGUSAGUS
Students

...

birthDateFALSE

...

dateREQUIRED

...

 1/1/2009 1/1/2001 1/2/2009 1/1/2001
StudentsbirthInternationalProvinceFALSEstringOPTIONAL

...

...


Students

...

birthSexDescriptorFALSE

...

string

...

...

OPTIONAL

...

...


Students

...

birthStateAbbreviationDescriptorFALSE

...

birthStateAbbreviationDescriptorOPTIONAL

...


Students

...

citizenshipStatusDescriptorFALSE

...

citizenshipStatusDescriptorOPTIONAL

...

...


Students

...

dateEnteredUSFALSE

...

dateOPTIONAL

...

...


Students

...

firstNameFALSEstringREQUIRED

...

Austin

...

Madison

...

Austin

...

Madison
Students

...

middleNameFALSEstringREQUIRED

...

Samuel

...

Mary

...

Samuel

...

Mary
Students

...

lastSurnameFALSEstringREQUIRED

...

...

Jones

...

REQUIRED*

...

REQUIRED*

...

REQUIRED*

...

REQUIRED*

...

654 Mission Hills

...

654 Mission Hills

...

Periods[]

...

REQUIRED*

...

OPTIONAL

...

OPTIONAL

...

OPTIONAL

...

OPTIONAL

...

REQUIRED*

...

REQUIRED*

...

REQUIRED*

...

REQUIRED*

...

REQUIRED*

...

Johnson

...

Temporary

...

JonesJohnson
StudentsgenerationCodeSuffixFALSEstringCONDITIONALJR
JR
StudentsmaidenNameFALSEstringOPTIONAL
StudentsmultipleBirthStatusFALSEbooleanOPTIONAL
StudentspersonalTitlePrefixFALSEstringCONDITIONALMr. Ms. Mr.Ms.
StudentsidentificationDocumentsTRUEstudentIdentificationDocument[]OPTIONAL

...


studentIdentificationDocuments

...

identificationDocumentUseDescriptorFALSEidentificationDocumentUseDescriptorOPTIONAL

...


studentIdentificationDocuments

...

personalInformationVerificationDescriptorFALSEpersonalInformationVerificationDescriptorOPTIONAL

...

...


studentIdentificationDocumentsdocumentExpirationDateFALSEdateOPTIONAL

...

...


studentIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL

...


studentIdentificationDocumentsissuerCountryDescriptorFALSEissuerCountryDescriptorOPTIONAL

...


studentIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL

...

...


studentIdentificationDocumentsissuerName

...

REQUIRED*

...

REQUIRED*

...

OPTIONAL

...

OPTIONAL

...

OPTIONAL

...

FALSE

...

...

stringOPTIONAL

...

...


Students

...

...

REQUIRED*

...

REQUIRED*

...

OPTIONAL

...

OPTIONAL

...

OPTIONAL

...

otherNamesTRUEstudentOtherName[]OPTIONAL

...

...


studentOtherNamesfirstNameFALSEstringOPTIONAL

...

...


studentOtherNameslastSurnameFALSEstringOPTIONAL

...

...


studentOtherNames

...

otherNameTypeDescriptorFALSE

...

otherNameTypeDescriptorOPTIONAL

...


studentOtherNamesgenerationCodeSuffixFALSEstringOPTIONAL

...


studentOtherNamesmiddleNameFALSEstringOPTIONAL

...

...


studentOtherNamespersonalTitlePrefixFALSEstringOPTIONAL

...

...


StudentspersonalIdentificationDocumentsTRUE

...

personalIdentificationDocuments[]OPTIONAL
studentPersonalIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL
studentPersonalIdentificationDocumentspersonalInformationVerificationDescriptorFALSEpersonalInformationVerificationDescriptor

...

OPTIONAL
studentPersonalIdentificationDocumentsdocumentExpirationDateFALSE

...

stringOPTIONAL
studentPersonalIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL
studentPersonalIdentificationDocumentsissuerNameFALSEstringOPTIONAL
studentPersonalIdentificationDocumentsissuerCountryDescriptorFALSEissuerCountryDescriptorOPTIONAL
studentPersonalIdentificationDocumentsidentificationDocumentUseDescriptorFALSEidentificationDocumentUseDescriptor

...

OPTIONAL

...

studentProgramParticipationProgramCharacteristic[]

...

OPTIONAL

...

Black - African American

...

Black - African American

...

...


Students

...

...

REQUIRED*

...

REQUIRED*

...

visasTRUEstudentVisa[]OPTIONAL

...


studentVisas

...

studentTribalAffiliations

...

tribalAffiliationDescriptor

...

FALSE

...

String

...

OPTIONAL

 

 

 

...

visaDescriptorFALSE

...

OPTIONAL

 

...

Students

...

tribalAffiliations

...

TRUE

...

TribalAffiliations[]

...

OPTIONAL

visaDescriptorOPTIONAL