Create a scheduled course item

post

/fscmRestApi/resources/11.13.18.05/carts/{CartHeaderId}/child/scheduledCourseItems

Request

Path Parameters
  • 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=
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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 is a child of the student scheduled course resource and 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: object
Show Source
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: object
Show Source
Nested Schema : carts-scheduledCourseItems-courseRequisites-item-post-request
Type: object
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourseFees-item-post-request
Type: object
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-post-request
Type: object
Show Source
  • Title: Currency Code
    Maximum Length: 80
    Currency code for a discount applied to a course section.
  • Title: Currency Symbol
    Maximum Length: 80
    Currency symbol for a discount applied to a course section.
  • Title: Discount Amount
    Amount deducted from the original cost of a course section.
  • Title: Discount Name
    Maximum Length: 80
    Name of a discount applied to a course section.
Nested Schema : carts-scheduledCourseItems-scheduledCourses-item-post-request
Type: object
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 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: object
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourses-offeringOrganizationStaff-item-post-request
Type: object
Show Source
Nested Schema : carts-scheduledCourseItems-validationMessages-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : carts-scheduledCourseItems-item-response
Type: object
Show Source
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 is a child of the student scheduled course resource and 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: object
Show Source
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-response
Type: object
Show Source
Nested Schema : carts-scheduledCourseItems-courseRequisites-item-response
Type: object
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourseFees-item-response
Type: object
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: object
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourses-item-response
Type: object
Show Source
  • Title: Academic Level ID
    Read Only: true
    The unique identifier for an academic level value that's associated with a course.
  • Title: Academic Level Name
    Read Only: true
    Maximum Length: 100
    The name of an academic level, such as undergraduate, that's associated with a course.
  • Title: Academic Organization ID
    Read Only: true
    The unique identifier of the academic organization of the scheduled course.
  • Title: Subject Code
    Read Only: true
    Maximum Length: 30
    The code for the scheduled course's academic subject.
  • Title: Academic Subject ID
    Read Only: true
    The unique identifier for the course's academic subject.
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The name of the subject of the scheduled course.
  • Title: Name
    Read Only: true
    The name of the building associated with the meeting pattern of the scheduled course.
  • Title: Code
    Read Only: true
    The unique identifier of the building associated with the meeting pattern of the scheduled course.
  • Title: Campus
    Read Only: true
    The unique identifier for the campus where a course is offered.
  • Title: Campus
    Read Only: true
    Maximum Length: 50
    The campus where the scheduled course is offered.
  • 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.
  • 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.
  • 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.
  • Title: Scheduled Course Credential ID
    Read Only: true
    The unique identifier of the credential associated with the course.
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The name of the credential associated with the scheduled course.
  • 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.
  • 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.
  • 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.
  • Title: Catalog Number
    Read Only: true
    Maximum Length: 10
    The catalog number of the scheduled course.
  • 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.
  • 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.
  • Title: Curriculum Header ID
    Read Only: true
    The unique identifier for a curriculum header record.
  • Title: Curriculum ID
    Read Only: true
    The generated unique identifier of a scheduled course.
  • Title: Long Description
    Read Only: true
    The description of the scheduled course.
  • Title: Name
    Read Only: true
    Maximum Length: 150
    The name of the scheduled course.
  • Title: Title
    Read Only: true
    Maximum Length: 100
    The title of the scheduled course.
  • 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.
  • Title: Enrollment Capacity
    Read Only: true
    A numeric value indicating the enrollment capacity of the scheduled course.
  • Title: Enrollment Status
    Read Only: true
    Maximum Length: 30
    Default Value: ORA_OPN
    The 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.
  • Title: Enrollment Status Meaning
    Read Only: true
    Maximum Length: 80
    The 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.
  • Title: Description
    Read Only: true
    The description of the facility associated with the scheduled course.
  • Title: Room Number
    Read Only: true
    The room number associated with the meeting pattern of the scheduled course.
  • Title: Facility
    Read Only: true
    The identifier of the facility associated with the meeting pattern of the scheduled course.
  • Title: Flat Amount
    Read Only: true
    The numeric value of the flat amount charge of a scheduled course.
  • Title: Currency Code
    Read Only: true
    The unique identifier of the flat amount charge of a scheduled course.
  • Title: Currency Symbol
    Read Only: true
    The denomination of the flat amount charge of a scheduled course.
  • Title: Institution ID
    Read Only: true
    The unique identifier for the institution where the scheduled course is offered.
  • Title: Institution
    Read Only: true
    Maximum Length: 50
    The name of the institution where the scheduled course is offered.
  • Title: Name
    Read Only: true
    The name of the instructor of the scheduled course.
  • Title: Shopping Cart Enabled
    Read Only: true
    Indicates whether the scheduled course can be added to the shopping cart. The default value is true.
  • Title: Scheduler Enabled
    Read Only: true
    Indicates whether the scheduled course can be added to the scheduler. The default value is true.
  • Title: Self-Paced
    Read Only: true
    Indicates whether the scheduled course is self-paced. The default value is false.
  • 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
  • Title: Location Control Code
    Read Only: true
    The unique identifier of the single use location associated with the meeting pattern of the scheduled course.
  • Title: Latitude
    Read Only: true
    The GPS latitude coordinates for the scheduled course meeting location.
  • Title: Longitude
    Read Only: true
    The GPS longitude coordinates for the scheduled course meeting location.
  • Title: Location Long Name
    Read Only: true
    The name of the single use location associated with the meeting pattern of the scheduled course.
  • Title: Map Integration URL
    Read Only: true
    The uniform resource locator of the map application to be used for displaying scheduled course meeting location.
  • Title: Maximum Units
    Read Only: true
    A numeric value indicating the maximum units of the scheduled course.
  • Title: Pattern Name
    Read Only: true
    The name of the meeting pattern of the scheduled course.
  • Title: End Date
    Read Only: true
    The date when the meeting pattern of the scheduled course ends.
  • Title: End Time
    Read Only: true
    The time when the meeting pattern of the scheduled course ends.
  • 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.
  • Title: Start Date
    Read Only: true
    The date when the meeting pattern of the scheduled course starts.
  • Title: Start Time
    Read Only: true
    The time when the meeting pattern of the scheduled course starts.
  • Title: Minimum Units
    Read Only: true
    A numeric value indicating the minimum units of the scheduled course.
  • 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.
  • Title: Owning Curriculum ID
    Read Only: true
    The unique identifier for the parent curriculum item of the scheduled course.
  • Title: Name
    Read Only: true
    Maximum Length: 150
    The name for the parent curriculum item of the scheduled course.
  • Title: Owning Offer Number
    Read Only: true
    The unique identifier for the parent curriculum item offer number of the scheduled course.
  • Title: Reporting Period End Date
    Read Only: true
    The date when the reporting period associated with the scheduled course ends.
  • Title: Reporting Period ID
    Read Only: true
    The unique identifier for the reporting period associated with the scheduled course.
  • Title: Reporting Period
    Read Only: true
    Maximum Length: 50
    The name of the reporting period associated with the scheduled course.
  • Title: Reporting Period Start Date
    Read Only: true
    The date when the reporting period associated with the scheduled course starts.
  • 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.
  • Title: End Date
    Read Only: true
    The date when the scheduled course ends.
  • Title: Scheduled Course Number
    Read Only: true
    A generated unique key for a scheduled course.
  • Title: Start Date
    Read Only: true
    The date when the scheduled course starts.
  • 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.
  • Title: Total Enrolled
    Read Only: true
    A numeric value indicating the number of enrollments in the scheduled course.
  • Title: URL Address
    Read Only: true
    The unique URL address of the scheduled course.
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-response
Type: object
Show Source
Nested Schema : carts-scheduledCourseItems-scheduledCourses-offeringOrganizationStaff-item-response
Type: object
Show Source
  • Title: Curriculum Staff ID
    Read Only: true
    The generated primary key column for a curriculum staff record.
  • Links
  • Title: Academic Title
    Read Only: true
    Maximum Length: 30
    The academic title of the program staff person.
  • Title: Staff Image
    Read Only: true
    The content of a staff attachment such as an image file.
  • Title: Attachment ID
    Read Only: true
    A unique identifier for an attachment associated with a program.
  • Title: Name
    Read Only: true
    Maximum Length: 450
    The name of a program staff person.
  • Title: Title
    Read Only: true
    Maximum Length: 60
    The title of the program staff person.
  • Title: Biography
    Read Only: true
    The text providing biographical or background information on a staff member.
  • Title: Primary
    Read Only: true
    Maximum Length: 1
    Identifies 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.
  • 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.
  • 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.
  • Title: Staff Sequence Number
    Read Only: true
    The sequence number of a staff row associated with a program.
Nested Schema : carts-scheduledCourseItems-validationMessages-item-response
Type: object
Show Source
Back to Top