Get all student schedules
get
/fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all student schedule by periods that match the Party ID.
Finder Variables- PartyId; integer; Unique identifier for party. Party can be a person in Oracle Trading Community Architecture. For example, a student can be a party.
- PrimaryKey Finds all student schedule by periods that match the Party ID.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ConstituentId; string; The unique identifier for a constituent.
- PartyId; integer; The unique identifier for the party.
- PreferredFirstName; string; The preferred first name of the person.
- PreferredFullName; string; The first and last name of the person displayed as a single string.
- PreferredLastName; string; The preferred last name of the person.
- PreferredMiddleName; string; The preferred middle name of the person.
- PreferredNameSuffix; string; The name suffix of the person such as junior or senior.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : studentScheduleByPeriods
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : studentScheduleByPeriods-item-response
Type:
Show Source
object-
ConstituentId: string
Read Only:
trueMaximum Length:30The unique identifier for a constituent. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PartyId: integer
(int64)
Read Only:
trueThe unique identifier for the party. -
PreferredFirstName: string
Title:
First NameRead Only:trueMaximum Length:150The preferred first name of the person. -
PreferredFullName: string
Title:
Additional NameRead Only:trueMaximum Length:360The first and last name of the person displayed as a single string. -
PreferredLastName: string
Title:
Last NameRead Only:trueMaximum Length:150The preferred last name of the person. -
PreferredMiddleName: string
Title:
Middle NameRead Only:trueMaximum Length:60The preferred middle name of the person. -
PreferredNameSuffix: string
Title:
Name SuffixRead Only:trueMaximum Length:30The name suffix of the person such as junior or senior. -
schedulePeriods: array
Schedule Periods
Title:
Schedule PeriodsThe schedule periods resource is used to show optional and mandatory reporting periods for a student.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Schedule Periods
Type:
arrayTitle:
Schedule PeriodsThe schedule periods resource is used to show optional and mandatory reporting periods for a student.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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-item-response
Type:
Show Source
object-
AcademicPeriodId: integer
(int64)
Read Only:
trueThe unique identifier of an academic period. -
AcademicPeriodTypeId: integer
(int64)
Title:
Academic Period Type IDRead Only:trueThe unique identifier of the academic period type. -
EarliestFirstDateToEnroll: string
(date-time)
Read Only:
trueThe date that documents the start of enrollment for an academic period. -
EarliestFirstDateToSearch: string
(date-time)
Read Only:
trueThe date that controls when an academic reporting period is available for course searches. -
EndDate: string
(date)
Read Only:
trueThe date when the academic period ends. -
enrolledItems: array
Enrolled Items
Title:
Enrolled ItemsThe enrolled items resource lists course section enrollments associated with a student. -
enrollmentPeriods: array
Enrollment Periods
Title:
Enrollment PeriodsThe enrollment periods resource is used to document academic and academic self-paced periods for a schedule reporting period. -
LatestLastDateToEnroll: string
(date-time)
Read Only:
trueThe date that documents the last day of enrollment for an academic period. -
LatestLastDateToSearch: string
(date-time)
Read Only:
trueThe date that controls when an academic reporting period is no longer available for course searches. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OptionalFlag: boolean
Read Only:
trueMaximum Length:1Indicates if the academic period is required for a student based on their enrolled program. The default value is false. -
PeriodCategoryCode: string
Title:
CategoryRead Only:trueMaximum Length:30The category code of the academic reporting period. -
PeriodCategoryMeaning: string
Read Only:
trueMaximum Length:80The category meaning of the academic reporting period. -
PeriodTypeName: string
Title:
NameRead Only:trueMaximum Length:50The name of the academic period type. -
recommendedItems: array
Recommended Items
Title:
Recommended ItemsThe recommended items resource is used to display recommended courses from the student's program templates. -
scheduledItems: array
Scheduled Items
Title:
Scheduled ItemsThe scheduled items resource is used to identify courses and course sections that the student is planning to enroll in for a schedule period. -
schedulePeriodDates: array
Period Dates
Title:
Period DatesThe enrollment period dates resource is used to display key dates for an enrollment period. -
SchedulePeriodName: string
Title:
NameRead Only:trueMaximum Length:50The name of the academic period. -
StartDate: string
(date)
Read Only:
trueThe date when the academic period starts. -
WeeksOfInstruction: integer
(int32)
Title:
Weeks of InstructionRead Only:trueDefault Value:1The number of weeks of instruction for an academic reporting period.
Nested Schema : Enrolled Items
Type:
arrayTitle:
Enrolled ItemsThe enrolled items resource lists course section enrollments associated with a student.
Show Source
Nested Schema : Enrollment Periods
Type:
arrayTitle:
Enrollment PeriodsThe enrollment periods resource is used to document academic and academic self-paced periods for a schedule reporting period.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Recommended Items
Type:
arrayTitle:
Recommended ItemsThe recommended items resource is used to display recommended courses from the student's program templates.
Show Source
Nested Schema : Scheduled Items
Type:
arrayTitle:
Scheduled ItemsThe 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:
arrayTitle:
Period DatesThe enrollment period dates resource is used to display key dates for an enrollment period.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-item-response
Type:
Show Source
object-
AcademicLevelIdOption: integer
(int64)
The unique identifier of the academic level.
-
AcademicLevelNameOption: string
Title:
Academic Level NameRead Only:trueMaximum Length:100The name of the academic level. -
AcademicSubjectCode: string
Title:
Subject CodeRead Only:trueMaximum Length:30The subject code of the enrolled course. -
AcademicSubjectId: integer
(int64)
Title:
Academic Subject IDRead Only:trueThe subject unique identifier of the enrolled course. -
AcademicSubjectName: string
Title:
Subject NameRead Only:trueMaximum Length:50The subject name of the enrolled course. -
CalculatedClassEndDate: string
(date)
Read Only:
trueThe calculated course section end date for the self-paced course enrollment. -
ClassStartDateOption: string
(date)
The course section start date for the self-paced course enrollment
-
CourseEnrollingStatusCode: string
Title:
Enrollment StatusRead Only:trueMaximum Length:30Default Value:ORA_OPNThe enrolling status code for the course section. -
CourseEnrollingStatusMeaning: string
Read Only:
trueMaximum Length:80The enrolling status of the course section. -
CourseOfferingId: integer
(int64)
Read Only:
trueThe offering unique identifier of the curriculum item. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the row. -
CreationDate: string
(date-time)
Read Only:
trueThe date the row was created. -
CreditOptionFlag: boolean
Maximum Length:
1Default Value:falseThe credit option for the course enrollment. -
CreditTypeCode: string
Title:
Credit Type CodeRead Only:trueMaximum Length:30The credit type code of the enrolled course. -
CreditTypeMeaning: string
Title:
Credit TypeRead Only:trueMaximum Length:80The credit type of the enrolled course. -
CurriculumCatalogNumber: string
Title:
Catalog NumberRead Only:trueMaximum Length:10The catalog number of the enrolled course. -
CurriculumFormatCode: string
Title:
FormatRead Only:trueMaximum Length:30The 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:
trueMaximum Length:80The 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 curriculum enrollment options record.
-
DropDate: string
(date)
Title:
Drop DateRead Only:trueThe date when the student dropped the scheduled course. -
DropEnabledFlag: boolean
Read Only:
trueIndicates that this course section can be dropped by the student. -
EnrolledCreditQuantity: number
Title:
UnitsRead Only:trueThe number of credits the student enrolled in for the course. -
EnrolledCreditsOption: number
The number of enrolled credits for the course enrollment.
-
EnrollmentCapacityQuantity: integer
(int32)
Title:
Enrollment CapacityRead Only:trueThe total number of enrolled students allowed to enroll in the enrolled course section. -
EnrollmentDate: string
(date)
Title:
Enrollment DateRead Only:trueThe date of the enrollment. -
EnrollmentItemId: integer
(int64)
Title:
Student Curriculum Item IDRead Only:trueThe unique identifier of the enrollment item. -
EnrollmentStatus: string
Title:
Enrollment StatusRead Only:trueMaximum Length:30The status code of the enrollment. -
EnrollmentStatusMeaning: string
Title:
Enrollment Status MeaningRead Only:trueMaximum Length:80The status of the enrollment. -
GradingOptionCode: string
Maximum Length:
30The grading option for the course enrollment. -
instructors: array
Instructors
Title:
InstructorsThe instructors resource lists the instructors for the enrolled or scheduled items. -
IsSelfPacedFlag: boolean
Title:
Self-PacedRead Only:trueMaximum Length:1Indicates that the enrolled course section is self paced. -
ItemCurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe identifier of the enrolled curriculum item. -
ItemCurriculumName: string
Title:
TitleRead Only:trueMaximum Length:150The name of the enrolled curriculum item. -
ItemCurriculumType: string
Title:
Curriculum Item TypeRead Only:trueMaximum Length:30The curriculum type code of the enrolled item. -
ItemCurriculumTypeId: integer
(int64)
Title:
Curriculum TypeRead Only:trueThe identifier of the curriculum type for the enrolled item. -
ItemCurriculumTypeName: string
Read Only:
trueMaximum Length:50The name of the curriculum type. -
LastDateToDrop: string
(date-time)
Read Only:
trueThe last day the student is allowed to drop this course. -
LastDateToDropWithGreaterPenalty: string
(date-time)
Read Only:
trueThe last day the student is allowed to drop where the student will receive a greater financial penalty for dropping the course. -
LastDateToDropWithoutRetain: string
(date-time)
Read Only:
trueThe last day the student is allowed to drop where the course won't appear on the student's academic record. -
LastDateToDropWithPenalty: string
(date-time)
Read Only:
trueThe last day the student is allowed to drop where the student will receive a financial penalty for dropping the course. -
LastDateToDropWithRetain: string
(date-time)
Read Only:
trueThe last day the student is allowed to drop where the course will appear on the student's academic record. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date the row was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumUnitsQuantity: number
Title:
Maximum UnitsRead Only:trueThe maximum number of units for which a course can be taken. -
meetingPatterns: array
Meeting Patterns
Title:
Meeting PatternsThe meeting patterns resource lists the meeting pattern information for enrolled or scheduled items. -
MinimumUnitsQuantity: number
Title:
Minimum UnitsRead Only:trueThe minimum number of units for which a course can be taken. -
OfferSequenceNumber: integer
(int32)
Title:
Owning Offer NumberRead Only:trueThe offering sequence number of the course. -
OwningCurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe curriculum Id of the course that owns the course section. -
OwningCurriculumName: string
Title:
TitleRead Only:trueMaximum Length:150The curriculum name of the course that owns the course section. -
RepeatAllowedFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseIndicates that repeating the course is allowed. The default value is false. -
RepeatAllowedTotal: integer
(int32)
Read Only:
trueThe total number of times a student can take a course. -
RepeatInPeriodFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseIndicates that repeating the course is allowed within the same period. -
RepeatUnitsTotal: number
Read Only:
trueThe total number of repeated units which are allowed for the course. -
RequisiteExistsFlag: boolean
Read Only:
trueIndicates that requisites exist for the enrolled course. -
RequisiteInformation: string
Read Only:
trueThe text used to describe the requisites of a course. -
RequisiteStatusCode: string
Title:
Requisite Status CodeRead Only:trueMaximum Length:30The status code of the course requisites at time of enrollment. -
RequisiteStatusMeaning: string
Read Only:
trueMaximum Length:80The status of the course requisites at the time of enrollment. -
ScheduledCourseCampusId: integer
(int64)
Title:
CampusRead Only:trueThe unique identifier for the campus where the course section is offered. -
ScheduledCourseCampusName: string
Title:
NameRead Only:trueMaximum Length:50The name of the campus where the course section is offered. -
ScheduledCourseCode: string
Title:
Associated Section CodeRead Only:trueMaximum Length:30The section code identifier of the enrolled course section. -
ScheduledCourseEndDate: string
(date-time)
Title:
Section End DateRead Only:trueThe end date of the enrolled course section. -
ScheduledCourseStartDate: string
(date-time)
Title:
Section Start DateRead Only:trueThe start date of the enrolled course section. -
TotalEnrolledQuantity: integer
(int32)
Title:
Total EnrolledRead Only:trueThe total number of students enrolled in the course section.
Nested Schema : Instructors
Type:
arrayTitle:
InstructorsThe instructors resource lists the instructors for the enrolled or scheduled items.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Meeting Patterns
Type:
arrayTitle:
Meeting PatternsThe meeting patterns resource lists the meeting pattern information for enrolled or scheduled items.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-instructors-item-response
Type:
Show Source
object-
CurriculumOfferingId: integer
(int64)
Title:
Curriculum Offering IDRead Only:trueThe unique identifier of curriculum offering of the course section. -
CurriculumOrgId: integer
(int64)
Read Only:
trueThe unique identifier of the curriculum organization of the course section staff. -
CurriculumStaffId: integer
(int64)
Title:
Curriculum Staff IDRead Only:trueThe unique identifier of the curriculum staff. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OfferSequenceNumber: integer
(int32)
Title:
Offer NumberRead Only:trueThe offering sequence number of the course section. -
PersonAcademicTitle: string
Title:
Academic TitleRead Only:trueMaximum Length:30The academic title of the instructor if one is available. -
PersonImageContent: string
(byte)
Read Only:
trueThe image data of the instructor. -
PersonImageId: integer
(int64)
Read Only:
trueThe image or photograph of the instructor, if available. -
PersonTitle: string
Title:
TitleRead Only:trueMaximum Length:60The title of the instructor. -
PreferredFirstName: string
Title:
First NameRead Only:trueMaximum Length:150The preferred first name of the person. -
PreferredLastName: string
Title:
Last NameRead Only:trueMaximum Length:150The preferred last name of the person. -
PreferredMiddleName: string
Title:
Middle NameRead Only:trueMaximum Length:60The preferred middle name of the person. -
PreferredName: string
Title:
Additional NameRead Only:trueMaximum Length:360The preferred first and last name of the person displayed as a single string. -
StaffAdministratorOnlyFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseIndicates that this staff member is part of the administrative staff. The default value is false. -
StaffBiography: string
(byte)
Title:
BiographyRead Only:trueThe biography of the instructor, if available. -
StaffPartyId: integer
(int64)
Read Only:
trueThe unique identifier for the party. -
StaffPrimaryFlag: boolean
Title:
PrimaryRead Only:trueMaximum Length:1The primary instructor of the course section. -
StaffRoleTypeCode: string
Title:
Role TypeRead Only:trueMaximum Length:30The role code that the course section staff will be filling -
StaffRoleTypeMeaning: string
Read Only:
trueMaximum Length:80The role that the course section staff will be filling.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrolledItems-meetingPatterns-item-response
Type:
Show Source
object-
BuildingName: string
Title:
NameRead Only:trueMaximum Length:50The building name of the facility where the meeting will be held. -
BuildingShortCode: string
Title:
CodeRead Only:trueMaximum Length:6The building code of the facility where the meeting will be held. -
CurriculumFormatCode: string
Read Only:
trueMaximum Length:30The 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:
trueMaximum Length:80The 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:
trueThe unique identifier of the meeting record. -
DurationQuantity: integer
(int32)
Title:
DurationRead Only:trueThe duration of the meeting. -
FacilityDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240A description of the facility where the meeting will be held. -
FacilityRoomNumber: string
Title:
Room NumberRead Only:trueMaximum Length:10The room number of the facility where the meeting will be held. -
FacilityShortCode: string
Title:
FacilityRead Only:trueMaximum Length:20The abbreviated facility code representing the building and room number. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationLatitude: number
Title:
LatitudeRead Only:trueThe latitude of the building where the meeting will be held. -
LocationLongitude: number
Title:
LongitudeRead Only:trueThe longitude of the building where the meeting will be held. -
LocationLongName: string
Read Only:
trueContains formatted address from either the associated facility or the user entered course location address. -
MeetingPatternDescription: string
Title:
Pattern NameRead Only:trueMaximum Length:50The description of the meeting pattern for the meeting. -
MeetingPatternEndDate: string
(date)
Title:
End DateRead Only:trueThe scheduled end date of the meeting. -
MeetingPatternEndTime: string
(date-time)
Title:
End TimeRead Only:trueThe scheduled end time of the meeting. -
MeetingPatternName: string
Title:
Meeting NameRead Only:trueMaximum Length:50The descriptive name of the meeting such as lab or lecture. -
MeetingPatternStartDate: string
(date)
Title:
Start DateRead Only:trueThe start date of the meeting schedule indicating the first day of class. -
MeetingPatternStartTime: string
(date-time)
Title:
Start TimeRead Only:trueThe scheduled start time of the meeting. -
RecurrenceDayFriFlag: boolean
Title:
FridayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Friday. -
RecurrenceDayMonFlag: boolean
Title:
MondayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Monday. -
RecurrenceDaySatFlag: boolean
Title:
SaturdayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Saturday. -
RecurrenceDaySunFlag: boolean
Title:
SundayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Sunday. -
RecurrenceDayThuFlag: boolean
Title:
ThursdayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Thursday. -
RecurrenceDayTueFlag: boolean
Title:
TuesdayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Tuesday. -
RecurrenceDayWedFlag: boolean
Title:
WednesdayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Wednesday. -
ScheduleSequenceNumber: integer
(int32)
Title:
Schedule Sequence NumberRead Only:trueThe sequence of the meeting. Used when a course section has more than a single meeting pattern.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-item-response
Type:
Show Source
object-
AcademicPeriodId: integer
(int64)
Title:
Academic Period IDRead Only:trueThe unique identifier for the academic period. -
AcademicPeriodTypeId: integer
(int64)
Title:
Academic Period Type IDRead Only:trueThe unique identifier of the academic period type. -
EndDate: string
(date)
Title:
End DateRead Only:trueThe date when the academic period ends. -
enrollmentPeriodDates: array
Period Dates
Title:
Period DatesThe enrollment period dates resource is used to display key dates for an enrollment period. -
EnrollmentPeriodName: string
Title:
NameRead Only:trueMaximum Length:50The name of the academic period. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PeriodCategoryCode: string
Title:
CategoryRead Only:trueMaximum Length:30The category code of the academic period. -
PeriodCategoryMeaning: string
Read Only:
trueMaximum Length:80The category of the academic period. -
PeriodTypeName: string
Title:
NameRead Only:trueMaximum Length:50The name of the academic period type. -
StartDate: string
(date)
Title:
Start DateRead Only:trueThe date when the academic period starts. -
WeeksOfInstruction: integer
(int32)
Title:
Weeks of InstructionRead Only:trueDefault Value:1The number of weeks of instruction for the academic period.
Nested Schema : Period Dates
Type:
arrayTitle:
Period DatesThe enrollment period dates resource is used to display key dates for an enrollment period.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-enrollmentPeriods-enrollmentPeriodDates-item-response
Type:
Show Source
object-
AcademicPeriodDateId: integer
(int64)
Title:
Academic Period Date IDThe unique identifier for an academic period date attribute. -
DateTimeCode: string
Title:
Date Time CodeRead Only:trueMaximum Length:30The unique code identifier for the date attribute. -
DateTimeId: integer
(int64)
Title:
Period Attribute IDThe unique identifier for the date attribute associated with the academic period. -
DateTimeMeaning: string
Title:
Date Time MeaningRead Only:trueMaximum Length:50The name of the identifier for the date attribute. -
FirstDateTime: string
(date-time)
Title:
DateThe date value associated with the date attribute. For date attributes defined as ranges this value represents the start date of the range. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SecondDateTime: string
(date-time)
Title:
Date Range EndThe end date value associated with the date range attribute. This value is only used for date attributes defined as ranges.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-recommendedItems-item-response
Type:
Show Source
object-
AcademicSubjectCode: string
Read Only:
trueMaximum Length:255The subject code for the course. -
AcademicSubjectId: integer
Read Only:
trueThe unique identifier for the subject of the course. -
AcademicSubjectName: string
Read Only:
trueMaximum Length:255The subject name for the course. -
CourseEnrollmentStatusCode: string
Read Only:
trueMaximum Length:255The enrollment status code of the course section indicating if the course is available for enrollment. -
CourseEnrollmentStatusMeaning: string
Read Only:
trueMaximum Length:255The enrollment status of the course section indicating if the course is available for enrollment. -
CourseOfferingId: integer
Read Only:
trueThe offering identifier for the course. -
CreditTypeCode: string
Read Only:
trueMaximum Length:255The credit type code for the course. -
CreditTypeMeaning: string
Read Only:
trueMaximum Length:255The credit type for the course or course section. -
CurriculumCatalogNumber: string
Read Only:
trueMaximum Length:255The catalog number for the course. -
ItemCurriculumId: integer
Read Only:
trueThe unique identifier of the curriculum item (course) that's recommended. -
ItemCurriculumName: string
Read Only:
trueThe name of the curriculum item (course) that's recommended. -
ItemCurriculumType: string
Read Only:
trueThe type of curriculum that's recommended. -
ItemCurriculumTypeId: integer
Read Only:
trueThe unique identifier for the type of curriculum that's recommended. -
ItemCurriculumTypeName: string
Read Only:
trueMaximum Length:255The type name of the curriculum that's recommended. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumUnitsQuantity: number
Read Only:
trueThe maximum number of units for which a course can be taken. -
MinimumUnitsQuantity: number
Read Only:
trueThe minimum number of units for which a course can be taken. -
OfferSequenceNumber: integer
Read Only:
trueThe offering sequence number for the course. -
RepeatAllowedFlag: boolean
Read Only:
trueMaximum Length:1Indicates that repeating the course is allowed. The default value is false. -
RepeatAllowedTotal: integer
Read Only:
trueThe total number of times a student can take a course. -
RepeatInPeriodFlag: boolean
Read Only:
trueIndicates that repeating the course is allowed within the same period. -
RepeatUnitsTotal: number
Read Only:
trueThe total number of repeated units which are allowed for the course. -
RequisiteExistsFlag: boolean
Read Only:
trueMaximum Length:1Indicates if requisites exist for the course. -
RequisiteInformation: string
(byte)
Read Only:
trueMaximum Length:255The text used to describe the requisites of a course. -
SourceProgramCurriculumId: integer
Read Only:
trueThe curriculum ID of the program used to generate the recommendation. -
SourceProgramTemplateId: integer
Read Only:
trueThe template ID of the program template used to generate the recommendation. -
SourceTemplatePeriodId: integer
Read Only:
trueThe template period ID of the program template used to generate the recommendation.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested 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 NameRead Only:trueMaximum Length:100The name of the academic level of the student enrolling in the course. -
AcademicSubjectCode: string
Read Only:
trueThe subject code for the course. -
AcademicSubjectId: integer
Read Only:
trueThe unique identifier for the subject of the course. -
AcademicSubjectName: string
Read Only:
trueThe subject name for the course. -
CalculatedClassEndDate: string
(date)
Read Only:
trueThe 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:
trueThe curriculum item identifier for the course. -
CourseEnrollmentStatusCode: string
Read Only:
trueThe enrollment status code of the course section indicating if the course is available for enrollment. -
CourseEnrollmentStatusMeaning: string
Read Only:
trueThe enrollment status of the course section indicating if the course is available for enrollment. -
CourseOfferingId: integer
Read Only:
trueThe offering identifier for the course. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the row. -
CreationDate: string
(date-time)
Read Only:
trueThe date the row was created. -
CreditOptionFlag: boolean
Maximum Length:
1Default Value:falseThe type of credit the student is enrolling in. -
CreditTypeCode: string
Read Only:
trueMaximum Length:255The 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:
trueThe 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:
trueThe catalog number for the course. -
CurriculumFormatCode: string
Title:
FormatRead Only:trueMaximum Length:30The 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:
trueMaximum Length:80The 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:
trueMaximum Length:255Indicates 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:
trueThe enrollment capacity of the course section. -
EnrollmentRequestStatusCode: string
Maximum Length:
30Default Value:ORA_SCHEDULEDThe 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:
trueMaximum Length:80The 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:
30The grading method option selected by the student for enrollment. -
instructors: array
Instructors
Title:
InstructorsThe instructors resource lists the instructors for the enrolled or scheduled items. -
IsSelfPacedFlag: boolean
Read Only:
trueIndicates 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:
NameRead Only:trueMaximum Length:150The name of the curriculum item for the course or course section that's scheduled. -
ItemCurriculumType: string
Title:
Curriculum Item TypeRead Only:trueMaximum Length:30The type of curriculum that's scheduled. -
ItemCurriculumTypeId: integer
(int64)
Read Only:
trueThe unique identifier for the type of curriculum that's scheduled. -
ItemCurriculumTypeName: string
Read Only:
trueMaximum Length:50The type name of the curriculum that's scheduled. -
LastDateToDrop: string
(date-time)
Read Only:
trueThe last date the student can drop the course section without penalty. -
LastDateToDropWithGreaterPenalty: string
(date-time)
Read Only:
trueThe last date the student can drop the course section with a greater drop penalty. -
LastDateToDropWithoutRetain: string
(date-time)
Read Only:
trueThe 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:
trueThe last date the student can drop the course section with some sort of drop penalty applied. -
LastDateToDropWithRetain: string
(date-time)
Read Only:
trueThe last date the student can drop the course section and receive a withdraw status. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date the row was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumUnitsQuantity: number
Read Only:
trueThe maximum number of units for which a course can be taken. -
meetingPatterns: array
Meeting Patterns
Title:
Meeting PatternsThe meeting patterns resource lists the meeting pattern information for enrolled or scheduled items. -
MinimumUnitsQuantity: number
Read Only:
trueThe 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:
trueIndicates that repeating the course is allowed. The default value is false. -
RepeatAllowedTotal: integer
Read Only:
trueThe total number of times a student can take a course. -
RepeatInPeriodFlag: boolean
Read Only:
trueIndicates that repeating the course is allowed within the same period. -
RepeatUnitsTotal: number
Read Only:
trueThe total number of repeated units which are allowed for the course. -
RequisiteExistsFlag: boolean
Read Only:
trueMaximum Length:255Indicates that requisites exist for the enrolled course. -
RequisiteInformation: string
Read Only:
trueMaximum Length:255The text used to describe the requisites of a course. -
ScheduledCourseCampusId: integer
Read Only:
trueThe unique identifier for the campus where the course section is offered. -
ScheduledCourseCampusName: string
Read Only:
trueMaximum Length:255The name of the campus where the course section is offered. -
ScheduledCourseCode: string
Read Only:
trueThe section code of the course section. -
ScheduledCourseEndDate: string
(date-time)
Read Only:
trueThe date when the course section ends. -
ScheduledCourseStartDate: string
(date-time)
Read Only:
trueThe date when the course section starts. -
ScheduledItemId: integer
(int64)
Read Only:
trueThe unique identifier of the scheduled item. -
TotalEnrolledQuantity: integer
Read Only:
trueThe number of students currently enrolled in the course section.
Nested Schema : Instructors
Type:
arrayTitle:
InstructorsThe instructors resource lists the instructors for the enrolled or scheduled items.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Meeting Patterns
Type:
arrayTitle:
Meeting PatternsThe 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 IDRead Only:trueThe unique identifier of curriculum offering of the course section. -
CurriculumOrgId: integer
(int64)
Read Only:
trueThe unique identifier of the curriculum organization of the course section staff. -
CurriculumStaffId: integer
(int64)
Title:
Curriculum Staff IDRead Only:trueThe unique identifier of the curriculum staff. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OfferSequenceNumber: integer
(int32)
Title:
Offer NumberRead Only:trueThe offering sequence number of the course section. -
PersonAcademicTitle: string
Title:
Academic TitleRead Only:trueMaximum Length:30The academic title of the instructor if one is available. -
PersonImageContent: string
(byte)
Read Only:
trueThe image data of the instructor. -
PersonImageId: integer
(int64)
Read Only:
trueThe image or photograph of the instructor, if available. -
PersonTitle: string
Title:
TitleRead Only:trueMaximum Length:60The title of the instructor. -
PreferredFirstName: string
Title:
First NameRead Only:trueMaximum Length:150The preferred first name of the person. -
PreferredLastName: string
Title:
Last NameRead Only:trueMaximum Length:150The preferred last name of the person. -
PreferredMiddleName: string
Title:
Middle NameRead Only:trueMaximum Length:60The preferred middle name of the person. -
PreferredName: string
Title:
Additional NameRead Only:trueMaximum Length:360The preferred first and last name of the person displayed as a single string. -
StaffAdministratorOnlyFlag: boolean
Read Only:
trueMaximum Length:1Default Value:falseIndicates that this staff member is part of the administrative staff. The default value is false. -
StaffBiography: string
(byte)
Title:
BiographyRead Only:trueThe biography of the instructor, if available. -
StaffPartyId: integer
(int64)
Read Only:
trueThe unique identifier for the party. -
StaffPrimaryFlag: boolean
Title:
PrimaryRead Only:trueMaximum Length:1The primary instructor of the course section. -
StaffRoleTypeCode: string
Title:
Role TypeRead Only:trueMaximum Length:30The role code that the course section staff will be filling -
StaffRoleTypeMeaning: string
Read Only:
trueMaximum Length:80The role that the course section staff will be filling.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-scheduledItems-meetingPatterns-item-response
Type:
Show Source
object-
BuildingName: string
Title:
NameRead Only:trueMaximum Length:50The building name of the facility where the meeting will be held. -
BuildingShortCode: string
Title:
CodeRead Only:trueMaximum Length:6The building code of the facility where the meeting will be held. -
CurriculumFormatCode: string
Read Only:
trueMaximum Length:30The 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:
trueMaximum Length:80The 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:
trueThe unique identifier of the meeting record. -
DurationQuantity: integer
(int32)
Title:
DurationRead Only:trueThe duration of the meeting. -
FacilityDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240A description of the facility where the meeting will be held. -
FacilityRoomNumber: string
Title:
Room NumberRead Only:trueMaximum Length:10The room number of the facility where the meeting will be held. -
FacilityShortCode: string
Title:
FacilityRead Only:trueMaximum Length:20The abbreviated facility code representing the building and room number. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationLatitude: number
Title:
LatitudeRead Only:trueThe latitude of the building where the meeting will be held. -
LocationLongitude: number
Title:
LongitudeRead Only:trueThe longitude of the building where the meeting will be held. -
LocationLongName: string
Read Only:
trueContains formatted address from either the associated facility or the user entered course location address. -
MeetingPatternDescription: string
Title:
Pattern NameRead Only:trueMaximum Length:50The description of the meeting pattern for the meeting. -
MeetingPatternEndDate: string
(date)
Title:
End DateRead Only:trueThe scheduled end date of the meeting. -
MeetingPatternEndTime: string
(date-time)
Title:
End TimeRead Only:trueThe scheduled end time of the meeting. -
MeetingPatternName: string
Title:
Meeting NameRead Only:trueMaximum Length:50The descriptive name of the meeting such as lab or lecture. -
MeetingPatternStartDate: string
(date)
Title:
Start DateRead Only:trueThe start date of the meeting schedule indicating the first day of class. -
MeetingPatternStartTime: string
(date-time)
Title:
Start TimeRead Only:trueThe scheduled start time of the meeting. -
RecurrenceDayFriFlag: boolean
Title:
FridayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Friday. -
RecurrenceDayMonFlag: boolean
Title:
MondayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Monday. -
RecurrenceDaySatFlag: boolean
Title:
SaturdayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Saturday. -
RecurrenceDaySunFlag: boolean
Title:
SundayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Sunday. -
RecurrenceDayThuFlag: boolean
Title:
ThursdayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Thursday. -
RecurrenceDayTueFlag: boolean
Title:
TuesdayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Tuesday. -
RecurrenceDayWedFlag: boolean
Title:
WednesdayRead Only:trueMaximum Length:1Default Value:falseIndicates that the meeting will occur on a Wednesday. -
ScheduleSequenceNumber: integer
(int32)
Title:
Schedule Sequence NumberRead Only:trueThe sequence of the meeting. Used when a course section has more than a single meeting pattern.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-schedulePeriodDates-item-response
Type:
Show Source
object-
AcademicPeriodDateId: integer
(int64)
Title:
Academic Period Date IDThe unique identifier for an academic period date attribute. -
DateTimeCode: string
Title:
Date Time CodeRead Only:trueMaximum Length:30The unique code identifier for the date attribute. -
DateTimeId: integer
(int64)
Title:
Period Attribute IDThe unique identifier for the date attribute associated with the academic period. -
DateTimeMeaning: string
Title:
Date Time MeaningRead Only:trueMaximum Length:50The name of the identifier for the date attribute. -
FirstDateTime: string
(date-time)
Title:
DateThe date value associated with the date attribute. For date attributes defined as ranges this value represents the start date of the range. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SecondDateTime: string
(date-time)
Title:
Date Range EndThe end date value associated with the date range attribute. This value is only used for date attributes defined as ranges.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source