Get a scheduled course
get
/fscmRestApi/resources/11.13.18.05/curriculumItems/{curriculumItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}
Request
Path Parameters
-
curriculumItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Curriculum Items resource and used to uniquely identify an instance of Curriculum Items. The client should not generate the hash key value. Instead, the client should query on the Curriculum Items collection resource in order to navigate to a specific instance of Curriculum Items to get the hash key.
-
scheduledCourseUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Scheduled Courses resource and used to uniquely identify an instance of Scheduled Courses. The client should not generate the hash key value. Instead, the client should query on the Scheduled Courses collection resource in order to navigate to a specific instance of Scheduled Courses 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: string
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: string
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: string
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 : curriculumItems-scheduledCourse-item-response
Type:
Show Source
object-
AcademicLevelId: integer
(int64)
Title:
Academic Level IDRead Only:trueThe unique identifier for an academic level value that's associated with a course. -
AcademicLevelName: string
Title:
Academic Level NameRead Only:trueMaximum Length:100The name of an academic level, such as undergraduate, that's associated with a course. -
AcademicOrgId: integer
(int64)
Title:
Academic Organization IDRead Only:trueThe unique identifier of the academic organization of the scheduled course. -
AcademicSubjectCode: string
Title:
Subject CodeRead Only:trueMaximum Length:30The code for the scheduled course's academic subject. -
AcademicSubjectId: integer
(int64)
Title:
Academic Subject IDRead Only:trueThe unique identifier for the course's academic subject. -
AcademicSubjectName: string
Title:
NameRead Only:trueMaximum Length:50The name of the subject of the scheduled course. -
BuildingName: string
Title:
NameRead Only:trueThe name of the building associated with the meeting pattern of the scheduled course. -
BuildingShortCode: string
Title:
CodeRead Only:trueThe unique identifier of the building associated with the meeting pattern of the scheduled course. -
CampusId: integer
(int64)
Title:
CampusRead Only:trueThe unique identifier for the campus where a course is offered. -
CampusName: string
Title:
CampusRead Only:trueMaximum Length:50The campus where the scheduled course is offered. -
ConsentTypeCode: string
Title:
Permission TypeRead Only:trueMaximum Length:30Default Value:ORA_NOT_REQUIREDThe type of enrollment consent required by the student. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. Examples include course instructor, department chair and registrar. -
ConsentTypeMeaning: string
Title:
Consent Type MeaningRead Only:trueMaximum Length:80The meaning of the consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. -
CoursePayToEnrollFlag: boolean
Title:
Pay to enrollRead Only:trueMaximum Length:1Default Value:falseIndicates that the student must pay for the course at the time of enrollment. The default value is false. -
CredentialId: integer
(int64)
Title:
Scheduled Course Credential IDRead Only:trueThe unique identifier of the credential associated with the course. -
CredentialName: string
Title:
NameRead Only:trueMaximum Length:50The name of the credential associated with the scheduled course. -
CredentialTypeCode: string
Title:
Credential TypeRead Only:trueMaximum Length:30The code for the type of credential associated with the scheduled course. Valid values include ORA_CERTIFICATE, ORA_DEGREE, or ORA_DIPLOMA. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_TYPE_CODE. -
CreditTypeCode: string
Title:
Type of CreditRead Only:trueMaximum Length:30The code for the type of credit associated with the scheduled 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
Title:
Type of Credit MeaningRead Only:trueMaximum Length:80The meaning of the type of credit of the scheduled 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
Title:
Catalog NumberRead Only:trueMaximum Length:10The catalog number of the scheduled course. -
CurriculumFormatCode: string
Title:
FormatRead Only:trueMaximum Length:30The code for the format of the scheduled 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
Title:
Curriculum Format MeaningRead Only:trueMaximum Length:80The meaning of the format of the scheduled 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. -
CurriculumHeaderId: integer
(int64)
Title:
Curriculum Header IDRead Only:trueThe unique identifier for a curriculum header record. -
CurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe generated unique identifier of a scheduled course. -
CurriculumLongDescription: string
Title:
Long DescriptionRead Only:trueThe description of the scheduled course. -
CurriculumName: string
Title:
NameRead Only:trueMaximum Length:150The name of the scheduled course. -
CurriculumTitle: string
Title:
TitleRead Only:trueMaximum Length:100The title of the scheduled course. -
EnrollConsentRequiredFlag: boolean
Title:
Permission Required to EnrollRead Only:trueMaximum Length:1Default Value:falseIndicates that a student must obtain consent to enroll in the curriculum item. The default value is inherited from the course. -
EnrollmentCapacityQuantity: integer
(int32)
Title:
Enrollment CapacityRead Only:trueA numeric value indicating the enrollment capacity of the scheduled course. -
EnrollmentStatusCode: string
Title:
Enrollment StatusRead Only:trueMaximum Length:30Default Value:ORA_OPNThe unique identifier of the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE. -
EnrollmentStatusMeaning: string
Title:
Enrollment Status MeaningRead Only:trueMaximum Length:80The meaning of the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE. -
FacilityDescription: string
Title:
DescriptionRead Only:trueThe description of the facility associated with the scheduled course. -
FacilityRoomNumber: string
Title:
Room NumberRead Only:trueThe room number associated with the meeting pattern of the scheduled course. -
FacilityShortCode: string
Title:
FacilityRead Only:trueThe identifier of the facility associated with the meeting pattern of the scheduled course. -
FlatAmount: number
Title:
Flat AmountRead Only:trueThe numeric value of the flat amount charge of a scheduled course. -
FlatAmountCurrencyCode: string
Title:
Currency CodeRead Only:trueThe unique identifier of the flat amount charge of a scheduled course. -
FlatAmountCurrencySymbol: string
Title:
Currency SymbolRead Only:trueThe denomination of the flat amount charge of a scheduled course. -
images: array
Images
Title:
ImagesThe images resource is a child of the courses resource and provides a list of image attachments associated with a course. -
InstitutionId: integer
(int64)
Title:
Institution IDRead Only:trueThe unique identifier for the institution where the scheduled course is offered. -
InstitutionName: string
Title:
InstitutionRead Only:trueMaximum Length:50The name of the institution where the scheduled course is offered. -
InstructorName: string
Title:
NameRead Only:trueThe name of the instructor of the scheduled course. -
IsCartableFlag: boolean
Title:
Shopping Cart EnabledRead Only:trueIndicates whether the scheduled course can be added to the shopping cart. The default value is true. -
IsSchedulableFlag: boolean
Title:
Scheduler EnabledRead Only:trueIndicates whether the scheduled course can be added to the scheduler. The default value is true. -
IsSelfPacedFlag: boolean
Title:
Self-PacedRead Only:trueIndicates whether the scheduled course is self-paced. The default value is false. -
IsWishableFlag: boolean
Title:
Wish List EnabledRead Only:trueIndicates whether the scheduled course can be added to the wish list. The default value is true. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationControlCode: string
Title:
Location Control CodeRead Only:trueThe unique identifier of the single use location associated with the meeting pattern of the scheduled course. -
LocationLatitude: number
Title:
LatitudeRead Only:trueThe GPS latitude coordinates for the scheduled course meeting location. -
LocationLongitude: number
Title:
LongitudeRead Only:trueThe GPS longitude coordinates for the scheduled course meeting location. -
LocationLongName: string
Title:
Location Long NameRead Only:trueThe name of the single use location associated with the meeting pattern of the scheduled course. -
MapIntegrationURL: string
Title:
Map Integration URLRead Only:trueThe uniform resource locator of the map application to be used for displaying scheduled course meeting location. -
MaximumUnitsQuantity: number
Title:
Maximum UnitsRead Only:trueA numeric value indicating the maximum units of the scheduled course. -
MeetingPatternDescription: string
Title:
Pattern NameRead Only:trueThe name of the meeting pattern of the scheduled course. -
MeetingPatternEndDate: string
(date)
Title:
End DateRead Only:trueThe date when the meeting pattern of the scheduled course ends. -
MeetingPatternEndTime: string
(date-time)
Title:
End TimeRead Only:trueThe time when the meeting pattern of the scheduled course ends. -
meetingPatterns: array
Meeting Patterns
Title:
Meeting PatternsThe meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course. -
MeetingPatternStartDate: string
(date)
Title:
Start DateRead Only:trueThe date when the meeting pattern of the scheduled course starts. -
MeetingPatternStartTime: string
(date-time)
Title:
Start TimeRead Only:trueThe time when the meeting pattern of the scheduled course starts. -
MinimumUnitsQuantity: number
Title:
Minimum UnitsRead Only:trueA numeric value indicating the minimum units of the scheduled course. -
OwningCurriculumId: integer
(int64)
Title:
Owning Curriculum IDRead Only:trueThe unique identifier for the parent curriculum item of the scheduled course. -
OwningCurriculumName: string
Title:
NameRead Only:trueMaximum Length:150The name for the parent curriculum item of the scheduled course. -
OwningOfferNumber: integer
(int32)
Title:
Owning Offer NumberRead Only:trueThe unique identifier for the parent curriculum item offer number of the scheduled course. -
ReportingPeriodEndDate: string
(date)
Title:
Reporting Period End DateRead Only:trueThe date when the reporting period associated with the scheduled course ends. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period IDRead Only:trueThe unique identifier for the reporting period associated with the scheduled course. -
ReportingPeriodName: string
Title:
Reporting PeriodRead Only:trueMaximum Length:50The name of the reporting period associated with the scheduled course. -
ReportingPeriodStartDate: string
(date)
Title:
Reporting Period Start DateRead Only:trueThe date when the reporting period associated with the scheduled course starts. -
ScheduledCourseCode: string
Title:
Scheduled Course CodeRead Only:trueMaximum Length:30The code used to identify a scheduled course within a given course and academic period. -
ScheduledCourseEndDate: string
(date-time)
Title:
End DateRead Only:trueThe date when the scheduled course ends. -
ScheduledCourseNumber: integer
(int32)
Title:
Scheduled Course NumberRead Only:trueA generated unique key for a scheduled course. -
ScheduledCourseStartDate: string
(date-time)
Title:
Start DateRead Only:trueThe date when the scheduled course starts. -
StudentRequestConsentFlag: boolean
Title:
Allow Permission RequestRead Only:trueMaximum Length:1Default Value:falseIndicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is inherited from the course. -
TotalEnrolledQuantity: integer
(int32)
Title:
Total EnrolledRead Only:trueA numeric value indicating the number of enrollments in the scheduled course. -
URLAddress: string
Title:
URL AddressRead Only:trueThe unique URL address of the scheduled course.
Nested Schema : Images
Type:
arrayTitle:
ImagesThe images resource is a child of the courses resource and provides a list of image attachments associated with a course.
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 is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.
Show Source
Nested Schema : curriculumItems-scheduledCourse-images-item-response
Type:
Show Source
object-
ImageContent: string
(byte)
Title:
Attachment ContentRead Only:trueThe content of the attachment associated with the course. -
ImageContextCode: string
Title:
Curriculum Attachment ContextRead Only:trueMaximum Length:30The context name of the attachment associated with the course. -
ImageId: integer
(int64)
Title:
Curriculum Attachment IDRead Only:trueThe unique identifier of the attachment associated with the course. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
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 : curriculumItems-scheduledCourse-meetingPatterns-item-response
Type:
Show Source
object-
BuildingName: string
Title:
NameRead Only:trueMaximum Length:50The name of the building associated with the meeting pattern of the scheduled course. -
BuildingShortCode: string
Title:
CodeRead Only:trueMaximum Length:6The unique identifier of the building associated with the meeting pattern of the scheduled course. -
CurriculumScheduleId: integer
(int64)
Title:
Schedule IDRead Only:trueThe generated primary key column for a meeting pattern of the scheduled course. -
DurationQuantity: integer
(int32)
Title:
DurationRead Only:trueThe numeric value that indicates the length of a meeting of the scheduled course. -
FacilityDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240The description of the meeting pattern of the scheduled course. -
FacilityRoomNumber: string
Title:
Room NumberRead Only:trueMaximum Length:10The room number associated with the meeting pattern of the scheduled course. -
FacilityShortCode: string
Title:
FacilityRead Only:trueMaximum Length:20The identifier of the facility associated with the meeting pattern of the scheduled course. -
InstructionalMethodCode: string
Title:
Instructional Method CodeRead Only:trueMaximum Length:30The instructional method code of the meeting. -
InstructionalMethodMeaning: string
Title:
Instructional MethodRead Only:trueMaximum Length:80The instructional method meaning of the meeting. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationControlCode: string
Title:
Location Control CodeRead Only:trueMaximum Length:30Default Value:ORA_USE_FACILITYThe unique identifier of the single use location associated with the meeting pattern of the scheduled course. -
LocationLatitude: number
Title:
LatitudeRead Only:trueThe GPS latitude coordinates for the scheduled course meeting location. -
LocationLongitude: number
Title:
LongitudeRead Only:trueThe GPS longitude coordinates for the scheduled course meeting location. -
LocationLongName: string
Title:
Location Long NameRead Only:trueThe name of the single use location associated with the meeting pattern of the scheduled course. -
MeetingPatternDescription: string
Title:
Pattern NameRead Only:trueMaximum Length:50The name of the meeting pattern of the scheduled course. -
MeetingPatternEndDate: string
(date)
Title:
End DateRead Only:trueThe date when the meeting pattern of the scheduled course ends. -
MeetingPatternEndTime: string
(date-time)
Title:
End TimeRead Only:trueThe time when the meeting pattern of the scheduled course ends. -
MeetingPatternName: string
Title:
Meeting NameRead Only:trueMaximum Length:50The meeting name of the course scheduled in the facility. -
MeetingPatternStartDate: string
(date)
Title:
Start DateRead Only:trueThe date when the meeting pattern of the scheduled course starts. -
MeetingPatternStartTime: string
(date-time)
Title:
Start TimeRead Only:trueThe time when the meeting pattern of the scheduled course starts. -
RecurrenceDayFriFlag: boolean
Title:
FridayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Friday. -
RecurrenceDayMonFlag: boolean
Title:
MondayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Monday. -
RecurrenceDaySatFlag: boolean
Title:
SaturdayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Saturday. -
RecurrenceDaySunFlag: boolean
Title:
SundayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Sunday. -
RecurrenceDayThuFlag: boolean
Title:
ThursdayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Thursday. -
RecurrenceDayTueFlag: boolean
Title:
TuesdayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Tuesday. -
RecurrenceDayWedFlag: boolean
Title:
WednesdayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Wednesday. -
ScheduleSequenceNumber: integer
(int32)
Title:
Schedule Sequence NumberRead Only:trueThe sequence identifier of the meeting pattern of the scheduled course.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- CourseOfferingLOV
-
Parameters:
- finder:
ByCurriculumTypeFinder%3BCurriculumTypeCodes%3DCOURSE
The following properties are defined on the LOV link relation:- Source Attribute: OwningCurriculumId; Target Attribute: CurriculumId
- Display Attribute: CurriculumId, OfferSequenceNumber
- finder:
- consentTypeCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HER_CONSENT_TYPE_CODE
The following properties are defined on the LOV link relation:- Source Attribute: ConsentTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- images
-
Parameters:
- curriculumItemsUniqID:
$request.path.curriculumItemsUniqID - scheduledCourseUniqID:
$request.path.scheduledCourseUniqID
The images resource is a child of the courses resource and provides a list of image attachments associated with a course. - curriculumItemsUniqID:
- meetingPatterns
-
Parameters:
- curriculumItemsUniqID:
$request.path.curriculumItemsUniqID - scheduledCourseUniqID:
$request.path.scheduledCourseUniqID
The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course. - curriculumItemsUniqID: