Get all scheduled course items

get

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

Request

Path Parameters
Query Parameters
  • 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>
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds all scheduled course items that match the primary key criteria specified.
      Finder Variables:
      • CartDetailId; integer; Unique identifier for the scheduled course item.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AcademicSubjectCode; string; The code for the scheduled course's academic subject.
    • CartDetailId; integer; The unique identifier for the shopping cart scheduled course.
    • CartDetailStatus; string; The status of an individual shopping cart or student scheduler row.
    • CreatedBy; string; The user who created the row for the student scheduler.
    • CreationDate; string; The date and time when the student scheduler row was created.
    • CreditTypeMeaning; string; 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; The catalog number of the scheduled course.
    • CurriculumId; integer; The unique identifier for the scheduled course item.
    • CurriculumOptionId; integer; The unique identifier for the curriculum item option.
    • EnrolledCredits; number; The enrolled credit quantity calculated during enrollment.
    • GradingOptionCode; string; The code of the student's grading option selection.
    • GradingOptionName; string; The name of the student's grading option selection.
    • LastUpdateDate; string; The date and time when the student scheduler row was last updated.
    • LastUpdatedBy; string; The user who last updated the row for the student scheduler.
    • MinimumUnitsQuantity; number; A numeric value indicating the minimum units of the scheduled course.
    • OverallPrerequisiteStatus; string; A status that describes whether a student has satisfied all of the prerequisites for a course.
    • OwningCurriculumId; integer; The unique identifier for the parent curriculum item of the scheduled course.
    • OwningCurriculumName; string; The name for the parent curriculum item of the scheduled course.
    • RequisiteInformation; string; The requisite description of the scheduled course item.
    • ScheduledCourseCode; string; The code used to identify a scheduled course within a given course and academic period.
    • SelfPacedCalculatedClassEndDate; string; The self paced course end date calculated during enrollment.
    • SelfPacedClassStartDate; string; The self paced course start date.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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 : studentSchedulers-scheduledCourseItems
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : studentSchedulers-scheduledCourseItems-item-response
Type: object
Show Source
Nested Schema : Course Requisites
Type: array
Title: Course Requisites
The course requisites resource is a child of the scheduled course items resource and provides a list of requisites associated with a course.
Show Source
Nested Schema : Scheduled Courses
Type: array
Title: Scheduled Courses
The scheduled courses resource is a child of the student schedulers resource and provides a list of scheduled courses offered by institutions.
Show Source
Nested Schema : Validation Massages
Type: array
Title: Validation Massages
The validation messages resource is a child of the scheduled course items resource and provides a list of validation messages associated with the scheduled course items.
Show Source
Nested Schema : studentSchedulers-scheduledCourseItems-courseRequisites-item-response
Type: object
Show Source
  • Title: Course Curriculum ID
    Read Only: true
    The unique identifier for the curriculum course of the curriculum course requisite.
  • Title: Curriculum Item Type
    Read Only: true
    Maximum Length: 30
    The code of the curriculum type of the requisite associated with the course.
  • Links
  • Title: Prerequisite Status Code
    A code indicating a student's prerequisite status for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_STATUS_CODE.
  • Title: Prerequisite Status Meaning
    The meaning of the code indicating a student's prerequisite status for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_STATUS_CODE.
  • Title: Requisite Curriculum ID
    Read Only: true
    The unique identifier for a requisite curriculum item.
  • Title: Requisite Curriculum Name
    Read Only: true
    The name of a requisite curriculum item.
  • 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 : studentSchedulers-scheduledCourseItems-scheduledCourses-item-response
Type: object
Show Source
  • Title: Academic Level ID
    Read Only: true
    The unique identifier for an academic level value that is associated with a course.
  • 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.
  • 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 unique identifier of the credit type 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 unique identifier 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 false.
  • Title: Scheduler Enabled
    Read Only: true
    Indicates whether the scheduled course can be added to the scheduler. The default value is false.
  • 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 false.
  • 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 student schedulers 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 scheduled courses resource and provides a list of staff associated with a scheduled course.
  • 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 a scheduled course ends.
  • Title: Scheduled Course Number
    Read Only: true
    A generated, alternate identifier for a scheduled course.
  • Title: Start Date
    Read Only: true
    The date when a 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 student schedulers 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 : studentSchedulers-scheduledCourseItems-scheduledCourses-meetingPatterns-item-response
Type: object
Show Source
Nested Schema : studentSchedulers-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 staff member associated with the course.
  • Title: Staff Image
    Read Only: true
    The content of a staff attachment such as an image file.
  • Title: Attachment ID
    Read Only: true
    The unique identifier for an attachment associated with a staff member's record.
  • Title: Name
    Read Only: true
    Maximum Length: 450
    The name of the staff member associated with the course.
  • Title: Title
    Read Only: true
    Maximum Length: 60
    The title of the staff member associated with the course.
  • Title: Biography
    Read Only: true
    An attachment containing biographical information about the staff member associated with the course.
  • Title: Primary
    Read Only: true
    Maximum Length: 1
    Indicates the primary staff member of the course.
  • 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 identifier of the staff assignment of the course.
Nested Schema : studentSchedulers-scheduledCourseItems-validationMessages-item-response
Type: object
Show Source
Back to Top