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

 


ResourcePropertyNameIsCollectionDATA_TYPEREQUIRED/

...

OPTIONAL

Scenario 1

POST

Scenario 2

POST

Scenario 3

PUT

Scenario 4

PUT

StudentsstudentUniqueIdFALSEstringREQUIRED111111222222111111222222

...

...

StudentsbirthCityFALSEstringREQUIREDGrand BendGrand BendGrand BendGrand Bend
StudentsbirthCountryDescriptorFALSEstringREQUIREDAGUSAGUS
Students

...

birthDateFALSEdateTime

...

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

...

  

...



Students

...

birthSexDescriptorFALSEstringOPTIONAL  

...



Students

...

birthStateAbbreviationDescriptorFALSE

...

string

...

REQUIRED

...

TX

...

TX

...

TX

...

VT
Students

...

citizenshipStatusDescriptorFALSEstringOPTIONAL  

Students

...

dateEnteredUSFALSE

...

dateTimeOPTIONAL  

...



Students

...

firstNameFALSEstringREQUIRED

...

...

Austin

...

Madison

...

Austin

...

Madison

...

Students

...

middleNameFALSEstringREQUIRED

...

...

Samuel

...

Mary

...

Samuel

...

Mary

...

Students

...

lastSurnameFALSEstringREQUIRED

...

...

Jones

...

Johnson

...

Jones

...

Johnson

...

REQUIRED*

...

StudentsgenerationCodeSuffixFALSEstringREQUIRED

...

654 Mission Hills

...

123 Cedar

...

654 Mission Hills

...

123 Cedar Street

...

JR JR
StudentsmaidenNameFALSEstringOPTIONAL  

...

Periods[]

...

OPTIONAL

...

OPTIONAL

...

OPTIONAL

...

REQUIRED*

...

REQUIRED*

...

REQUIRED*

...

REQUIRED*

...

REQUIRED*

...



StudentsmultipleBirthStatusFALSEbooleanOPTIONAL  

StudentspersonalTitlePrefixFALSEstringOPTIONAL  

StudentsidentificationDocumentsTRUEstudentIdentificationDocument[]OPTIONAL  

studentIdentificationDocumentsidentificationDocumentUseDescriptorFALSE

...

stringOPTIONAL  

...



studentIdentificationDocumentspersonalInformationVerificationDescriptorFALSE

...

stringOPTIONAL  

...



studentIdentificationDocumentsdocumentExpirationDateFALSEdateOPTIONAL

...

  

...



studentIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL

...

  

studentIdentificationDocumentsissuerCountryDescriptorFALSE

...

stringOPTIONAL  

...



studentIdentificationDocumentsissuerDocumentIdentificationCodeFALSEstringOPTIONAL  

...



studentIdentificationDocumentsissuerNameFALSEstringOPTIONAL

...

  

Students

...

OPTIONAL

...

OPTIONAL

...

OPTIONAL

...

REQUIRED*

...

REQUIRED*

...

...

otherNamesTRUEstudentOtherName[]OPTIONAL  

...



studentOtherNamesfirstNameFALSEstringOPTIONAL  

...



studentOtherNameslastSurnameFALSEstringOPTIONAL

...

  

studentOtherNamesotherNameTypeDescriptorFALSE

...

stringOPTIONAL

...

  

studentOtherNamesgenerationCodeSuffixFALSEstringOPTIONAL

...

  

...



studentOtherNamesmiddleNameFALSEstringOPTIONAL  

...



studentOtherNamespersonalTitlePrefixFALSEstringOPTIONAL  

...



StudentspersonalIdentificationDocumentsTRUEpersonalIdentificationDocuments[]OPTIONAL  

studentPersonalIdentificationDocumentsdocumentTitleFALSEstringOPTIONAL

...

 

...

 

...



studentPersonalIdentificationDocumentspersonalInformationVerificationDescriptor

...

FALSE

...

stringOPTIONAL

...

 

...

 

studentPersonalIdentificationDocuments

...

documentExpirationDateFALSEstringOPTIONAL

...

 

...

 

studentPersonalIdentificationDocuments

...

issuerDocumentIdentificationCodeFALSE

...

Black - African American

...

Black - African American

...

REQUIRED*

...

stringOPTIONAL  

studentPersonalIdentificationDocumentsissuerNameFALSEstring

...

REQUIRED*

...

OPTIONAL  

studentPersonalIdentificationDocumentsissuerCountryDescriptorFALSEstringOPTIONAL  

...



studentPersonalIdentificationDocuments

...

identificationDocumentUseDescriptor

...

FALSE

...

stringOPTIONAL

...

  

...



StudentsvisasTRUEstudentVisa[]OPTIONAL  

studentVisasvisaDescriptorFALSEintegerOPTIONAL 

...

Students

...

tribalAffiliations

...

TRUE

...

TribalAffiliations[]

...

OPTIONAL

...

studentTribalAffiliations

...

tribalAffiliationDescriptor

...

FALSE

...

String

...