Get all curriculum items

get

/fscmRestApi/resources/11.13.18.05/curriculumItems

Request

Query Parameters
  • 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

    • FacetedSearchFinder Finds all curriculum items that match the search criteria.
      Finder Variables
      • CampusIds; string; Campus identifiers for the curriculum item.
      • CurriculumTagValueIds; string; Curriculum tag value identifiers for the curriculum item.
      • Keyword; string; Keyword; string; for the curriculum item.
      • OnFri; boolean; Curriculum Item has a meeting pattern on Friday.
      • OnMon; boolean; Curriculum Item has a meeting pattern on Monday.
      • OnSat; boolean; Curriculum Item has a meeting pattern on Saturday.
      • OnSun; boolean; Curriculum Item has a meeting pattern on Sunday.
      • OnThu; boolean; Curriculum Item has a meeting pattern on Thursday.
      • OnTue; boolean; Curriculum Item has a meeting pattern on Tuesday.
      • OnWed; boolean; Curriculum Item has a meeting pattern on Wednesday.
      • TimeFrom; string; Time start for the curriculum item.
      • TimeTo; string; Time end for the curriculum item.
    • PrimaryKey Finds all curriculum items that match the primary key criteria specified.
      Finder Variables
      • CurriculumId; integer; Unique identifier for the curriculum item.
    • SponsoredCourseFinder Finds all curriculum items which are sponsored.
      Finder Variables
    • 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:
      • AcademicLevelId; integer; The unique identifier for the academic level associated with a curriculum item.
      • AcademicLevelName; string; The name of the academic level associated with a curriculum item such as undergraduate or graduate.
      • AcademicPeriodId; integer; The unique identifier for an academic period.
      • AcademicSubjectId; integer; The unique identifier for a subject.
      • CoursePayToEnrollFlag; boolean; Indicates whether the course should be placed in the shopping cart and students must make payment at the point of enrollment. The default value is false.
      • CurriculumFormatCode; string; The code for the format, such as online, by which the curriculum item is offered. 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.
      • CurriculumHeaderId; integer; The unique identifier for a curriculum item.
      • CurriculumId; integer; The generated primary key column for a curriculum header row, which is the record that's shared across curriculum item types.
      • CurriculumName; string; The name or description of a curriculum item.
      • CurriculumTitle; string; The title of a curriculum item.
      • CurriculumType; string; The unique identifier of the type category of a curriculum item.
      • FlatAmount; number; The numeric value of the flat amount charge of a scheduled course.
      • IsCartableFlag; boolean; Indicates whether the scheduled course can be added to the shopping cart. The default value is true.
      • MaximumUnitsQuantity; number; The maximum number of units of credit that must be completed to satisfy a curriculum item requirement.
      • MinimumUnitsQuantity; number; The minimum number of units of credit that can be completed or used to satisfy a curriculum item requirement.
      • 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.
      • PeriodName; string; The name of the academic period.
      • ReportingPeriodId; integer; The unique identifier for a reporting period.
      • ReportingPeriodName; string; The name of the reporting period.
      • StartDate; string; The effective start date of the curriculum item.
    • 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
    • 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 : curriculumItems
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : curriculumItems-item-response
    Type: object
    Show Source
    • Title: Academic Level
      Read Only: true
      The unique identifier for the academic level associated with a curriculum item.
    • Title: Academic Level
      Read Only: true
      Maximum Length: 50
      The name of the academic level associated with a curriculum item such as undergraduate or graduate.
    • Title: Academic Period ID
      Read Only: true
      The unique identifier for an academic period.
    • Title: Subject
      Read Only: true
      The unique identifier for a subject.
    • Title: Pay to enroll
      Read Only: true
      Maximum Length: 1
      Indicates whether the course should be placed in the shopping cart and students must make payment at the point of enrollment. The default value is false.
    • Title: Code
      Read Only: true
      Maximum Length: 30
      The code for the format, such as online, by which the curriculum item is offered. 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.
    • Read Only: true
      The unique identifier for a curriculum item.
    • Title: Curriculum ID
      Read Only: true
      The generated primary key column for a curriculum header row, which is the record that's shared across curriculum item types.
    • Title: Name
      Read Only: true
      Maximum Length: 50
      The name or description of a curriculum item.
    • Title: Title
      Read Only: true
      Maximum Length: 100
      The title of a curriculum item.
    • Title: Curriculum Item Type
      Read Only: true
      Maximum Length: 30
      The unique identifier of the type category of a curriculum item.
    • Title: Flat Amount
      Read Only: true
      The numeric value of the flat amount charge of a scheduled course.
    • Title: Shopping Cart Enabled
      Read Only: true
      Maximum Length: 4
      Indicates whether the scheduled course can be added to the shopping cart. The default value is true.
    • Links
    • Title: Maximum Units
      Read Only: true
      The maximum number of units of credit that must be completed to satisfy a curriculum item requirement.
    • Title: Minimum Units
      Read Only: true
      The minimum number of units of credit that can be completed or used to satisfy a curriculum item requirement.
    • Offering Storefronts
      Title: Offering Storefronts
      The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.
    • Title: Owning Curriculum ID
      Read Only: true
      The unique identifier for the parent curriculum item of the scheduled course.
    • Title: Owning Name
      Read Only: true
      Maximum Length: 50
      The name for the parent curriculum item of the scheduled course.
    • Title: Period Name
      Read Only: true
      Maximum Length: 50
      The name of the academic period.
    • Programs
      Title: Programs
      The program resource is a child of the curriculum items resource and provides the information for a program curriculum item.
    • Title: Reporting Period ID
      Read Only: true
      The unique identifier for a reporting period.
    • Title: Reporting Period Name
      Read Only: true
      Maximum Length: 50
      The name of the reporting period.
    • Scheduled Courses
      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.
    • Title: Start Date
      Read Only: true
      The effective start date of the curriculum item.
    • Unscheduled Course Offerings
      Title: Unscheduled Course Offerings
      The unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item.
    Nested Schema : Offering Storefronts
    Type: array
    Title: Offering Storefronts
    The offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.
    Show Source
    Nested Schema : Programs
    Type: array
    Title: Programs
    The program resource is a child of the curriculum items resource and provides the information for a program curriculum item.
    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 : Unscheduled Course Offerings
    Type: array
    Title: Unscheduled Course Offerings
    The unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item.
    Show Source
    Nested Schema : curriculumItems-offeringStorefronts-item-response
    Type: object
    Show Source
    Nested Schema : curriculumItems-program-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 program.
    • Title: Academic Level Name
      Read Only: true
      Maximum Length: 100
      The name of an academic level value that's associated with a program.
    • Title: Admission Required
      Read Only: true
      Maximum Length: 1
      Default Value: true
      Indicates if a person must be formally admitted to a program. If yes, admission is required. If no, a person can join the program without requesting admission.
    • Title: Campus ID
      Read Only: true
      The unique identifier for a campus that's associated with a program.
    • Title: Name
      Read Only: true
      The name of the campus where this program is offered.
    • Title: Program Credential ID
      Read Only: true
      The credential associated with the program.
    • Title: Name
      Read Only: true
      The name of the credential associated with the program.
    • Title: Type of Credit
      Read Only: true
      Maximum Length: 30
      A code for the type of credit used in a program. 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 credit type code for a program. 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: Format
      Read Only: true
      Maximum Length: 30
      A code for the format, such as online, in which a program is offered. 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 a program 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.
    • Title: Curriculum ID
      Read Only: true
      The generated primary key column for a program.
    • Title: Long Description
      Read Only: true
      The long description for a program.
    • Title: Name
      Read Only: true
      Maximum Length: 150
      The name of the program or academic group associated with this student curriculum item.
    • Title: Status
      Read Only: true
      Maximum Length: 30
      The status code for a program.
    • Title: Title
      Read Only: true
      Maximum Length: 100
      The title or formal description of a program.
    • Title: List by Sequence
      Read Only: true
      Maximum Length: 1
      Default Value: false
      Determines the sort order of child courses for a program. If yes, courses are sorted by sequence number. If no, courses are sorted by requirement category and sequence number.
    • Title: First Admit Date
      Read Only: true
      The first date when a program is available for admission.
    • Images
      Title: Images
      The images resource is a child of the courses resource and provides a list of image attachments associated with a course.
    • Title: Institution
      Read Only: true
      The identifier for the institution to which the program belongs.
    • Title: Shopping Cart Enabled
      Read Only: true
      Maximum Length: 255
      Indicates whether a program is available for the shopping cart. If yes, a user can add the program to their shopping cart. If no, the add to shopping cart option isn't available. The default value is yes.
    • Title: Wish List Enabled
      Read Only: true
      Maximum Length: 255
      Indicates whether a program can be added to a user's wish list. If yes, a user can add the program to their wish list. If no, the add to wish list option isn't available. The default value is yes.
    • Title: Last Admit Date
      Read Only: true
      The last date when a program is available for admission.
    • Links
    • Title: Maximum Duration
      Read Only: true
      Maximum Length: 30
      A unit of measure for the maximum length of time allowed to complete the program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
    • Title: Maximum Duration Meaning
      Read Only: true
      Maximum Length: 80
      The meaning of the unit of measure for the maximum length of time allowed to complete the program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
    • Title: Maximum Duration Quantity
      Read Only: true
      Along with the unit of measure, this defines the maximum length of time allowed to complete the program.
    • Offering Campuses
      Title: Offering Campuses
      The offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.
    • Offering Credentials
      Title: Offering Credentials
      The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.
    • Parameters
      Title: Parameters
      The parameters resource is a child of the programs resource and provides a list of program parameters for a program.
    • Title: Program Type ID
      Read Only: true
      The unique identifier for a program type that's associated with a program.
    • Title: Main Program
      Read Only: true
      Maximum Length: 1
      Indicates whether a program is a main program.
    • Title: Program Type
      Read Only: true
      Maximum Length: 50
      The meaning of a program type that's associated with a program.
    • Tags
      Title: Tags
      The tags resource is a child of the courses resource and provides a list of tags associated with a course.
    • Title: Duration Measurement
      Read Only: true
      Maximum Length: 30
      A code that indicates the type of units used to express the typical time duration for a program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
    • Title: Typical Time Span
      Read Only: true
      Maximum Length: 80
      The meaning of the unit of measurement code for the typical duration of program, such as months or years. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
    • Title: Typical Duration
      Read Only: true
      The number of time span units used to express the typical duration of a program, such as 4 years.
    • Title: URL Address
      Read Only: true
      The URL for a web page associated with a program.
    Nested Schema : Images
    Type: array
    Title: Images
    The images resource is a child of the courses resource and provides a list of image attachments associated with a course.
    Show Source
    Nested Schema : Offering Campuses
    Type: array
    Title: Offering Campuses
    The offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.
    Show Source
    Nested Schema : Offering Credentials
    Type: array
    Title: Offering Credentials
    The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.
    Show Source
    Nested Schema : Parameters
    Type: array
    Title: Parameters
    The parameters resource is a child of the programs resource and provides a list of program parameters for a program.
    Show Source
    Nested Schema : Tags
    Type: array
    Title: Tags
    The tags resource is a child of the courses resource and provides a list of tags associated with a course.
    Show Source
    Nested Schema : curriculumItems-program-images-item-response
    Type: object
    Show Source
    • Title: Attachment Content
      Read Only: true
      The content of the attachment associated with the course.
    • Title: Curriculum Attachment Context
      Read Only: true
      Maximum Length: 30
      The context name of the attachment associated with the course.
    • Title: Curriculum Attachment ID
      Read Only: true
      The unique identifier of the attachment associated with the course.
    • Links
    Nested Schema : curriculumItems-program-offeringCampuses-item-response
    Type: object
    Show Source
    Nested Schema : curriculumItems-program-offeringCredentials-item-response
    Type: object
    Show Source
    Nested Schema : curriculumItems-program-parameters-item-response
    Type: object
    Show Source
    Nested Schema : curriculumItems-program-tags-item-response
    Type: object
    Show Source
    Nested Schema : curriculumItems-scheduledCourse-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.
    • Images
      Title: Images
      The images resource is a child of the courses resource and provides a list of image attachments associated with a 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.
    • 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 : Images
    Type: array
    Title: Images
    The images resource is a child of the courses resource and provides a list of image attachments associated with a course.
    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 : curriculumItems-scheduledCourse-images-item-response
    Type: object
    Show Source
    • Title: Attachment Content
      Read Only: true
      The content of the attachment associated with the course.
    • Title: Curriculum Attachment Context
      Read Only: true
      Maximum Length: 30
      The context name of the attachment associated with the course.
    • Title: Curriculum Attachment ID
      Read Only: true
      The unique identifier of the attachment associated with the course.
    • Links
    Nested Schema : curriculumItems-scheduledCourse-meetingPatterns-item-response
    Type: object
    Show Source
    Nested Schema : curriculumItems-unscheduledCourseOffering-item-response
    Type: object
    Show Source
    • Title: Academic Level ID
      Read Only: true
      The unique identifier of the academic level associated with the offering.
    • Title: Academic Level
      Read Only: true
      Maximum Length: 100
      The name of the academic level associated with the offering.
    • Title: Subject Code
      Read Only: true
      Maximum Length: 30
      The code for the course's academic subject.
    • Title: Academic Subject ID
      Read Only: true
      The unique identifier for the course's academic subject.
    • Title: Subject
      Read Only: true
      Maximum Length: 50
      The name of the course's academic subject.
    • Title: Closest Scheduled ID
      Read Only: true
      The curriculum identifier for the scheduled instance of a course that has a start date closest to today's date.
    • Title: Course Offering 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 course.
    • Title: Type of Credit
      Read Only: true
      Maximum Length: 30
      The code for the type of credit assigned to a 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 attached to a 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 associated with the course.
    • Title: Curriculum ID
      Read Only: true
      The unique identifier for a curriculum item such as a course.
    • Images
      Title: Images
      The images resource is a child of the courses resource and provides a list of image attachments associated with a course.
    • Title: Institution
      Read Only: true
      The unique identifier for the institution that owns the course.
    • Title: Wish List Enabled
      Read Only: true
      Indicates whether the course can be added to the wish list. The default value is true.
    • Links
    • Offering Campuses
      Title: Offering Campuses
      The offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.
    • Title: Offer Number
      Read Only: true
      The unique sort identifier for the offering of the course.
    • Title: Scheduled Course Count
      Read Only: true
      The number of scheduled instances of a course that are available for enrollment as of the current date.
    • Tags
      Title: Tags
      The tags resource is a child of the courses resource and provides a list of tags associated with a course.
    Nested Schema : Images
    Type: array
    Title: Images
    The images resource is a child of the courses resource and provides a list of image attachments associated with a course.
    Show Source
    Nested Schema : Offering Campuses
    Type: array
    Title: Offering Campuses
    The offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.
    Show Source
    Nested Schema : Tags
    Type: array
    Title: Tags
    The tags resource is a child of the courses resource and provides a list of tags associated with a course.
    Show Source
    Nested Schema : curriculumItems-unscheduledCourseOffering-images-item-response
    Type: object
    Show Source
    • Title: Attachment Content
      Read Only: true
      The content of the attachment associated with the course.
    • Title: Curriculum Attachment Context
      Read Only: true
      Maximum Length: 30
      The context name of the attachment associated with the course.
    • Title: Curriculum Attachment ID
      Read Only: true
      The unique identifier of the attachment associated with the course.
    • Links
    Nested Schema : curriculumItems-unscheduledCourseOffering-offeringCampuses-item-response
    Type: object
    Show Source
    Nested Schema : curriculumItems-unscheduledCourseOffering-tags-item-response
    Type: object
    Show Source
    Back to Top