WI DPI WISEdata Ed-Fi Docs
/studentAcademicRecords
- Jaidaa Shafaei
- heather.kluck
The Student Academic Record (SAR) represents the cumulative record of academic achievement for a student and is used for reporting high school diplomas.
This endpoint is expected from Choice schools.
Ed-Fi Tech Docs: v3 Student Transcript > StudentAcademicRecord - Ed-Fi Certification - Ed-Fi TechDocs
Data Properties:
# | Property Name | Data Type | Public (Required/ Optional/ Conditional) | Choice (Required/ Optional/ Conditional) | Business Definition | Data Element Page |
---|---|---|---|---|---|---|
1.0 | termDescriptor* | string | CONDITINALLY REQ'D | CONDITINALLY REQ'D | The term for the session during the school year. | |
2.0 | educationOrganizationId* | integer | CONDITINALLY REQ'D | CONDITINALLY REQ'D | The identifier assigned to an education organization. | |
3.0 | schoolYear* | integer | CONDITINALLY REQ'D | CONDITINALLY REQ'D | Key for School Year | |
4.0 | studentUniqueId* | string | CONDITINALLY REQ'D | CONDITINALLY REQ'D | A unique alphanumeric code assigned to a student. | |
5.0 | diplomaTypeDescriptor | string | CONDITINALLY REQ'D | CONDITINALLY REQ'D | The type of diploma/credential that is awarded to a student in recognition of his/her completion of the curricular requirements. | |
6.0 | diplomaAwardDate | string | CONDITINALLY REQ'D | CONDITINALLY REQ'D | The month, day, and year on which the student met graduation requirements and was awarded a diploma. | NA |
7.0 | achievementCategoryDescriptor | string | CONDITINALLY REQ'D | CONDITINALLY REQ'D | The category of achievement attributed to the learner. |
Descriptors:
Namespace | Code Value | Short Description | Long Description |
---|
Namespace | Code Value | Short Description | Long Description |
---|---|---|---|
uri://dpi.wi.gov/TermDescriptor | A | Annual | Annual |
uri://dpi.wi.gov/DiplomaTypeDescriptor | HSE | High school equivalency credential, other than GED | High school equivalency credential, other than GED |
O | Other diploma | Other diploma | |
R | Regular diploma | Regular diploma | |
uri://dpi.wi.gov/AchievementCategoryDescriptor | C | Certificate Earned | Certificate Earned |
D | Diploma Earned | Diploma Earned |
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 a student academic record for a student who completed high school with a Regular diploma type | The term "regular high school diploma" means the standard high school diploma that is awarded to students in the State and that is fully aligned with the State's academic content standards or a higher diploma and does not include a General Educational Development (GED) credential, certificate of attendance, or any alternative award.
| POST on / studentAcademicRecords: |
2.0 | Sending a student academic record for a student who completed high school with a High School Equivalency diploma type |
| POST on / studentAcademicRecords: |
3.0 | Sending a student academic record for a student who completed high school with Other diploma type |
| POST on / studentAcademicRecords: |
4.0 | Updating a student academic record | If the updated data property is a primary key, then vendors will need to insert a new graduationPlan record, then delete the old studentAcademicRecord. If the updated data property is NOT a primary key, then vendors would simply update the data property for an existing studentAcademicRecord. | NA |
5.0 | Sending a student academic record for a student with non-primary enrollment type | studentAcademicRecord from non-primary school enrolment is NOT required | NA |
6.0 | Submit a student academic record without diploma details as a prerequisite for sending courseTranscripts | Course transcripts link to the student academic record for the session in which the course was taken. Therefore, LEAs who like to integrate their SIS with Xello need to send student academic records without the diploma details.
| POST on / studentAcademicRecords: |
JSON Sample:
{
"termDescriptor": "uri://dpi.wi.gov/TermDescriptor#A",
"educationOrganizationReference": {
"educationOrganizationId": 7525
},
"schoolYearTypeReference": {
"schoolYear": 2021
},
"studentReference": {
"studentUniqueId": "8660232105"
},
"diplomas": [{
"diplomaTypeDescriptor": "uri://dpi.wi.gov/DiplomaTypeDescriptor#O",
"diplomaAwardDate": "2021-06-12",
"achievementCategoryDescriptor": "uri://dpi.wi.gov/AchievementCategoryDescriptor#LC"
}]
}
Â
Wisconsin Department of Public Instruction