WI DPI WISEdata Ed-Fi Docs

/studentAcademicRecords

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.

Term Descriptor

2.0

educationOrganizationId*

integer

CONDITINALLY REQ'D

CONDITINALLY REQ'D

The identifier assigned to an education organization.

Education Organization Reference

3.0

schoolYear*

integer

CONDITINALLY REQ'D

CONDITINALLY REQ'D

Key for School Year

School Year

4.0

studentUniqueId*

string

CONDITINALLY REQ'D

CONDITINALLY REQ'D

A unique alphanumeric code assigned to a student.

WISEid

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.

Credential Type (Diploma Type)

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.

Achievement Category


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.

  • Diploma Type 'R' should be used for successful GED Option #2 completers because these students are granted regular high school diplomas meeting the requirements of §118.33 (1) (a), (d), or (g), Wis. Stats.

  • The achievement category is Diploma Earned.

POST on / studentAcademicRecords:
educationOrganizationReference:
educationOrganizationId: 16
schoolYearTypeReference:
schoolYear: 2022
studentReference:
studentUniqueId: 5357536841
termDescriptor: uri://dpi.wi.gov/TermDescriptor#A
diplomas:
diplomaAwardDate: 2022-06-15
diplomaTypeDescriptor: uri://dpi.wi.gov/DiplomaTypeDescriptor#R
achievementCategoryDescriptor: uri://dpi.wi.gov/AchievementCategoryDescriptor#D

2.0

Sending a student academic record for a student who completed high school with a High School Equivalency diploma type

  • Any high school equivalency credential issued by the State Superintendent under §115.29 (4)(a), Stats.

  • Includes an HSED1 issued to any student who was not granted a diploma by a school board under §118.33(1)(a), (d), or (g), Stats.

  • The achievement category is Diploma Earned.

POST on / studentAcademicRecords:
educationOrganizationReference:
educationOrganizationId: 16
schoolYearTypeReference:
schoolYear: 2022
studentReference:
studentUniqueId: 5357536841
termDescriptor: uri://dpi.wi.gov/TermDescriptor#A
diplomas:
diplomaAwardDate: 2022-06-15
diplomaTypeDescriptor: uri://dpi.wi.gov/DiplomaTypeDescriptor#HSE
achievementCategoryDescriptor: uri://dpi.wi.gov/AchievementCategoryDescriptor#D

3.0

Sending a student academic record for a student who completed high school with Other diploma type

  • Any high school completion credential issued by a school board that is not a diploma meeting the requirements of §118.33 (1) (a), (d), or (g), Stats.

  • Includes any high school completion credential issued to any student who was neither granted a diploma by a school board under §118.33(1)(a), (d), or (g), Stats., nor issued a high school equivalency credential by the State Superintendent under §115.29 (4)(a), Stats. Examples include certificate of completion and certificate of attendance.

  • The achievement category is Certificate Earned.

POST on / studentAcademicRecords:
educationOrganizationReference:
educationOrganizationId: 16
schoolYearTypeReference:
schoolYear: 2022
studentReference:
studentUniqueId: 5357536841
termDescriptor: uri://dpi.wi.gov/TermDescriptor#A
diplomas:
diplomaAwardDate: 2022-06-15
diplomaTypeDescriptor: uri://dpi.wi.gov/DiplomaTypeDescriptor#O
achievementCategoryDescriptor: uri://dpi.wi.gov/AchievementCategoryDescriptor#C

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.

  • SIS vendors may post either a single ‘Annual’ studentAcademicRecord or multiple studentAcademicRecords, then use them for CourseTranscripts.

  • SIS vendors may send studentAcademicRecords and courseTranscripts for grade levels 7 and 8, but are not required.

  • When a the student receives a Diploma, an additional SAR with 'Annual' termDescriptor and the diploma details (diploma type & achievement category) must be submitted from the student's most recent enrolled school.

POST on / studentAcademicRecords:
educationOrganizationReference:
educationOrganizationId: 16
schoolYearTypeReference:
schoolYear: 2022
studentReference:
studentUniqueId: 5357536841
termDescriptor: uri://dpi.wi.gov/TermDescriptor#T1


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