1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Student Schedule by Periods
  4. Schedule Periods
  5. Enrolled Items

Get all enrolled items

get

/fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems

Request

Path Parameters
  • 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.
  • 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.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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).
  • 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
  • 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 enrolled items that match the enrollment ID.
      Finder Variables
      • CurriculumOptionId; integer; The unique identifier of the associated enrollment options record.
      • EnrollmentItemId; integer; The unique identifier for the enrolled item.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AcademicLevelIdOption; integer; The unique identifier of the academic level.
    • AcademicLevelNameOption; string; The name of the academic level.
    • AcademicSubjectCode; string; The subject code of the enrolled course.
    • AcademicSubjectId; integer; The subject unique identifier of the enrolled course.
    • AcademicSubjectName; string; The subject name of the enrolled course.
    • CalculatedClassEndDate; string; The calculated course section end date for the self-paced course enrollment.
    • ClassStartDateOption; string; The course section start date for the self-paced course enrollment
    • CourseEnrollingStatusCode; string; The enrolling status code for the course section.
    • CourseEnrollingStatusMeaning; string; The enrolling status of the course section.
    • CourseOfferingId; integer; The offering unique identifier of the curriculum item.
    • CreatedBy; string; The user who created the row.
    • CreationDate; string; The date the row was created.
    • CreditOptionFlag; boolean; The credit option for the course enrollment.
    • CreditTypeCode; string; The credit type code of the enrolled course.
    • CreditTypeMeaning; string; The credit type of the enrolled course.
    • CurriculumCatalogNumber; string; The catalog number of the enrolled course.
    • CurriculumFormatCode; string; 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; 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; The unique identifier of the curriculum enrollment options record.
    • DropDate; string; The date when the student dropped the scheduled course.
    • DropEnabledFlag; boolean; Indicates that this course section can be dropped by the student.
    • EnrolledCreditQuantity; number; The number of credits the student enrolled in for the course.
    • EnrolledCreditsOption; number; The number of enrolled credits for the course enrollment.
    • EnrollmentCapacityQuantity; integer; The total number of enrolled students allowed to enroll in the enrolled course section.
    • EnrollmentDate; string; The date of the enrollment.
    • EnrollmentItemId; integer; The unique identifier of the enrollment item.
    • EnrollmentStatus; string; The status code of the enrollment.
    • EnrollmentStatusMeaning; string; The status of the enrollment.
    • GradingOptionCode; string; The grading option for the course enrollment.
    • IsSelfPacedFlag; boolean; Indicates that the enrolled course section is self paced.
    • ItemCurriculumId; integer; The identifier of the enrolled curriculum item.
    • ItemCurriculumName; string; The name of the enrolled curriculum item.
    • ItemCurriculumType; string; The curriculum type code of the enrolled item.
    • ItemCurriculumTypeId; integer; The identifier of the curriculum type for the enrolled item.
    • ItemCurriculumTypeName; string; The name of the curriculum type.
    • LastUpdateDate; string; The date the row was last updated.
    • LastUpdatedBy; string; The user who last updated the row.
    • MaximumUnitsQuantity; number; The maximum number of units for which a course can be taken.
    • MinimumUnitsQuantity; number; The minimum number of units for which a course can be taken.
    • OfferSequenceNumber; integer; The offering sequence number of the course.
    • OwningCurriculumId; integer; The curriculum Id of the course that owns the course section.
    • OwningCurriculumName; string; The curriculum name of the course that owns the course section.
    • RepeatAllowedFlag; boolean; Indicates that repeating the course is allowed. The default value is false.
    • RepeatAllowedTotal; integer; The total number of times a student can take a course.
    • RepeatInPeriodFlag; boolean; Indicates that repeating the course is allowed within the same period.
    • RepeatUnitsTotal; number; The total number of repeated units which are allowed for the course.
    • RequisiteExistsFlag; boolean; Indicates that requisites exist for the enrolled course.
    • RequisiteInformation; string; The text used to describe the requisites of a course.
    • RequisiteStatusCode; string; The status code of the course requisites at time of enrollment.
    • RequisiteStatusMeaning; string; The status of the course requisites at the time of enrollment.
    • ScheduledCourseCampusId; integer; The unique identifier for the campus where the course section is offered.
    • ScheduledCourseCampusName; string; The name of the campus where the course section is offered.
    • ScheduledCourseCode; string; The section code identifier of the enrolled course section.
    • ScheduledCourseEndDate; string; The end date of the enrolled course section.
    • ScheduledCourseStartDate; string; The start date of the enrolled course section.
    • TotalEnrolledQuantity; integer; The total number of students enrolled in the course section.
  • 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
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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.

There's no request body for this operation.

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-schedulePeriods-enrolledItems
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
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
Back to Top