WI DPI WISEdata Ed-Fi Docs
Course Transcripts (Public LEA Only)
Jaidaa Shafaei
In an effort to help integrate Xello’s Course Planner tool with the Student Information System (SIS), DPI has developed an integration that enables Xello to retrieve course transcripts from the WISEdata API and store them back into the Course Planner tool. Course Transcript is an optional integration for SIS vendors. SIS vendors that implemented this integration will send the course transcripts to the WISEdata API, which allows Xello to get the data directly through the WISEdata API instead of relying on flat files and exports. School districts may need to check their SIS Ed-Fi configuration and make sure CourseTranscript and StudentAcademicRecord are enabled.
Course Transcript is the final record of a student's performance in their courses at the end of a semester or school year. Course transcript data is not displayed on the student page in WISEdata Portal, however, school districts may download the Course Transcript export to view what their SIS vendor sent to the WISEdata API.
Ed-Fi Tech Docs: https://techdocs.ed-fi.org/display/EDFICERT/v3+Student+Transcript+%3E+CourseTranscript
Data Properties:
# | Property Name | Data Type | Public (Required/ Optional/ Conditional) | Choice (Required/ Optional/ Conditional) | Business Definition | Data Element Page |
1.0 | courseAttemptResultDescriptor | string | REQ'D | NOT REQ'D | The result from the student's attempt to take the course, for example: Pass Fail Incomplete Withdrawn. | NA |
2.0 | courseCode | string | OPT | NOT REQ'D | A unique alphanumeric code assigned to a course. | |
3.0 | educationOrganizationId | integer | REQ'D | NOT REQ'D | The identifier assigned to an education organization. | Education Organization Reference
|
4.0 | schoolYear | integer | REQ'D | NOT REQ'D | The identifier for the school year. | NA |
5.0 | studentUniqueId | string | REQ'D | NOT REQ'D | A unique alphanumeric code assigned to a student. | NA |
6.0 | termDescriptor | string | REQ'D | NOT REQ'D | The term for the session during the school year. | NA |
7.0 | alternativeCourseCode (used by Xello) | string | OPT | NOT REQ'D | The local code assigned by the school that identifies the course offering, the code from an external educational organization, or other alternate course code. | |
8.0 | alternativeCourseTitle (used by Xello) | string | OPT | NOT REQ'D | The descriptive name given to a course of study offered in the school, if different from the CourseTitle. | |
9.0 | AttemptedCredits | number | REQ'D | NOT REQ'D | The value of credits or units of value awarded for the completion of a course. | NA |
10.0 | earnedCredits | number | OPT | NOT REQ'D | The value of credits or units of value awarded for the completion of a course. | NA |
11.0 | finalLetterGradeEarned (used by Xello) | string | CONDITINALLY REQ'D | NOT REQ'D | The final indicator of student performance in a class as submitted by the instructor. | |
12.0 | finalNumericGradeEarned (used by Xello) | number | CONDITINALLY REQ'D | NOT REQ'D | The final indicator of student performance in a class as submitted by the instructor. | |
13.0 | whenTakenGradeLevelDescriptor | string | REQ'D | NOT REQ'D | Student's grade level at time of course. | NA |
Descriptors:
Namespace | Code Value | Short Description | Description |
|---|
Namespace | Code Value | Short Description | Description |
|---|---|---|---|
uri://ed-fi.org/CourseAttemptResultDescriptor | Fail | Fail | Fail |
Incomplete | Incomplete | Incomplete | |
Pass | Pass | Pass | |
Withdrawn | Withdrawn | Withdrawn | |
uri://dpi.wi.gov/TermDescriptor | A | Annual | Annual |
S1 | 1st Semester | 1st Semester | |
S2 | 2nd Semester | 2nd Semester | |
T1 | 1st Trimester | 1st Trimester | |
T2 | 2nd Trimester | 2nd Trimester | |
T3 | 3rd Trimester | 3rd Trimester | |
Q1 | 1st Quarter | 1st Quarter | |
Q2 | 2nd Quarter | 2nd Quarter | |
Q3 | 3rd Quarter | 3rd Quarter | |
Q4 | 4th Quarter | 4th Quarter | |
uri://dpi.wi.gov/GradeLevelDescriptor | 7 | Seventh Grade | Seventh Grade |
8 | Eighth Grade | Eighth Grade | |
9 | Ninth Grade | Ninth Grade | |
10 | Tenth Grade | Tenth Grade | |
11 | Eleventh Grade | Eleventh Grade | |
12 | Twelfth Grade | Twelfth Grade |
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 Course Transcripts for all the courses a student has taken as part of their graduation plan, and the student is currently NOT in senior year | When a student is enrolled in the same LEA for grade levels 9-11, then the SIS sends one /courseTranscripts record for all the courses completed by student form previous years (9th-10th gardes) where earned credits and final letter grades are available.
DPI expects one Course Transcript record from the most recent school in the district that contains the student’s full credit history. The courseTranscript can be sent at any time and should include the data available up to that point. Prerequisite:
| POST on / studentAcademicRecords: POST on /courseTranscripts: courseAttemptResultDescriptor: uri://ed-fi.org/CourseAttemptResultDescriptor#Pass etc. |
2.0 | Sending Course Transcripts for all the courses a student has taken as part of their graduation plan, and the student is currently in senior year | When a student is in 12th grade, SIS shoud submit Course Transcripts for all high school courses taken in previous years (9th-11th) where earned credits and final letter grades are available. SIS may send the courses completed by student form the current year (12th grade). DPI expects one Course Transcript record from the most recent school in the district that contains the student’s full credit history. The courseTranscript can be sent at any time and should include the data available up to that point. | POST on / studentAcademicRecords and /courseTranscripts |
For a graduating student, an addition SAR record with diploma information must be submitted with ‘Annual’ term descriptor from the student's most recent enrolled school. In addition to other SAR records with term descriptor other than 'Annual'. | POST on / studentAcademicRecords: | ||
3.0 | Sending Course Transcripts for a student with a dropped course | LEA may choose to generate a transcript with final letter grade as 'Withdrawal - W' . Some LEAs don't show dropped course on the transcript based on the timeline of when the student dropped the course. | POST on /courseTranscripts: |
4.0 | Sending Course Transcripts for a student who transfered to different schools within the same district (multiple SSA records from same LEA, but different school are expected) |
NOTE: When multiple schools sending data for Course Transcripts, then the data submitted by the school with the current SSA will be taken into account by Xello. | School 1: POST /studentAcademicRecord and /courseTranscript School 2: POST /studentAcademicRecord and /courseTranscript |
5.0 | Sending Course Transcript for a student who transfered from one district to another in the same school year (multiple SSA records are expected) |
NOTE: When multiple schools sending data for Course Transcripts, then the data submitted by the school with the current SSA will be taken into account by Xello. | District 1: POST /studentAcademicRecord and /courseTranscript District 2: POST /studentAcademicRecord and /courseTranscript |
6.0 | Sending Course Transcript for a student taking courses at non-primary school (enrollment type is Coursework) | Generally, the school holding the non-primary enrollment would NOT send Course Transcript. The primary school has to consolidate the course work taken at both primary and non-primary school and submit Course Transcript to DPI. However, in an exceptional scenario where a charter school is the primary school and the student is taking high school classes in a non-primary school, if the non-primary school is generating a Course Transcript, then the non-primary school can submit Course Transcript to DPI. | POST on / studentAcademicRecords and /courseTranscripts |
7.0 | Sending Course Transcript for a student taking Certified or Non-certified Programs, which are not tied to any courses. (e.g: Youth Apprenticeship , IRC , State Skilled) | Course Transcript is NOT submitted for any Certified and Non-certified Programs that are not tied to any courses. | NA |
8.0 | Sending Course Transcript for a student in grade level 11 taking a course in previous years which is not in 20/21 course list (deprecated course) | In order to support the previous year's deprecated courses, DPI added new 'Transcript Courses' starting from the 20/21 SY and forward that can only be used on reference within /courseTranscripts resource
Example: | POST on /courseTranscripts: |
9.0 | Sending Course Transcript for a student taking a course multiple times in the same school year, or in multiple years as part of their whole high school course | When a student takes a course in the previous grade level (e.g. 9th grade) and courseAttemptDescriptor is 'PASS', and for whatever reason takes that same course again in the next grade level (e.g. 10th grade) with courseAttemptDescriptor is 'PASS', then there can be natural key constraint. This scenario can also be with same grade level but different term. In order to support this scenarios, DPI is allowing SIS vendors to send multiple SARs with their corresponding courseTranscripts. SAR and courseTranscipt records are expected to be sent to the current school year, with SAR and courseTranscipt included from prior years. SIS vendors may also use the new 'T01 - T50' course codes in the CourseCode for the same state code twice during a year. | POST on /courseTranscripts: Term 1: |
10.0 | Sending summer school courses in Course Transcripts | While Summer Enrollment and Roster data are not sent to WISEdata, LEAs can track it locally in the SIS. SIS vendors should send Summer school courses into /CourseTranscripts to show on the student's transcript
| POST on / studentAcademicRecords and /courseTranscripts |
JSON Sample:
{
"courseAttemptResultDescriptor": "uri://ed-fi.org/CourseAttemptResultDescriptor#Fail",
"courseReference": {
"educationOrganizationId": 48856,
"courseCode": "12194"
},
"studentAcademicRecordReference": {
"educationOrganizationId": 7525,
"schoolYear": 2021,
"studentUniqueId": "8660232105",
"termDescriptor": "uri://dpi.wi.gov/TermDescriptor#Q4"
},
"alternativeCourseCode": "LCC-121941",
"alternativeCourseTitle": "LCT-121941",
"courseTitle": "Refer to Courses for Title",
"earnedCredits": 36.25,
"finalLetterGradeEarned": "F",
"finalNumericGradeEarned": 1,
"whenTakenGradeLevelDescriptor": "uri://dpi.wi.gov/GradeLevelDescriptor#12"
}{
"termDescriptor": "uri://dpi.wi.gov/TermDescriptor#T1",
"educationOrganizationReference": {
"educationOrganizationId": 7525
},
"schoolYearTypeReference": {
"schoolYear": 2021
},
"studentReference": {
"studentUniqueId": "8660232105"
},
}
Wisconsin Department of Public Instruction