WI DPI WISEdata Ed-Fi Docs
/student
Jaidaa Shafaei
heather.kluck
The order of posting JSON is /student, /studentschoolAssociation, then /StudentEducationOrganizationAssociation. Without posting the student enrollment record (studentschoolAssociation) you cannot do a GET on /student.
This endpoint is expected from Choice schools.
Ed-Fi Tech Docs: https://techdocs.ed-fi.org/display/EDFICERT/Student+%3E+Student
Data Properties:
# | Property Name | Data Type | Public (Required/ Optional/ Conditional) | Choice (Required/ Optional/ Conditional) | Business Definition | Data Element Page |
|---|---|---|---|---|---|---|
1.0 | studentUniqueId* | string | REQ'D | REQ'D | A unique alphanumeric code assigned to a student. This is the student's WISEid. Valid WISEids must be loaded into the vendor's application prior to sending transactions to the API. | |
2.0 | birthDate | dateTime | REQ'D | REQ'D | The month, day, and year on which an individual was born. | |
3.0 | firstName | string | REQ'D | REQ'D | A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. | |
4.0 | middleName | string | OPT | OPT | A secondary name given to an individual at birth, baptism, or during another naming ceremony. | |
5.0 | lastSurname | string | REQ'D | REQ'D | The name borne in common by members of a family. | |
6.0 | generationCodeSuffix |
| OPT | OPT | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). | |
7.0 | multipleBirthStatus | boolean | OPT | OPT | Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.) | |
8.0 | dateEnteredUS | dateTime | OPT | OPT | For students born outside of the U.S., the date the student entered the U.S. | |
9.0 | visas: visaDescriptor | array | CONDITINALLY REQ'D | NOT REQ'D | An unordered collection of studentVisas. Describe the types of Visa that a non-U.S. citizen student holds. | |
10.0 | birthCity | string | OPT | OPT | The city the student was born in. | |
11.0 | birthStateAbbreviationDescriptor | string | OPT | OPT | The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born. | |
12.0 | birthCountryDescriptor | string | OPT | OPT | The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes. |
Use Cases:
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|
# | Use Case Title | Use Case Description | What to Submit/retrieve |
|---|---|---|---|
1.0 | Sending the name for a student who uses the legal name from the birth certificate to identify themselves | A student legal name will be reported under the /student endpoint and will be displayed in WISE applications. The student name (FirstName, middleName, LastSurName, generationCodeSuffix) must be the same in three places: | POST on /Student |
2.0 | Sending the name for a student who use an alternative name to identify themselves (e.g. Jimmy for James) | For students, who use a nickname such as a shortened version of their legal name, their alternative name may be preferred over their legal name. However, this alternative name should NOT be reported to WISEdata. While not required, LEAs may report the alternative names in WISEid Upload File manually or inside the WISEid App under Other Names. | Not submitted to WISEdata |
3.0 | Sending the name for a transgender student whose birth certificate may or may not be updated. | LEAs can submit the name for transgender students in the name field even if they have not changed their name on the birth certificate. Note that this is the name that will flow through DPI applications and to vendors.
WISEid app, for purposes of finding possible matches in the match review process over time and across districts, the legal name from the birth certificate could be (not required) used in the “Other Name” field (for persons under 18, with permission from the family).
| POST on /Student Name changed to POST on /Student |
4.0 | Sending the name for a student who use another name to identify themselves for other purposes (abuse survivals, students with incorrect name format on other documents, etc.) | LEAs can change the student name to reflect the new name with which the person uses consistently (such as a change in last name due to marriage) even if they have not changed their name on the birth certificate. Note that this is the name that will flow through DPI applications and to vendors.
WISEid app, for purposes of finding possible matches in the match review process over time and across districts, the legal name from the birth certificate could be (not required) used in the “Other Name” field (for persons under 18, with permission from the family).
| POST on /student: Name changed to POST on /student: |
5.0 | Sending a student born outside of the U.S | For students born outside of the U.S., the date the student entered the U.S. should be submitted (this data element should NOT be sent for U.S. students returning to the school after a temporary foreign exchange experience). Also, for foreign exchange students, the visa type must be submitted (more than one Visa can be submitted) | POST on /student: |
6.0 | Sending a student's the birth location details | Birth location is primarily used to assist with identification and student matching. | POST on /Student: |
7.0 | Sending a student born with other siblings i.e. twins | For students born with other siblings, i.e., twins, triplets, etc., the multiple birth status must be submitted. | POST on /student: |
JSON Sample:
{
"studentUniqueId": "8660232105",
"firstName": "Aiko",
"middleName": "qJpT",
"lastSurname": "Rose",
"birthDate": "2007-04-18",
"multipleBirthStatus": "False",
"generationCodeSuffix": "",
"dateEnteredUS": "2018-08-12",
"visas": [{
"visaDescriptor": "uri://dpi.wi.gov/VisaDescriptor#F1"
}],
"birthCity": "Madison",
"birthCountryDescriptor": "uri://dpi.wi.gov/CountryDescriptor#US",
"birthStateAbbreviationDescriptor": "uri://ed-fi.org/StateAbbreviationDescriptor#WI"
}
Wisconsin Department of Public Instruction