Get a scheduled course
get
/fscmRestApi/resources/11.13.18.05/wishlists/{WishlistId}/child/wishlistItems/{wishlistItemsUniqID}/child/scheduledCourse/{scheduledCourseUniqID}
Request
Path Parameters
-
WishlistId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
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.
-
wishlistItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Wish List Items resource and used to uniquely identify an instance of Wish List Items. The client should not generate the hash key value. Instead, the client should query on the Wish List Items collection resource in order to navigate to a specific instance of Wish List Items 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:
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 : wishlists-wishlistItems-scheduledCourse-item-response
Type:
Show Source
object-
AcademicLevelId: integer
(int64)
Title:
Academic Level IDRead Only:trueThe unique identifier for an academic level 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 associated with the scheduled course. -
AcademicSubjectCode: string
Title:
Subject CodeRead Only:trueMaximum Length:30A code for an 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 academic subject. -
BuildingName: string
Title:
NameRead Only:trueThe name of the building in which a scheduled course occurs. -
BuildingShortCode: string
Title:
CodeRead Only:trueThe code or identifier for the building in which a scheduled course occurs. -
CampusId: integer
(int64)
Title:
Campus IDRead 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. -
CoursePayToEnrollFlag: boolean
Title:
Pay to enrollRead Only:trueMaximum Length:1Indicates that the student must pay for the course at the time of enrollment. -
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 assigned to a 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 a scheduled course credit type code. 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. -
CurrencyCode: string
Title:
Currency CodeRead Only:trueThe currency of the course fee. -
CurrencySymbol: string
Title:
Currency SymbolRead Only:trueThe currency symbol associated with a scheduled course fee. -
CurriculumCatalogNumber: string
Title:
Catalog NumberRead Only:trueMaximum Length:10The catalog number of a scheduled course. -
CurriculumFormatCode: string
Title:
FormatRead Only:trueMaximum Length:30A code indicating the format in which a scheduled course is delivered. 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 a scheduled course format code. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
CurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe unique identifier for a curriculum item such as scheduled course. -
CurriculumLongDescription: string
Title:
Long DescriptionRead Only:trueThe long description for a scheduled course. -
CurriculumName: string
Title:
NameRead Only:trueMaximum Length:50The name of a scheduled course. -
CurriculumTitle: string
Title:
TitleRead Only:trueMaximum Length:100The title of the scheduled course. -
EnrollmentCapacityQuantity: integer
(int32)
Title:
Enrollment CapacityRead Only:trueThe largest number of enrollments allowed for the course. -
EnrollmentEndDate: string
(date-time)
Title:
Enrollment DatesRead Only:trueThe date when the enrollment period for the scheduled course ends. -
EnrollmentStartDate: string
(date-time)
Title:
Enrollment DatesRead Only:trueThe date when the enrollment period for the scheduled course starts. -
EnrollmentStatusCode: string
Title:
Enrollment StatusRead Only:trueMaximum Length:30A code that indicates the enrollment status of a 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 code for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE. -
ExpiryMessage: string
Title:
Expiry MessageRead Only:trueA message indicating that a wish list item has expired. -
FacilityDescription: string
Title:
DescriptionRead Only:trueThe description of the facility associated with the scheduled course. -
FacilityRoomNumber: string
Title:
Room NumberRead Only:trueThe room identifier for scheduled course meeting. -
FacilityShortCode: string
Title:
FacilityRead Only:trueThe facility or building code for scheduled course meeting. -
FlatAmount: number
Title:
AmountRead Only:trueThe fee amount for a course. -
images: array
Images
Title:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program. -
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 primary instructor for a scheduled course. -
IsCartableFlag: boolean
Title:
Shopping Cart EnabledRead Only:trueIndicates whether a scheduled course is available for the shopping cart. When yes, the scheduled course can be added to a user's shopping cart. When no, the add to cart function is disabled. -
IsSelfPacedFlag: boolean
Title:
Self-PacedRead Only:trueIndicates whether a student can select the date on which they start a scheduled course. When yes, a user must provide a start date. When no, the scheduled course start date is used. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationControlCode: string
Title:
Location Control CodeRead Only:trueThe location control code for a scheduled course meeting. A list of accepted values is defined in the lookup type ORA_HER_LOCATION_CONTROL_CODE. -
LocationLatitude: string
Title:
LatitudeRead Only:trueThe GPS latitude coordinates for the scheduled course meeting location. -
LocationLongitude: string
Title:
LongitudeRead Only:trueThe GPS longitude coordinates for the scheduled course meeting location. -
LocationLongName: string
Title:
Location Long NameRead Only:trueThe name of the location for a 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:trueThe maximum number of credits available for a scheduled course. -
MeetingPatternDescription: string
Title:
Pattern NameRead Only:trueThe name or description of the scheduled course meeting pattern, such as Monday and Wednesdays. -
MeetingPatternEndDate: string
(date)
Title:
End DateRead Only:trueThe date when the meeting pattern of a scheduled course ends. -
MeetingPatternEndTime: string
(date-time)
Title:
End TimeRead Only:trueThe time when the meeting pattern of a 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 a scheduled course starts. -
MeetingPatternStartTime: string
(date-time)
Title:
Start TimeRead Only:trueThe time when the meeting pattern of a scheduled course starts. -
MinimumUnitsQuantity: number
Title:
Minimum UnitsRead Only:trueThe minimum number of credits available for a scheduled course. -
offeringOrganizationStaff: array
Offering Organization Staff
Title:
Offering Organization StaffThe offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program. -
OwningCurriculumId: integer
(int64)
Title:
Owning Curriculum IDRead Only:trueThe identifier of the parent course of this scheduled course. This scheduled course is a scheduled instance of the course identified by this value. -
OwningCurriculumName: string
Title:
NameRead Only:trueMaximum Length:50The name of the credential attached to the 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 Period NameRead 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 begins. -
ScheduledCourseCode: string
Title:
Scheduled Course CodeRead Only:trueMaximum Length:30A 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. -
TotalEnrolledQuantity: integer
(int32)
Title:
Total EnrolledRead Only:trueThe number that indicates the current enrollment total or seats taken for a 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 program resource and provides the image attachments associated with a program.
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 : Offering Organization Staff
Type:
arrayTitle:
Offering Organization StaffThe offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.
Show Source
Nested Schema : wishlists-wishlistItems-scheduledCourse-images-item-response
Type:
Show Source
object-
ImageContent: string
(byte)
Title:
Attachment ContentRead Only:trueThe content of a curriculum item attachment such as an image file. -
ImageContextCode: string
Title:
Curriculum Attachment ContextRead Only:trueMaximum Length:30The context or usage of a curriculum item attachment file. Valid values include ORA_MOBILE, ORA_STANDARD, or ORA_THUMB. A list of accepted values is defined in the lookup type ORA_HER_ATTACHMENT_CONTEXT. -
ImageId: integer
(int64)
Title:
Curriculum Attachment IDRead Only:trueThe unique identifier for an attachment associated with a curriculum item. -
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 : wishlists-wishlistItems-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. -
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. -
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. -
LocationLongName: string
Title:
Location Long NameRead Only:trueMaximum Length:100The name of the single use location associated with the meeting pattern of the scheduled course. -
MeetingName: string
Title:
Meeting NameRead Only:trueMaximum Length:50The name of the meeting pattern of the scheduled course. -
MeetingPatternLatitude: number
Title:
LatitudeRead Only:trueThe GPS latitude coordinates for the scheduled course meeting location. -
MeetingPatternLongitude: number
Title:
LongitudeRead Only:trueThe GPS longitude coordinates for the scheduled course meeting location. -
PatternDescription: string
Title:
Pattern NameRead Only:trueMaximum Length:50The name of the meeting pattern of the scheduled course. -
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. -
RecurrenceDayThursFlag: boolean
Title:
ThursdayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Thursday. -
RecurrenceDayTuesFlag: 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. -
ScheduleEndDate: string
(date)
Title:
End DateRead Only:trueThe date when the meeting pattern of the scheduled course ends. -
ScheduleEndTime: string
(date-time)
Title:
End TimeRead Only:trueThe time when the meeting pattern of the scheduled course ends. -
ScheduleSequenceNumber: integer
(int32)
Title:
Schedule Sequence NumberRead Only:trueThe sequence identifier of the meeting pattern of the scheduled course. -
ScheduleStartDate: string
(date)
Title:
Start DateRead Only:trueThe date when the meeting pattern of the scheduled course starts. -
ScheduleStartTime: string
(date-time)
Title:
Start TimeRead Only:trueThe time when the meeting pattern of the scheduled course starts.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : wishlists-wishlistItems-scheduledCourse-offeringOrganizationStaff-item-response
Type:
Show Source
object-
CurriculumStaffId: integer
(int64)
Title:
Curriculum Staff IDRead Only:trueThe generated primary key column for a curriculum staff record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersonAcademicTitle: string
Title:
Academic TitleRead Only:trueMaximum Length:30The academic title of the program staff person. -
PersonImageContent: string
(byte)
Title:
Staff ImageRead Only:trueThe content of a staff attachment such as an image file. -
PersonImageId: integer
(int64)
Title:
Attachment IDRead Only:trueA unique identifier for an attachment associated with a program. -
PersonName: string
Title:
NameRead Only:trueMaximum Length:450The name of a program staff person. -
PersonTitle: string
Title:
TitleRead Only:trueMaximum Length:60The title of the program staff person. -
StaffBiography: string
Title:
BiographyRead Only:trueThe text providing biographical or background information on a staff member. -
StaffPrimaryFlag: boolean
Title:
PrimaryRead Only:trueMaximum Length:1Identifies the primary staff member for a program. When yes, the staff row is considered the primary staff resource for the program. The default value is false. If only one record exists, the default value is true. -
StaffRoleTypeCode: string
Title:
Role TypeRead Only:trueMaximum Length:30The role type of the staff member associated with the course. An example is instructor. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
StaffRoleTypeMeaning: string
Title:
Role MeaningRead Only:trueMaximum Length:80The meaning of the role type of the staff member associated with the course. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
StaffSequenceNumber: integer
(int32)
Title:
Staff Sequence NumberRead Only:trueThe sequence number of a staff row associated with a program.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- images
-
Parameters:
- WishlistId:
$request.path.WishlistId - scheduledCourseUniqID:
$request.path.scheduledCourseUniqID - wishlistItemsUniqID:
$request.path.wishlistItemsUniqID
The images resource is a child of the program resource and provides the image attachments associated with a program. - WishlistId:
- meetingPatterns
-
Parameters:
- WishlistId:
$request.path.WishlistId - scheduledCourseUniqID:
$request.path.scheduledCourseUniqID - wishlistItemsUniqID:
$request.path.wishlistItemsUniqID
The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course. - WishlistId:
- offeringOrganizationStaff
-
Parameters:
- WishlistId:
$request.path.WishlistId - scheduledCourseUniqID:
$request.path.scheduledCourseUniqID - wishlistItemsUniqID:
$request.path.wishlistItemsUniqID
The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program. - WishlistId: