Versions Compared

Version Old Version 7 New Version Current
Changes made by

Jaidaa Shafaei

Jaidaa Shafaei

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

As a part of the Roster collection, SIS vendors need to set up a student's schedule for a school year. For testing purposes, SIS vendors should submit data for six different courses the student is taking (Look for instructions under each endpoint use casesto find specific information on what details should be included).

  • GET on /courses endpoint

  • Submit /gradingPeriods

  • Submit /sessions

  • Submit /courseOffererings

  • Submit /sections

  • Submit /studentSectionAssociations

  • Submit /grades

  • GET on /staff

  • Submit /StaffSectionAssociations

(blue star) This endpoint is NOT expected from Choice schools.

Data Properties:

Expand
titleClick here to view all data properties under the /gradingPeriod endpoint:

#

Property Name

Data Type

Public (Required/ Optional/ Conditional)

Choice (Required/ Optional/ Conditional)

Business Definition

Data Element Page

1.0

gradingPeriodDescriptor

string

REQ'D

NOT REQ'D

The name of the period for which grades are reported.

https://dpi.wi.gov/wise/data-elements/gradingperioddescriptor

2.0

🆕 gradingPeriodName

string

REQ'D

NOT REQ'D

The school's descriptive name of the grading period

3.0

periodSequence

integer

OPT

NOT REQ'D

The sequential order of this period relative to other periods.

https://dpi.wi.gov/wise/data-elements/sequenceofcourse

34.0

schoolReference

45.0

schoolId

integer

REQ'D

NOT REQ'D

The identifier assigned to a school.

https://dpi.wi.gov/wise/data-elements/gradingperiodschoolid

56.0

schoolYearTypeReference

67.0

schoolYear

integer

REQ'D

NOT REQ'D

Key for School Year

https://dpi.wi.gov/wise/data-elements/school-year

78.0

beginDate

string

REQ'D

NOT REQ'D

Month, day, and year of the first day of the GradingPeriod.

https://dpi.wi.gov/wise/data-elements/gradingperiodbeginandend

89.0

endDate

string

REQ'D

NOT REQ'D

Month, day, and year of the last day of the GradingPeriod.

https://dpi.wi.gov/wise/data-elements/gradingperiodbeginandend

910.0

totalInstructionalDays

integer

REQ'D

NOT REQ'D

Total days available for educational instruction during the GradingPeriod.

https://dpi.wi.gov/wise/data-elements/gradingperiodtotalinstructionaldays

...

Use Cases:

Expand
titleClick here to view all the use cases pertaining to the /gradingPeriod endpoint:

#

Use Case Title

Use Case Description

What to Submit/retrieve

1.0

Sending the grading period during the school year in which the grade is offered

To set up a student's schedule for a school year, SIS vendors need to submit gradingPeriods for the schedule using gradingPeriodDescriptor values.

  • To be able to submit the /courseOfferings endpoint, the /gradingPeriods (and the /sessions endpoint) should be submitted.

POST on / gradingPeriod:
schoolReference:
schoolId: 7525
schoolYearTypeReference:
schoolYear: 2021
gradingPeriodDescriptor: uri://dpi.wi.gov/GradingPeriodDescriptor#07
periodSequence: 1
beginDate: 2020-07-03
totalInstructionalDays: 150
endDate: 2021-06-05

...

JSON Sample:

Expand
titleJSON sample for /gradingPeriod:
Code Block
languagejson
{
	"schoolReference": {
		"schoolId": 7525
	},
	"schoolYearTypeReference": {
		"schoolYear": 2021
	},
	"gradingPeriodDescriptor": "uri://dpi.wi.gov/GradingPeriodDescriptor#07",
	"periodSequence": 1,
	"beginDate": "2020-07-03",
	"totalInstructionalDays": "150",
	"endDate": "2021-06-05"
}

...