Create a student schedule

post

/fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Schedule Periods
Type: array
Title: Schedule Periods
The schedule periods resource is used to show optional and mandatory reporting periods for a student.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-item-post-request
Type: object
Show Source
Nested Schema : Enrolled Items
Type: array
Title: Enrolled Items
The enrolled items resource lists course section enrollments associated with a student.
Show Source
Nested Schema : Enrollment Periods
Type: array
Title: Enrollment Periods
The enrollment periods resource is used to document academic and academic self-paced periods for a schedule reporting period.
Show Source
Nested Schema : Recommended Items
Type: array
Title: Recommended Items
The recommended items resource is used to display recommended courses from the student's program templates.
Show Source
Nested Schema : Scheduled Items
Type: array
Title: Scheduled Items
The scheduled items resource is used to identify courses and course sections that the student is planning to enroll in for a schedule period.
Show Source
Nested Schema : Period Dates
Type: array
Title: Period Dates
The enrollment period dates resource is used to display key dates for an enrollment period.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-item-post-request
Type: object
Show Source
Nested Schema : Instructors
Type: array
Title: Instructors
The instructors resource lists the instructors for the enrolled or scheduled items.
Show Source
Nested Schema : Meeting Patterns
Type: array
Title: Meeting Patterns
The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-instructors-item-post-request
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-meetingPatterns-item-post-request
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-item-post-request
Type: object
Show Source
Nested Schema : Period Dates
Type: array
Title: Period Dates
The enrollment period dates resource is used to display key dates for an enrollment period.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-enrollmentPeriodDates-item-post-request
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-recommendedItems-item-post-request
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-item-post-request
Type: object
Show Source
Nested Schema : Instructors
Type: array
Title: Instructors
The instructors resource lists the instructors for the enrolled or scheduled items.
Show Source
Nested Schema : Meeting Patterns
Type: array
Title: Meeting Patterns
The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-instructors-item-post-request
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-post-request
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-schedulePeriodDates-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : studentScheduleByPeriods-item-response
Type: object
Show Source
Nested Schema : Schedule Periods
Type: array
Title: Schedule Periods
The schedule periods resource is used to show optional and mandatory reporting periods for a student.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-item-response
Type: object
Show Source
Nested Schema : Enrolled Items
Type: array
Title: Enrolled Items
The enrolled items resource lists course section enrollments associated with a student.
Show Source
Nested Schema : Enrollment Periods
Type: array
Title: Enrollment Periods
The enrollment periods resource is used to document academic and academic self-paced periods for a schedule reporting period.
Show Source
Nested Schema : Recommended Items
Type: array
Title: Recommended Items
The recommended items resource is used to display recommended courses from the student's program templates.
Show Source
Nested Schema : Scheduled Items
Type: array
Title: Scheduled Items
The scheduled items resource is used to identify courses and course sections that the student is planning to enroll in for a schedule period.
Show Source
Nested Schema : Period Dates
Type: array
Title: Period Dates
The enrollment period dates resource is used to display key dates for an enrollment period.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-item-response
Type: object
Show Source
Nested Schema : Instructors
Type: array
Title: Instructors
The instructors resource lists the instructors for the enrolled or scheduled items.
Show Source
Nested Schema : Meeting Patterns
Type: array
Title: Meeting Patterns
The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-instructors-item-response
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-meetingPatterns-item-response
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-item-response
Type: object
Show Source
Nested Schema : Period Dates
Type: array
Title: Period Dates
The enrollment period dates resource is used to display key dates for an enrollment period.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-enrollmentPeriodDates-item-response
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-recommendedItems-item-response
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-item-response
Type: object
Show Source
Nested Schema : Instructors
Type: array
Title: Instructors
The instructors resource lists the instructors for the enrolled or scheduled items.
Show Source
Nested Schema : Meeting Patterns
Type: array
Title: Meeting Patterns
The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-instructors-item-response
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-response
Type: object
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-schedulePeriodDates-item-response
Type: object
Show Source
Back to Top