Update or create a scheduled item
patch
/fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/scheduledItems/{scheduledItemsUniqID}
Request
Path Parameters
-
schedulePeriodsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Schedule Periods resource and used to uniquely identify an instance of Schedule Periods. The client should not generate the hash key value. Instead, the client should query on the Schedule Periods collection resource in order to navigate to a specific instance of Schedule Periods to get the hash key.
-
scheduledItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ScheduledItemId and CurriculumOptionId ---for the Scheduled Items resource and used to uniquely identify an instance of Scheduled Items. The client should not generate the hash key value. Instead, the client should query on the Scheduled Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Scheduled Items.
For example: scheduledItems?q=ScheduledItemId=<value1>;CurriculumOptionId=<value2> -
studentScheduleByPeriodsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Student Schedule by Periods resource and used to uniquely identify an instance of Student Schedule by Periods. The client should not generate the hash key value. Instead, the client should query on the Student Schedule by Periods collection resource in order to navigate to a specific instance of Student Schedule by Periods to get the hash key.
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AcademicLevelIdOption: integer
(int64)
The unique identifier for the academic level of the student enrolling in the course.
-
ClassStartDateOption: string
(date)
The requested start date for the self-paced course.
-
CreditOptionFlag: boolean
Maximum Length:
1
Default Value:false
The type of credit the student is enrolling in. -
CurriculumOptionId: integer
(int64)
The unique identifier of the associated enrollment options record.
-
EnrolledCreditsOption: number
The number of credits the student wants to enroll in.
-
EnrollmentRequestStatusCode: string
Maximum Length:
30
Default Value:ORA_SCHEDULED
The status code of the enrollment request. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_REQUEST_STATUS. -
GradingOptionCode: string
Maximum Length:
30
The grading method option selected by the student for enrollment. -
instructors: array
Instructors
Title:
Instructors
The instructors resource lists the instructors for the enrolled or scheduled items. -
ItemCurriculumId: integer
(int64)
The unique identifier of the course or course section that's scheduled.
-
meetingPatterns: array
Meeting Patterns
Title:
Meeting Patterns
The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items. -
OfferSequenceNumber: integer
(int64)
The offering sequence number for the course.
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-patch-request
Type:
Show Source
object
Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-patch-request
Type:
Show Source
object
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-item-response
Type:
Show Source
object
-
AcademicLevelIdOption: integer
(int64)
The unique identifier for the academic level of the student enrolling in the course.
-
AcademicLevelNameOption: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of the academic level of the student enrolling in the course. -
AcademicSubjectCode: string
Read Only:
true
The subject code for the course. -
AcademicSubjectId: integer
Read Only:
true
The unique identifier for the subject of the course. -
AcademicSubjectName: string
Read Only:
true
The subject name for the course. -
CalculatedClassEndDate: string
(date)
Read Only:
true
The calculated end date based on the course section start date for self-paced courses. -
ClassStartDateOption: string
(date)
The requested start date for the self-paced course.
-
CourseCurriculumId: integer
Read Only:
true
The curriculum item identifier for the course. -
CourseEnrollmentStatusCode: string
Read Only:
true
The enrollment status code of the course section indicating if the course is available for enrollment. -
CourseEnrollmentStatusMeaning: string
Read Only:
true
The enrollment status of the course section indicating if the course is available for enrollment. -
CourseOfferingId: integer
Read Only:
true
The offering identifier for the course. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
CreditOptionFlag: boolean
Maximum Length:
1
Default Value:false
The type of credit the student is enrolling in. -
CreditTypeCode: string
Read Only:
true
Maximum Length:255
The unique identifier of the credit type associated with the course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CreditTypeMeaning: string
Read Only:
true
The meaning of the type of credit of the course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CurriculumCatalogNumber: string
Read Only:
true
The catalog number for the course. -
CurriculumFormatCode: string
Title:
Format
Read Only:true
Maximum Length:30
The unique identifier for the format of the course. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
CurriculumFormatMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the format of the course. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
CurriculumOptionId: integer
(int64)
The unique identifier of the associated enrollment options record.
-
DropEnabledFlag: boolean
Read Only:
true
Maximum Length:255
Indicates the student is allowed to drop the course section. -
EnrolledCreditsOption: number
The number of credits the student wants to enroll in.
-
EnrollmentCapacityQuantity: integer
Read Only:
true
The enrollment capacity of the course section. -
EnrollmentRequestStatusCode: string
Maximum Length:
30
Default Value:ORA_SCHEDULED
The status code of the enrollment request. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_REQUEST_STATUS. -
EnrollmentRequestStatusMeaning: string
Read Only:
true
Maximum Length:80
The status of the enrollment request. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_REQUEST_STATUS. -
GradingOptionCode: string
Maximum Length:
30
The grading method option selected by the student for enrollment. -
instructors: array
Instructors
Title:
Instructors
The instructors resource lists the instructors for the enrolled or scheduled items. -
IsSelfPacedFlag: boolean
Read Only:
true
Indicates that the course section is self-paced. The default value is false. -
ItemCurriculumId: integer
(int64)
The unique identifier of the course or course section that's scheduled.
-
ItemCurriculumName: string
Title:
Name
Read Only:true
Maximum Length:150
The name of the curriculum item for the course or course section that's scheduled. -
ItemCurriculumType: string
Title:
Curriculum Item Type
Read Only:true
Maximum Length:30
The type of curriculum that's scheduled. -
ItemCurriculumTypeId: integer
(int64)
Read Only:
true
The unique identifier for the type of curriculum that's scheduled. -
ItemCurriculumTypeName: string
Read Only:
true
Maximum Length:50
The type name of the curriculum that's scheduled. -
LastDateToDrop: string
(date-time)
Read Only:
true
The last date the student can drop the course section without penalty. -
LastDateToDropWithGreaterPenalty: string
(date-time)
Read Only:
true
The last date the student can drop the course section with a greater drop penalty. -
LastDateToDropWithoutRetain: string
(date-time)
Read Only:
true
The last date the student can drop the course section and not have the course section remain part of their academic record. -
LastDateToDropWithPenalty: string
(date-time)
Read Only:
true
The last date the student can drop the course section with some sort of drop penalty applied. -
LastDateToDropWithRetain: string
(date-time)
Read Only:
true
The last date the student can drop the course section and receive a withdraw status. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumUnitsQuantity: number
Read Only:
true
The maximum number of units for which a course can be taken. -
meetingPatterns: array
Meeting Patterns
Title:
Meeting Patterns
The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items. -
MinimumUnitsQuantity: number
Read Only:
true
The minimum number of units for which a course can be taken. -
OfferSequenceNumber: integer
(int64)
The offering sequence number for the course.
-
RepeatAllowedFlag: boolean
Read Only:
true
Indicates that repeating the course is allowed. The default value is false. -
RepeatAllowedTotal: integer
Read Only:
true
The total number of times a student can take a course. -
RepeatInPeriodFlag: boolean
Read Only:
true
Indicates that repeating the course is allowed within the same period. -
RepeatUnitsTotal: number
Read Only:
true
The total number of repeated units which are allowed for the course. -
RequisiteExistsFlag: boolean
Read Only:
true
Maximum Length:255
Indicates that requisites exist for the enrolled course. -
RequisiteInformation: string
Read Only:
true
Maximum Length:255
The text used to describe the requisites of a course. -
ScheduledCourseCampusId: integer
Read Only:
true
The unique identifier for the campus where the course section is offered. -
ScheduledCourseCampusName: string
Read Only:
true
Maximum Length:255
The name of the campus where the course section is offered. -
ScheduledCourseCode: string
Read Only:
true
The section code of the course section. -
ScheduledCourseEndDate: string
(date-time)
Read Only:
true
The date when the course section ends. -
ScheduledCourseStartDate: string
(date-time)
Read Only:
true
The date when the course section starts. -
ScheduledItemId: integer
(int64)
Read Only:
true
The unique identifier of the scheduled item. -
TotalEnrolledQuantity: integer
Read Only:
true
The number of students currently enrolled in the course section.
Nested Schema : Instructors
Type:
array
Title:
Instructors
The instructors resource lists the instructors for the enrolled or scheduled items.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
CurriculumOfferingId: integer
(int64)
Title:
Curriculum Offering ID
Read Only:true
The unique identifier of curriculum offering of the course section. -
CurriculumOrgId: integer
(int64)
Read Only:
true
The unique identifier of the curriculum organization of the course section staff. -
CurriculumStaffId: integer
(int64)
Title:
Curriculum Staff ID
Read Only:true
The unique identifier of the curriculum staff. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferSequenceNumber: integer
(int32)
Title:
Offer Number
Read Only:true
The offering sequence number of the course section. -
PersonAcademicTitle: string
Title:
Academic Title
Read Only:true
Maximum Length:30
The academic title of the instructor if one is available. -
PersonImageContent: string
(byte)
Read Only:
true
The image data of the instructor. -
PersonImageId: integer
(int64)
Read Only:
true
The image or photograph of the instructor, if available. -
PersonTitle: string
Title:
Title
Read Only:true
Maximum Length:60
The title of the instructor. -
PreferredFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The preferred first name of the person. -
PreferredLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The preferred last name of the person. -
PreferredMiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The preferred middle name of the person. -
PreferredName: string
Title:
Additional Name
Read Only:true
Maximum Length:360
The preferred first and last name of the person displayed as a single string. -
StaffAdministratorOnlyFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Indicates that this staff member is part of the administrative staff. The default value is false. -
StaffBiography: string
(byte)
Title:
Biography
Read Only:true
The biography of the instructor, if available. -
StaffPartyId: integer
(int64)
Read Only:
true
The unique identifier for the party. -
StaffPrimaryFlag: boolean
Title:
Primary
Read Only:true
Maximum Length:1
The primary instructor of the course section. -
StaffRoleTypeCode: string
Title:
Role Type
Read Only:true
Maximum Length:30
The role code that the course section staff will be filling -
StaffRoleTypeMeaning: string
Read Only:
true
Maximum Length:80
The role that the course section staff will be filling.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-response
Type:
Show Source
object
-
BuildingName: string
Title:
Name
Read Only:true
Maximum Length:50
The building name of the facility where the meeting will be held. -
BuildingShortCode: string
Title:
Code
Read Only:true
Maximum Length:6
The building code of the facility where the meeting will be held. -
CurriculumFormatCode: string
Read Only:
true
Maximum Length:30
The unique identifier for the format of the course. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
CurriculumFormatMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the format of the course. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
CurriculumScheduleId: integer
(int64)
Read Only:
true
The unique identifier of the meeting record. -
DurationQuantity: integer
(int32)
Title:
Duration
Read Only:true
The duration of the meeting. -
FacilityDescription: string
Title:
Description
Read Only:true
Maximum Length:240
A description of the facility where the meeting will be held. -
FacilityRoomNumber: string
Title:
Room Number
Read Only:true
Maximum Length:10
The room number of the facility where the meeting will be held. -
FacilityShortCode: string
Title:
Facility
Read Only:true
Maximum Length:20
The abbreviated facility code representing the building and room number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationLatitude: number
Title:
Latitude
Read Only:true
The latitude of the building where the meeting will be held. -
LocationLongitude: number
Title:
Longitude
Read Only:true
The longitude of the building where the meeting will be held. -
LocationLongName: string
Read Only:
true
Contains formatted address from either the associated facility or the user entered course location address. -
MeetingPatternDescription: string
Title:
Pattern Name
Read Only:true
Maximum Length:50
The description of the meeting pattern for the meeting. -
MeetingPatternEndDate: string
(date)
Title:
End Date
Read Only:true
The scheduled end date of the meeting. -
MeetingPatternEndTime: string
(date-time)
Title:
End Time
Read Only:true
The scheduled end time of the meeting. -
MeetingPatternName: string
Title:
Meeting Name
Read Only:true
Maximum Length:50
The descriptive name of the meeting such as lab or lecture. -
MeetingPatternStartDate: string
(date)
Title:
Start Date
Read Only:true
The start date of the meeting schedule indicating the first day of class. -
MeetingPatternStartTime: string
(date-time)
Title:
Start Time
Read Only:true
The scheduled start time of the meeting. -
RecurrenceDayFriFlag: boolean
Title:
Friday
Read Only:true
Maximum Length:1
Default Value:false
Indicates that the meeting will occur on a Friday. -
RecurrenceDayMonFlag: boolean
Title:
Monday
Read Only:true
Maximum Length:1
Default Value:false
Indicates that the meeting will occur on a Monday. -
RecurrenceDaySatFlag: boolean
Title:
Saturday
Read Only:true
Maximum Length:1
Default Value:false
Indicates that the meeting will occur on a Saturday. -
RecurrenceDaySunFlag: boolean
Title:
Sunday
Read Only:true
Maximum Length:1
Default Value:false
Indicates that the meeting will occur on a Sunday. -
RecurrenceDayThuFlag: boolean
Title:
Thursday
Read Only:true
Maximum Length:1
Default Value:false
Indicates that the meeting will occur on a Thursday. -
RecurrenceDayTueFlag: boolean
Title:
Tuesday
Read Only:true
Maximum Length:1
Default Value:false
Indicates that the meeting will occur on a Tuesday. -
RecurrenceDayWedFlag: boolean
Title:
Wednesday
Read Only:true
Maximum Length:1
Default Value:false
Indicates that the meeting will occur on a Wednesday. -
ScheduleSequenceNumber: integer
(int32)
Title:
Schedule Sequence Number
Read Only:true
The sequence of the meeting. Used when a course section has more than a single meeting pattern.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- instructors
-
Parameters:
- schedulePeriodsUniqID:
$request.path.schedulePeriodsUniqID
- scheduledItemsUniqID:
$request.path.scheduledItemsUniqID
- studentScheduleByPeriodsUniqID:
$request.path.studentScheduleByPeriodsUniqID
The instructors resource lists the instructors for the enrolled or scheduled items. - schedulePeriodsUniqID:
- meetingPatterns
-
Parameters:
- schedulePeriodsUniqID:
$request.path.schedulePeriodsUniqID
- scheduledItemsUniqID:
$request.path.scheduledItemsUniqID
- studentScheduleByPeriodsUniqID:
$request.path.studentScheduleByPeriodsUniqID
The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items. - schedulePeriodsUniqID: