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

Create a 7-year-old Student, which will be later enrolled at Grand Bend Elementary School.
Create a 15-year-old Student, which will be later enrolled at Grand Bend High School.
Update the Birth date on the first Student.
Update the Birth City on the second Student.

Resource	Property Name	Is Collection	Data Type	Required / Optional	Scenario 1 POST	Scenario 2 POST	Scenario 3 PUT	Scenario 4 PUT
Students	studentUniqueId	FALSE	string	REQUIRED	111111	222222	111111	222222
Students	birthCity	FALSE	string	REQUIRED	Grand Bend	Grand Bend	Grand Bend	Grand Oaks
Students	birthCountryDescriptor	FALSE	birthCountryDescriptor	REQUIRED	AG	US	AG	US
Students	birthDate	FALSE	date	REQUIRED	1/1/2009	1/1/2001	1/2/2009	1/1/2001
Students	birthInternationalProvince	FALSE	string	OPTIONAL
Students	birthSexDescriptor	FALSE	string	OPTIONAL
Students	birthStateAbbreviationDescriptor	FALSE	birthStateAbbreviationDescriptor	OPTIONAL
Students	citizenshipStatusDescriptor	FALSE	citizenshipStatusDescriptor	OPTIONAL
Students	dateEnteredUS	FALSE	date	OPTIONAL
Students	firstName	FALSE	string	REQUIRED	Austin	Madison	Austin	Madison
Students	middleName	FALSE	string	REQUIRED	Samuel	Mary	Samuel	Mary
Students	lastSurname	FALSE	string	REQUIRED	Jones	Johnson	Jones	Johnson
Students	generationCodeSuffix	FALSE	string	CONDITIONAL	JR		JR
Students	maidenName	FALSE	string	OPTIONAL
Students	multipleBirthStatus	FALSE	boolean	OPTIONAL
Students	personalTitlePrefix	FALSE	string	CONDITIONAL	Mr.	Ms.	Mr.	Ms.
Students	identificationDocuments	TRUE	studentIdentificationDocument[]	OPTIONAL
studentIdentificationDocuments	identificationDocumentUseDescriptor	FALSE	identificationDocumentUseDescriptor	OPTIONAL
studentIdentificationDocuments	personalInformationVerificationDescriptor	FALSE	personalInformationVerificationDescriptor	OPTIONAL
studentIdentificationDocuments	documentExpirationDate	FALSE	date	OPTIONAL
studentIdentificationDocuments	documentTitle	FALSE	string	OPTIONAL
studentIdentificationDocuments	issuerCountryDescriptor	FALSE	issuerCountryDescriptor	OPTIONAL
studentIdentificationDocuments	issuerDocumentIdentificationCode	FALSE	string	OPTIONAL
studentIdentificationDocuments	issuerName	FALSE	string	OPTIONAL
Students	otherNames	TRUE	studentOtherName[]	OPTIONAL
studentOtherNames	firstName	FALSE	string	OPTIONAL
studentOtherNames	lastSurname	FALSE	string	OPTIONAL
studentOtherNames	otherNameTypeDescriptor	FALSE	otherNameTypeDescriptor	OPTIONAL
studentOtherNames	generationCodeSuffix	FALSE	string	OPTIONAL
studentOtherNames	middleName	FALSE	string	OPTIONAL
studentOtherNames	personalTitlePrefix	FALSE	string	OPTIONAL
Students	personalIdentificationDocuments	TRUE	personalIdentificationDocuments[]	OPTIONAL
studentPersonalIdentificationDocuments	documentTitle	FALSE	string	OPTIONAL
studentPersonalIdentificationDocuments	personalInformationVerificationDescriptor	FALSE	personalInformationVerificationDescriptor	OPTIONAL
studentPersonalIdentificationDocuments	documentExpirationDate	FALSE	string	OPTIONAL
studentPersonalIdentificationDocuments	issuerDocumentIdentificationCode	FALSE	string	OPTIONAL
studentPersonalIdentificationDocuments	issuerName	FALSE	string	OPTIONAL
studentPersonalIdentificationDocuments	issuerCountryDescriptor	FALSE	issuerCountryDescriptor	OPTIONAL
studentPersonalIdentificationDocuments	identificationDocumentUseDescriptor	FALSE	identificationDocumentUseDescriptor	OPTIONAL
Students	visas	TRUE	studentVisa[]	OPTIONAL
studentVisas	visaDescriptor	FALSE	visaDescriptor	OPTIONAL

Ed-Fi Certification

v3 Student > Student Scenarios

Analytics

Prerequisites

Scenarios

Related content