Create a scheduled course item
post
/fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems
Request
Path Parameters
-
CartHeaderId(required): integer(int64)
The unique identifier of the shopping cart header.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
courseFees: array
Course Fees
Title:
Course Fees
The course fees resource provides a list of fees associated with a course. -
courseRequisites: array
Course Requisites
Title:
Course Requisites
The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course. -
CurriculumId(required): integer
(int64)
Title:
Curriculum ID
The unique identifier of a scheduled course. -
CurriculumOptionId: integer
(int64)
Title:
Curriculum Option ID
The unique identifier for the enrollment transaction selections made by the student for this shopping cart item. -
EnrolledCredits: number
Title:
Units
The enrolled units for which a student can earn credit. -
GradingOptionCode: string
Title:
Grading Option Code
Maximum Length:255
The code for the grading option of a scheduled course. -
OverallPrerequisiteStatus: string
Title:
Overall Prerequisite Status
The status of overall prerequisite. -
scheduledCourseFees: array
Scheduled Course Fees
Title:
Scheduled Course Fees
The scheduled course fees resource provides a list of fees associated with a scheduled course. -
scheduledCourses: array
Scheduled Courses
Title:
Scheduled Courses
The scheduled courses resource provides a list of scheduled courses offered by institutions. -
SelfPacedClassStartDate: string
(date)
Title:
Self-Paced Start Date
The start date of self paced classes. -
validationMessages: array
Validation Messages
Title:
Validation Messages
The validation messages resource provides a list of validation messages associated with a cart.
Nested Schema : Course Fees
Type:
array
Title:
Course Fees
The course fees resource provides a list of fees associated with a course.
Show Source
Nested Schema : Course Requisites
Type:
array
Title:
Course Requisites
The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course.
Show Source
Nested Schema : Scheduled Course Fees
Type:
array
Title:
Scheduled Course Fees
The scheduled course fees resource provides a list of fees associated with a scheduled course.
Show Source
Nested Schema : Scheduled Courses
Type:
array
Title:
Scheduled Courses
The scheduled courses resource provides a list of scheduled courses offered by institutions.
Show Source
Nested Schema : Validation Messages
Type:
array
Title:
Validation Messages
The validation messages resource provides a list of validation messages associated with a cart.
Show Source
Nested Schema : carts-scheduledCourseItems-courseFees-item-post-request
Type:
Show Source
object
-
courseDiscounts: array
Course Discounts
Title:
Course Discounts
The course discounts resource provides a list of discounts associated with a course.
Nested Schema : Course Discounts
Type:
array
Title:
Course Discounts
The course discounts resource provides a list of discounts associated with a course.
Show Source
Nested Schema : carts-scheduledCourseItems-courseFees-courseDiscounts-item-post-request
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:80
Currency code for a discount applied to a course. -
CurrencySymbol: string
Title:
Currency Symbol
Maximum Length:80
Currency symbol for a discount applied to a course. -
DiscountAmount: number
Title:
Discount Amount
Amount deducted from the original cost of a course. -
DiscountName: string
Title:
Discount Name
Maximum Length:80
Name of a discount applied to a course.
Nested Schema : carts-scheduledCourseItems-courseRequisites-item-post-request
Type:
Show Source
object
-
PrerequisiteStatusCode: string
Title:
Prerequisite Status Code
The code of the status of the requisite associated with the course. -
PrerequisiteStatusMeaning: string
Title:
Prerequisite Status Meaning
The meaning of the status of the requisite associated with the course.
Nested Schema : carts-scheduledCourseItems-scheduledCourseFees-item-post-request
Type:
Show Source
object
-
scheduledCourseDiscounts: array
Scheduled Course Discounts
Title:
Scheduled Course Discounts
The scheduled course discounts resource provides a list of discounts associated with a scheduled course.
Nested Schema : Scheduled Course Discounts
Type:
array
Title:
Scheduled Course Discounts
The scheduled course discounts resource provides a list of discounts associated with a scheduled course.
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourseFees-scheduledCourseDiscounts-item-post-request
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:80
Currency code for a discount applied to a course section. -
CurrencySymbol: string
Title:
Currency Symbol
Maximum Length:80
Currency symbol for a discount applied to a course section. -
DiscountAmount: number
Title:
Discount Amount
Amount deducted from the original cost of a course section. -
DiscountName: string
Title:
Discount Name
Maximum Length:80
Name of a discount applied to a course section.
Nested Schema : carts-scheduledCourseItems-scheduledCourses-item-post-request
Type:
Show Source
object
-
meetingPatterns: array
Meeting Patterns
Title:
Meeting Patterns
The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course. -
offeringOrganizationStaff: array
Offering Organization Staff
Title:
Offering Organization Staff
The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.
Nested Schema : Meeting Patterns
Type:
array
Title:
Meeting Patterns
The 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:
array
Title:
Offering Organization Staff
The 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 : carts-scheduledCourseItems-scheduledCourses-meetingPatterns-item-post-request
Type:
Show Source
object
Nested Schema : carts-scheduledCourseItems-scheduledCourses-offeringOrganizationStaff-item-post-request
Type:
Show Source
object
Nested Schema : carts-scheduledCourseItems-validationMessages-item-post-request
Type:
Show Source
object
-
MessageId: integer
(int64)
Title:
Cart Message ID
The unique identifier for the validation message.
Response
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 : carts-scheduledCourseItems-item-response
Type:
Show Source
object
-
AcademicSubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The code for the academic subject of the scheduled course. -
CartDetailId: integer
(int64)
Title:
Scheduled Course Cart ID
Read Only:true
The unique identifier of the cart detail of the scheduled course. -
CartDetailStatus: string
Title:
Detail Status
Read Only:true
Maximum Length:30
The status of the cart detail of the scheduled course. -
courseFees: array
Course Fees
Title:
Course Fees
The course fees resource provides a list of fees associated with a course. -
courseRequisites: array
Course Requisites
Title:
Course Requisites
The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the scheduled course item. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the scheduled course item was created. -
CreditTypeMeaning: string
Title:
Type of Credit Meaning
Read Only:true
Maximum Length:80
The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
The currency code associated with a scheduled course fee. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The currency symbol associated with a scheduled course fee. -
CurriculumCatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The code for the scheduled course. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
The unique identifier of a scheduled course. -
CurriculumOptionId: integer
(int64)
Title:
Curriculum Option ID
The unique identifier for the enrollment transaction selections made by the student for this shopping cart item. -
EnrolledCredits: number
Title:
Units
The enrolled units for which a student can earn credit. -
GradingOptionCode: string
Title:
Grading Option Code
Maximum Length:255
The code for the grading option of a scheduled course. -
GradingOptionName: string
Title:
Grading Option Name
Read Only:true
The name for the grading option of a scheduled course. -
IsSponsoredFlag: boolean
Read Only:
true
Indicates whether the scheduled course is sponsored. The default value is false. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the scheduled course item was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the scheduled course item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumUnitsQuantity: number
Title:
Minimum Units
Read Only:true
A numeric value indicating the minimum units of the scheduled course. -
OverallPrerequisiteStatus: string
Title:
Overall Prerequisite Status
The status of overall prerequisite. -
OwningCurriculumId: integer
(int64)
Title:
Owning Course Curriculum ID
Read Only:true
The name of the parent curriculum item. -
OwningCurriculumName: string
Title:
Owning Name
Read Only:true
Maximum Length:50
The unique identifier of the parent curriculum item. -
ProgramPrepaidFlag: boolean
Read Only:
true
Indicates whether the program associated with scheduled course is prepaid. The default value is false. -
RequisiteInformation: string
Title:
Requisite Description
Read Only:true
The detailed description for the requisite. -
ScheduledCourseCode: string
Title:
Scheduled Course Code
Read Only:true
Maximum Length:30
The code used to identify a scheduled course within a given course and academic period. -
scheduledCourseFees: array
Scheduled Course Fees
Title:
Scheduled Course Fees
The scheduled course fees resource provides a list of fees associated with a scheduled course. -
scheduledCourses: array
Scheduled Courses
Title:
Scheduled Courses
The scheduled courses resource provides a list of scheduled courses offered by institutions. -
SelfPacedCalculatedClassEndDate: string
(date)
Title:
Self-Paced End Date
Read Only:true
The end date of self paced classes. -
SelfPacedClassStartDate: string
(date)
Title:
Self-Paced Start Date
The start date of self paced classes. -
TotalAmount: number
Title:
Total Amount
Read Only:true
The numeric value of the total amount charge of a scheduled course item. -
TotalDiscountAmount: number
Title:
Total Discount Amount
Read Only:true
The numeric value of the total discount amount given for a scheduled course item. -
validationMessages: array
Validation Messages
Title:
Validation Messages
The validation messages resource provides a list of validation messages associated with a cart.
Nested Schema : Course Fees
Type:
array
Title:
Course Fees
The course fees resource provides a list of fees associated with a course.
Show Source
Nested Schema : Course Requisites
Type:
array
Title:
Course Requisites
The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Scheduled Course Fees
Type:
array
Title:
Scheduled Course Fees
The scheduled course fees resource provides a list of fees associated with a scheduled course.
Show Source
Nested Schema : Scheduled Courses
Type:
array
Title:
Scheduled Courses
The scheduled courses resource provides a list of scheduled courses offered by institutions.
Show Source
Nested Schema : Validation Messages
Type:
array
Title:
Validation Messages
The validation messages resource provides a list of validation messages associated with a cart.
Show Source
Nested Schema : carts-scheduledCourseItems-courseFees-item-response
Type:
Show Source
object
-
courseDiscounts: array
Course Discounts
Title:
Course Discounts
The course discounts resource provides a list of discounts associated with a course. -
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
The unique identifier of the flat amount charge of a course. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The denomination of the flat amount charge of a course. -
DiscountAmount: number
Title:
Discount Amount
Read Only:true
The numeric value of the discount amount given for a course. -
FeeAttributeId: integer
(int64)
Title:
Fee Attribute ID
Read Only:true
The unique identifier of the fee attribute of the course. -
FeeAttributeTransactionDescription: string
Title:
Fee Attribute Transaction Description
Read Only:true
Maximum Length:100
The description of the fee attribute of the course. -
FeeId: integer
(int64)
Title:
Fee ID
Read Only:true
The unique identifier of the fee of the course. -
FeeTypeCode: string
Title:
Fee Type Code
Read Only:true
Maximum Length:30
The code of the fee type of the course. -
FeeTypeId: integer
(int64)
Read Only:
true
The unique identifier of the fee type of the course. -
FlatAmount: number
Title:
Amount
Read Only:true
The numeric value of the flat amount charge of a course. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Course Discounts
Type:
array
Title:
Course Discounts
The course discounts resource provides a list of discounts associated with a course.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carts-scheduledCourseItems-courseFees-courseDiscounts-item-response
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:80
Currency code for a discount applied to a course. -
CurrencySymbol: string
Title:
Currency Symbol
Maximum Length:80
Currency symbol for a discount applied to a course. -
DiscountAmount: number
Title:
Discount Amount
Amount deducted from the original cost of a course. -
DiscountName: string
Title:
Discount Name
Maximum Length:80
Name of a discount applied to a course. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 : carts-scheduledCourseItems-courseRequisites-item-response
Type:
Show Source
object
-
CourseCurriculumId: integer
(int64)
Title:
Course Curriculum ID
Read Only:true
The unique identifier for a requisite curriculum item. -
CurriculumType: string
Title:
Curriculum Item Type
Read Only:true
Maximum Length:30
The code of the curriculum type of the requisite associated with the course. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrerequisiteStatusCode: string
Title:
Prerequisite Status Code
The code of the status of the requisite associated with the course. -
PrerequisiteStatusMeaning: string
Title:
Prerequisite Status Meaning
The meaning of the status of the requisite associated with the course. -
RequisiteCurriculumId: integer
(int64)
Title:
Requisite Curriculum ID
Read Only:true
The unique identifier for the curriculum requisite. -
RequisiteCurriculumName: string
Title:
Requisite Curriculum Name
Read Only:true
The name of a requisite curriculum item. -
RequisiteTypeCode: string
Title:
Requisite Type Code
Read Only:true
Maximum Length:30
A code that indicates the type of requisite. Valid values include ORA_CO or ORA_PRE. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourseFees-item-response
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency Code
Read Only:true
Maximum Length:15
The unique identifier of the flat amount charge of a scheduled course. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The denomination of the flat amount charge of a scheduled course. -
DiscountAmount: number
Read Only:
true
The numeric value of the discount amount given for a scheduled course. -
FeeAttributeId: integer
(int64)
Read Only:
true
The unique identifier of the fee attribute of the scheduled course. -
FeeAttributeTransactionDescription: string
Read Only:
true
Maximum Length:100
The description of the fee attribute of the scheduled course. -
FeeId: integer
(int64)
Title:
Fee ID
Read Only:true
The unique identifier of the fee of the scheduled course. -
FeeTypeCode: string
Title:
Fee Type Code
Read Only:true
Maximum Length:30
The code of the fee type of the scheduled course. -
FeeTypeId: integer
(int64)
Read Only:
true
The unique identifier of the fee type of the scheduled course. -
FlatAmount: number
Title:
Amount
Read Only:true
The numeric value of the flat amount charge of a scheduled course. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
scheduledCourseDiscounts: array
Scheduled Course Discounts
Title:
Scheduled Course Discounts
The scheduled course discounts resource provides a list of discounts associated with a scheduled course.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Scheduled Course Discounts
Type:
array
Title:
Scheduled Course Discounts
The scheduled course discounts resource provides a list of discounts associated with a scheduled course.
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourseFees-scheduledCourseDiscounts-item-response
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:80
Currency code for a discount applied to a course section. -
CurrencySymbol: string
Title:
Currency Symbol
Maximum Length:80
Currency symbol for a discount applied to a course section. -
DiscountAmount: number
Title:
Discount Amount
Amount deducted from the original cost of a course section. -
DiscountName: string
Title:
Discount Name
Maximum Length:80
Name of a discount applied to a course section. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourses-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Read Only:true
The unique identifier for an academic level that is associated with a course. -
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of an academic level, such as undergraduate, that is associated with a course. -
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
Read Only:true
The unique identifier of the academic organization of the scheduled course. -
AcademicSubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The code for the scheduled course's academic subject. -
AcademicSubjectId: integer
(int64)
Title:
Academic Subject ID
Read Only:true
The unique identifier for the course's academic subject. -
AcademicSubjectName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the subject of the scheduled course. -
BuildingName: string
Title:
Name
Read Only:true
The name of the building associated with the meeting pattern of the scheduled course. -
BuildingShortCode: string
Title:
Code
Read Only:true
The unique identifier of the building associated with the meeting pattern of the scheduled course. -
CampusId: integer
(int64)
Title:
Campus
Read Only:true
The unique identifier for the campus where a course is offered. -
CampusName: string
Title:
Campus
Read Only:true
Maximum Length:50
The campus where the scheduled course is offered. -
ConsentTypeCode: string
Title:
Permission Type
Read Only:true
Maximum Length:30
Default Value:ORA_NOT_REQUIRED
The 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 Meaning
Read Only:true
Maximum Length:80
The 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 enroll
Read Only:true
Maximum Length:1
Default Value:false
Indicates 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 ID
Read Only:true
The unique identifier of the credential associated with the course. -
CredentialName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the credential associated with the scheduled course. -
CredentialTypeCode: string
Title:
Credential Type
Read Only:true
Maximum Length:30
The 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 Credit
Read Only:true
Maximum Length:30
The 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 Meaning
Read Only:true
Maximum Length:80
The 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 Number
Read Only:true
Maximum Length:10
The catalog number of the scheduled course. -
CurriculumFormatCode: string
Title:
Format
Read Only:true
Maximum Length:30
The 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 Meaning
Read Only:true
Maximum Length:80
The 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 ID
Read Only:true
The unique identifier for a curriculum header record. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The generated unique identifier of a scheduled course. -
CurriculumLongDescription: string
Title:
Long Description
Read Only:true
The description of the scheduled course. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:150
The name of the scheduled course. -
CurriculumTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The title of the scheduled course. -
EnrollConsentRequiredFlag: boolean
Title:
Permission required to enroll
Read Only:true
Maximum Length:1
Default Value:false
Indicates 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 Capacity
Read Only:true
A numeric value indicating the enrollment capacity of the scheduled course. -
EnrollmentStatusCode: string
Title:
Enrollment Status
Read Only:true
Maximum Length:30
Default Value:ORA_OPN
The unique identifier of the enrollment status of the scheduled course. -
EnrollmentStatusMeaning: string
Title:
Enrollment Status Meaning
Read Only:true
Maximum Length:80
The name of the enrollment status meaning of the scheduled course. -
FacilityDescription: string
Title:
Description
Read Only:true
The description of the facility associated with the scheduled course. -
FacilityRoomNumber: string
Title:
Room Number
Read Only:true
The room number associated with the meeting pattern of the scheduled course. -
FacilityShortCode: string
Title:
Facility
Read Only:true
The identifier of the facility associated with the meeting pattern of the scheduled course. -
FlatAmount: number
Title:
Flat Amount
Read Only:true
The numeric value of the flat amount charge of a scheduled course. -
FlatAmountCurrencyCode: string
Title:
Currency Code
Read Only:true
The unique identifier of the flat amount charge of a scheduled course. -
FlatAmountCurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The denomination of the flat amount charge of a scheduled course. -
InstitutionId: integer
(int64)
Title:
Institution ID
Read Only:true
The unique identifier for the institution where the scheduled course is offered. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The name of the institution where the scheduled course is offered. -
InstructorName: string
Title:
Name
Read Only:true
The name of the instructor of the scheduled course. -
IsCartableFlag: boolean
Title:
Shopping Cart Enabled
Read Only:true
Indicates whether the scheduled course can be added to the shopping cart. The default value is true. -
IsSchedulableFlag: boolean
Title:
Scheduler Enabled
Read Only:true
Indicates whether the scheduled course can be added to the scheduler. The default value is true. -
IsSelfPacedFlag: boolean
Title:
Self-Paced
Read Only:true
Indicates whether the scheduled course is self-paced. The default value is false. -
IsWishableFlag: boolean
Title:
Wish List Enabled
Read Only:true
Indicates whether the scheduled course can be added to the wish list. The default value is true. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationControlCode: string
Title:
Location Control Code
Read Only:true
The 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: number
Title:
Latitude
Read Only:true
The GPS latitude coordinates for the scheduled course meeting location. -
LocationLongitude: number
Title:
Longitude
Read Only:true
The GPS longitude coordinates for the scheduled course meeting location. -
LocationLongName: string
Title:
Location Long Name
Read Only:true
The long name of the location associated with the meeting pattern of the scheduled course. -
MapIntegrationURL: string
Title:
Map Integration URL
Read Only:true
The uniform resource locator of the map application to be used for displaying scheduled course meeting location. -
MaximumUnitsQuantity: number
Title:
Maximum Units
Read Only:true
A numeric value indicating the maximum units of the scheduled course. -
MeetingPatternDescription: string
Title:
Pattern Name
Read Only:true
The name of the meeting pattern of the scheduled course. -
MeetingPatternEndDate: string
(date)
Title:
End Date
Read Only:true
The date when the meeting pattern of the scheduled course ends. -
MeetingPatternEndTime: string
(date-time)
Title:
End Time
Read Only:true
The time when the meeting pattern of the scheduled course ends. -
meetingPatterns: array
Meeting Patterns
Title:
Meeting Patterns
The 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 Date
Read Only:true
The date when the meeting pattern of the scheduled course starts. -
MeetingPatternStartTime: string
(date-time)
Title:
Start Time
Read Only:true
The time when the meeting pattern of the scheduled course starts. -
MinimumUnitsQuantity: number
Title:
Minimum Units
Read Only:true
A numeric value indicating the minimum units of the scheduled course. -
offeringOrganizationStaff: array
Offering Organization Staff
Title:
Offering Organization Staff
The offering organization staff resource is a child of the scheduled courses resource and provides a list of staff associated with a scheduled course. -
OwningCurriculumId: integer
(int64)
Title:
Owning Curriculum ID
Read Only:true
The unique identifier for the parent curriculum item of the scheduled course. -
OwningCurriculumName: string
Title:
Name
Read Only:true
Maximum Length:150
The name for the parent curriculum item of the scheduled course. -
OwningOfferNumber: integer
(int32)
Title:
Owning Offer Number
Read Only:true
The unique identifier for the parent curriculum item offer number of the scheduled course. -
ReportingPeriodEndDate: string
(date)
Title:
Reporting Period End Date
Read Only:true
The date when the reporting period associated with the scheduled course ends. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period ID
Read Only:true
The unique identifier for the reporting period associated with the scheduled course. -
ReportingPeriodName: string
Title:
Reporting Period
Read Only:true
Maximum Length:50
The name of the reporting period associated with the scheduled course. -
ReportingPeriodStartDate: string
(date)
Title:
Reporting Period Start Date
Read Only:true
The date when the reporting period associated with the scheduled course begins. -
ScheduledCourseCode: string
Title:
Scheduled Course Code
Read Only:true
Maximum Length:30
The code used to identify a scheduled course within a given course and academic period. -
ScheduledCourseEndDate: string
(date-time)
Title:
End Date
Read Only:true
The date when the scheduled course ends. -
ScheduledCourseNumber: integer
(int32)
Title:
Scheduled Course Number
Read Only:true
A generated unique key for a scheduled course. -
ScheduledCourseStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The date when the scheduled course starts. -
StudentRequestConsentFlag: boolean
Title:
Allow permission request
Read Only:true
Maximum Length:1
Default Value:false
Indicates 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 Enrolled
Read Only:true
A numeric value indicating the number of enrollments in the scheduled course. -
URLAddress: string
Title:
URL Address
Read Only:true
The unique URL address of the scheduled course.
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 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:
array
Title:
Offering Organization Staff
The offering organization staff resource is a child of the scheduled courses resource and provides a list of staff associated with a scheduled course.
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourses-meetingPatterns-item-response
Type:
Show Source
object
-
BuildingName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the building associated with the meeting pattern of the scheduled course. -
BuildingShortCode: string
Title:
Code
Read Only:true
Maximum Length:6
The unique identifier of the building associated with the meeting pattern of the scheduled course. -
CurriculumScheduleId: integer
(int64)
Read Only:
true
The generated primary key column for a meeting pattern of the scheduled course. -
DurationQuantity: integer
(int32)
Title:
Duration
Read Only:true
The numeric value that indicates the length of a meeting of the scheduled course. -
FacilityDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the meeting pattern of the scheduled course. -
FacilityRoomNumber: string
Title:
Room Number
Read Only:true
Maximum Length:10
The room number associated with the meeting pattern of the scheduled course. -
FacilityShortCode: string
Title:
Facility
Read Only:true
Maximum Length:20
The identifier of the facility associated with the meeting pattern of the scheduled course. -
InstructionalMethodCode: string
Read Only:
true
Maximum Length:30
The instructional method code of the meeting. -
InstructionalMethodMeaning: string
Read Only:
true
Maximum Length:80
The instructional method meaning of the meeting. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationControlCode: string
Title:
Location Control Code
Read Only:true
Maximum Length:30
Default Value:ORA_USE_FACILITY
The unique identifier of the single use location associated with the meeting pattern of the scheduled course. -
LocationLatitude: number
Title:
Latitude
Read Only:true
The GPS latitude coordinates for the scheduled course meeting location. -
LocationLongitude: number
Title:
Longitude
Read Only:true
The GPS longitude coordinates for the scheduled course meeting location. -
LocationLongName: string
Title:
Location Long Name
Read Only:true
The name of the single use location associated with the meeting pattern of the scheduled course. -
MeetingPatternDescription: string
Title:
Pattern Name
Read Only:true
Maximum Length:50
The name of the meeting pattern of the scheduled course. -
MeetingPatternEndDate: string
(date)
Title:
End Date
Read Only:true
The date when the meeting pattern of the scheduled course ends. -
MeetingPatternEndTime: string
(date-time)
Title:
End Time
Read Only:true
The time when the meeting pattern of the scheduled course ends. -
MeetingPatternName: string
Title:
Meeting Name
Read Only:true
Maximum Length:50
The meeting name of the course scheduled in the facility. -
MeetingPatternStartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the meeting pattern of the scheduled course starts. -
MeetingPatternStartTime: string
(date-time)
Title:
Start Time
Read Only:true
The time when the meeting pattern of the scheduled course starts. -
RecurrenceDayFriFlag: boolean
Title:
Friday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Friday. -
RecurrenceDayMonFlag: boolean
Title:
Monday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Monday. -
RecurrenceDaySatFlag: boolean
Title:
Saturday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Saturday. -
RecurrenceDaySunFlag: boolean
Title:
Sunday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Sunday. -
RecurrenceDayThuFlag: boolean
Title:
Thursday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Thursday. -
RecurrenceDayTueFlag: boolean
Title:
Tuesday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Tuesday. -
RecurrenceDayWedFlag: boolean
Title:
Wednesday
Read Only:true
Maximum Length:1
Default Value:false
The unique identifier for the day of the week Wednesday. -
ScheduleSequenceNumber: integer
(int32)
Title:
Schedule Sequence Number
Read Only:true
The sequence identifier of the meeting pattern of the scheduled course.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourses-offeringOrganizationStaff-item-response
Type:
Show Source
object
-
CurriculumStaffId: integer
(int64)
Title:
Curriculum Staff ID
Read Only:true
The generated primary key column for a curriculum staff record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonAcademicTitle: string
Title:
Academic Title
Read Only:true
Maximum Length:30
The academic title of the staff member associated with the course. -
PersonImageContent: string
(byte)
Title:
Staff Image
Read Only:true
The content of a staff attachment such as an image file. -
PersonImageId: integer
(int64)
Title:
Attachment ID
Read Only:true
The unique identifier for an attachment associated with a staff member's record. -
PersonName: string
Title:
Name
Read Only:true
Maximum Length:450
The name of the staff member associated with the course. -
PersonTitle: string
Title:
Title
Read Only:true
Maximum Length:60
The title of the staff member associated with the course. -
StaffBiography: string
Title:
Biography
Read Only:true
An attachment containing biographical information about the staff member associated with the course. -
StaffPrimaryFlag: boolean
Title:
Primary
Read Only:true
Maximum Length:1
Indicates the primary staff member of the course. The default value is false. If only one record exists, the default value is true. -
StaffRoleTypeCode: string
Title:
Role Type
Read Only:true
Maximum Length:30
The 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 Meaning
Read Only:true
Maximum Length:80
The 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 Number
Read Only:true
The sequence identifier of the staff assignment of the course.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carts-scheduledCourseItems-validationMessages-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageId: integer
(int64)
Title:
Cart Message ID
The unique identifier for the validation message. -
ValidationCode: string
Title:
Cart Validation Code
Read Only:true
Maximum Length:30
The code for the validation message. -
ValidationDescription: string
Title:
Cart Validation Message
Read Only:true
The description for the validation message. -
ValidationSeverity: string
Title:
Cart Validation Severity
Read Only:true
The severity for the validation message.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- courseFees
-
Parameters:
- CartHeaderId:
$request.path.CartHeaderId
- scheduledCourseItemsUniqID:
$request.path.scheduledCourseItemsUniqID
The course fees resource provides a list of fees associated with a course. - CartHeaderId:
- courseRequisites
-
Parameters:
- CartHeaderId:
$request.path.CartHeaderId
- scheduledCourseItemsUniqID:
$request.path.scheduledCourseItemsUniqID
The course requisites resource is a child of the courses resource and provides a list of requisites associated with a course. - CartHeaderId:
- scheduledCourseFees
-
Parameters:
- CartHeaderId:
$request.path.CartHeaderId
- scheduledCourseItemsUniqID:
$request.path.scheduledCourseItemsUniqID
The scheduled course fees resource provides a list of fees associated with a scheduled course. - CartHeaderId:
- scheduledCourses
-
Parameters:
- CartHeaderId:
$request.path.CartHeaderId
- scheduledCourseItemsUniqID:
$request.path.scheduledCourseItemsUniqID
The scheduled courses resource provides a list of scheduled courses offered by institutions. - CartHeaderId:
- validationMessages
-
Parameters:
- CartHeaderId:
$request.path.CartHeaderId
- scheduledCourseItemsUniqID:
$request.path.scheduledCourseItemsUniqID
The validation messages resource provides a list of validation messages associated with a cart. - CartHeaderId: