Get an enrolled item
get
/fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/enrolledItems/{enrolledItemsUniqID}
Request
Path Parameters
-
enrolledItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Enrolled Items resource and used to uniquely identify an instance of Enrolled Items. The client should not generate the hash key value. Instead, the client should query on the Enrolled Items collection resource in order to navigate to a specific instance of Enrolled Items to get the hash key.
-
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.
-
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.
Query Parameters
-
dependency: string
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> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
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. -
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(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-enrolledItems-item-response
Type:
Show Source
object
-
AcademicLevelIdOption: integer
(int64)
The unique identifier of the academic level.
-
AcademicLevelNameOption: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of the academic level. -
AcademicSubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The subject code of the enrolled course. -
AcademicSubjectId: integer
(int64)
Title:
Academic Subject ID
Read Only:true
The subject unique identifier of the enrolled course. -
AcademicSubjectName: string
Title:
Subject Name
Read Only:true
Maximum Length:50
The subject name of the enrolled course. -
CalculatedClassEndDate: string
(date)
Read Only:
true
The 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 Status
Read Only:true
Maximum Length:30
Default Value:ORA_OPN
The enrolling status code for the course section. -
CourseEnrollingStatusMeaning: string
Read Only:
true
Maximum Length:80
The enrolling status of the course section. -
CourseOfferingId: integer
(int64)
Read Only:
true
The offering unique identifier of the curriculum item. -
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 credit option for the course enrollment. -
CreditTypeCode: string
Title:
Credit Type Code
Read Only:true
Maximum Length:30
The credit type code of the enrolled course. -
CreditTypeMeaning: string
Title:
Credit Type
Read Only:true
Maximum Length:80
The credit type of the enrolled course. -
CurriculumCatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The catalog number of the enrolled 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 curriculum enrollment options record.
-
DropDate: string
(date)
Title:
Drop Date
Read Only:true
The date when the student dropped the scheduled course. -
DropEnabledFlag: boolean
Read Only:
true
Indicates that this course section can be dropped by the student. -
EnrolledCreditQuantity: number
Title:
Units
Read Only:true
The 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 Capacity
Read Only:true
The total number of enrolled students allowed to enroll in the enrolled course section. -
EnrollmentDate: string
(date)
Title:
Enrollment Date
Read Only:true
The date of the enrollment. -
EnrollmentItemId: integer
(int64)
Title:
Student Curriculum Item ID
Read Only:true
The unique identifier of the enrollment item. -
EnrollmentStatus: string
Title:
Enrollment Status
Read Only:true
Maximum Length:30
The status code of the enrollment. -
EnrollmentStatusMeaning: string
Title:
Enrollment Status Meaning
Read Only:true
Maximum Length:80
The status of the enrollment. -
GradingOptionCode: string
Maximum Length:
30
The grading option for the course enrollment. -
instructors: array
Instructors
Title:
Instructors
The instructors resource lists the instructors for the enrolled or scheduled items. -
IsSelfPacedFlag: boolean
Title:
Self-Paced
Read Only:true
Maximum Length:1
Indicates that the enrolled course section is self paced. -
ItemCurriculumId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The identifier of the enrolled curriculum item. -
ItemCurriculumName: string
Title:
Title
Read Only:true
Maximum Length:150
The name of the enrolled curriculum item. -
ItemCurriculumType: string
Title:
Curriculum Item Type
Read Only:true
Maximum Length:30
The curriculum type code of the enrolled item. -
ItemCurriculumTypeId: integer
(int64)
Title:
Curriculum Type
Read Only:true
The identifier of the curriculum type for the enrolled item. -
ItemCurriculumTypeName: string
Read Only:
true
Maximum Length:50
The name of the curriculum type. -
LastDateToDrop: string
(date-time)
Read Only:
true
The last day the student is allowed to drop this course. -
LastDateToDropWithGreaterPenalty: string
(date-time)
Read Only:
true
The 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:
true
The 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:
true
The 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:
true
The 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:
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
Title:
Maximum Units
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
Title:
Minimum Units
Read Only:true
The minimum number of units for which a course can be taken. -
OfferSequenceNumber: integer
(int32)
Title:
Owning Offer Number
Read Only:true
The offering sequence number of the course. -
OwningCurriculumId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The curriculum Id of the course that owns the course section. -
OwningCurriculumName: string
Title:
Title
Read Only:true
Maximum Length:150
The curriculum name of the course that owns the course section. -
RepeatAllowedFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Indicates that repeating the course is allowed. The default value is false. -
RepeatAllowedTotal: integer
(int32)
Read Only:
true
The total number of times a student can take a course. -
RepeatInPeriodFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
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
Indicates that requisites exist for the enrolled course. -
RequisiteInformation: string
Read Only:
true
The text used to describe the requisites of a course. -
RequisiteStatusCode: string
Title:
Requisite Status Code
Read Only:true
Maximum Length:30
The status code of the course requisites at time of enrollment. -
RequisiteStatusMeaning: string
Read Only:
true
Maximum Length:80
The status of the course requisites at the time of enrollment. -
ScheduledCourseCampusId: integer
(int64)
Title:
Campus
Read Only:true
The unique identifier for the campus where the course section is offered. -
ScheduledCourseCampusName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the campus where the course section is offered. -
ScheduledCourseCode: string
Title:
Associated Section Code
Read Only:true
Maximum Length:30
The section code identifier of the enrolled course section. -
ScheduledCourseEndDate: string
(date-time)
Title:
Section End Date
Read Only:true
The end date of the enrolled course section. -
ScheduledCourseStartDate: string
(date-time)
Title:
Section Start Date
Read Only:true
The start date of the enrolled course section. -
TotalEnrolledQuantity: integer
(int32)
Title:
Total Enrolled
Read Only:true
The total number of students 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-enrolledItems-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-enrolledItems-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:
- enrolledItemsUniqID:
$request.path.enrolledItemsUniqID
- schedulePeriodsUniqID:
$request.path.schedulePeriodsUniqID
- studentScheduleByPeriodsUniqID:
$request.path.studentScheduleByPeriodsUniqID
The instructors resource lists the instructors for the enrolled or scheduled items. - enrolledItemsUniqID:
- meetingPatterns
-
Parameters:
- enrolledItemsUniqID:
$request.path.enrolledItemsUniqID
- schedulePeriodsUniqID:
$request.path.schedulePeriodsUniqID
- studentScheduleByPeriodsUniqID:
$request.path.studentScheduleByPeriodsUniqID
The meeting patterns resource lists the meeting pattern information for enrolled or scheduled items. - enrolledItemsUniqID: