Get a course

get

/fscmRestApi/resources/11.13.18.05/courses/{coursesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Courses resource and used to uniquely identify an instance of Courses. The client should not generate the hash key value. Instead, the client should query on the Courses collection resource in order to navigate to a specific instance of Courses to get the hash key.
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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : courses-item-response
Type: object
Show Source
  • Additional Information
    Title: Additional Information
    The additional information resource is a child of the courses resource and provides a list of messages associated with a course.
  • 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 consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.
  • Course Offerings
    Title: Course Offerings
    The course offerings resource is a child of the courses resource and provides a list of offerings for a course.
  • 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.
  • Title: Format
    Read Only: true
    Maximum Length: 30
    The unique identifier for the format of the 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 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 course.
  • Title: Long Description
    Read Only: true
    The description of the course.
  • Title: Name
    Read Only: true
    Maximum Length: 150
    The name of the course.
  • Title: Title
    Read Only: true
    Maximum Length: 100
    The title of the 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 false.
  • Title: Enrollment Status
    Read Only: true
    Maximum Length: 30
    Default Value: ORA_OPN
    Unique identifier of the enrollment status of the 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 course such as open or closed. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE.
  • 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: Wish List Enabled
    Read Only: true
    Indicates whether the course can be added to the wish list. The default value is true.
  • Links
  • Title: Maximum Units
    Read Only: true
    A numeric value indicating the maximum units of the course.
  • Title: Minimum Units
    Read Only: true
    A numeric value indicating the minimum units of the course.
  • 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: Pay to enroll
    Read Only: true
    Maximum Length: 1
    Default Value: false
    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: Repeatable
    Read Only: true
    Maximum Length: 1
    Default Value: false
    Indicates whether a course can be repeated. The default value is false.
  • Title: Total Completions Allowed
    Read Only: true
    The total number of times a student can complete a course that's repeatable.
  • Title: Allow multiple enrollment
    Read Only: true
    Maximum Length: 1
    Default Value: false
    Indicates whether a student can enroll in multiple instances of the same course in the same enrollment period. The default value is false.
  • Title: Total Units Allowed
    Read Only: true
    The maximum number of credits that a student can receive for multiple completions of a repeatable course.
  • Title: Requisite Exists
    Read Only: true
    Indicates if requisite courses exist.
  • Title: Requisite Description
    Read Only: true
    The description of the curriculum item selected as the requisite.
  • Staff Summaries
    Title: Staff Summaries
    The staff summary resource is a child of the program elements resource and provides a unique list of all associated staff.
  • 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 false.
  • Tags
    Title: Tags
    The tags resource is a child of the courses resource and provides a list of tags associated with a course.
  • Title: Typically Offered
    Read Only: true
    Maximum Length: 30
    The code of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
  • Title: Typically Offered Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
  • Title: URL Address
    Read Only: true
    An attachment which captures the URL address of the course.
Nested Schema : Additional Information
Type: array
Title: Additional Information
The additional information resource is a child of the courses resource and provides a list of messages associated with a course.
Show Source
Nested Schema : Course Offerings
Type: array
Title: Course Offerings
The course offerings resource is a child of the courses resource and provides a list of offerings for 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 : 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 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 : Staff Summaries
Type: array
Title: Staff Summaries
The staff summary resource is a child of the program elements resource and provides a unique list of all associated staff.
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 : courses-additionalInformation-item-response
Type: object
Show Source
Nested Schema : courses-courseOfferings-item-response
Type: object
Show Source
  • Title: Academic Level ID
    Read Only: true
    The unique identifier of the academic level associated with offering.
  • Title: Academic Level
    Read Only: true
    Maximum Length: 100
    The name of the academic level associated with 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 meaning of the requisite type. Valid values include Corequisite or Prerequisite. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.
  • 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: 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 consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.
  • Title: Course Offering Credential ID
    Read Only: true
    The unique identifier of the credential associated with the curriculum offering.
  • 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 Header ID
    Read Only: true
    The generated primary key column for a curriculum record.
  • Title: Curriculum ID
    Read Only: true
    The generated primary key column for a curriculum offering.
  • 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 false.
  • Title: Institution
    Read Only: true
    The unique identifier for the institution on the offering of the course.
  • Title: Institution
    Read Only: true
    Maximum Length: 50
    The name of the institution to which the course offering belongs.
  • 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 Academic Organizations
    Title: Offering Academic Organizations
    The offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering.
  • 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: Repeatable
    Read Only: true
    Maximum Length: 1
    Default Value: false
    Indicates whether a course can be repeated. The default value is false.
  • Title: Total Completions Allowed
    Read Only: true
    The total number of times a student can complete a course that's repeatable.
  • Title: Allow multiple enrollment
    Read Only: true
    Maximum Length: 1
    Default Value: false
    Indicates whether a student can enroll in multiple instances of the same course in the same enrollment period. The default value is false.
  • Title: Total Units Allowed
    Read Only: true
    The maximum number of credits that a student can receive for multiple completions of a repeatable course.
  • Results
    Title: Results
    The results resource is a child of the course offerings resource and provides a list of result type and result set combinations associated with the course offering.
  • 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.
  • Scheduled Courses
    Title: Scheduled Courses
    The scheduled courses resource is a child of the course offerings resource and provides a list of scheduled courses offered by institutions.
  • 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 false.
  • Tags
    Title: Tags
    The tags resource is a child of the courses resource and provides a list of tags associated with a course.
  • Title: Typically Offered
    Read Only: true
    Maximum Length: 30
    The code of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
  • Title: Typically Offered Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
Nested Schema : Offering Academic Organizations
Type: array
Title: Offering Academic Organizations
The offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering.
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 : Results
Type: array
Title: Results
The results resource is a child of the course offerings resource and provides a list of result type and result set combinations associated with the course offering.
Show Source
Nested Schema : Scheduled Courses
Type: array
Title: Scheduled Courses
The scheduled courses resource is a child of the course offerings resource and provides a list of scheduled courses offered by institutions.
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 : courses-courseOfferings-offeringAcademicOrganizations-item-response
Type: object
Show Source
Nested Schema : courses-courseOfferings-offeringCampuses-item-response
Type: object
Show Source
Nested Schema : courses-courseOfferings-results-item-response
Type: object
Show Source
  • Title: Curriculum Result ID
    Read Only: true
    The generated primary key column for a curriculum result record.
  • Title: Default Result Set Indicator
    Read Only: true
    Maximum Length: 1
    Indicates if the result set row is the default for the course. The default value is false.
  • Links
  • Title: Result Set Code
    Read Only: true
    Maximum Length: 30
    The code of the result set associated with the course.
  • Title: Result Set ID
    Read Only: true
    The unique identifier of the result set associated with the course.
  • Title: Result Set Name
    Read Only: true
    Maximum Length: 50
    The name of the result set associated with the course.
  • Title: Result Type Code
    Read Only: true
    Maximum Length: 30
    The code of the result type associated with the course.
  • Title: Result Type ID
    Read Only: true
    The unique identifier of the result type associated with the course.
  • Title: Result Type Name
    Read Only: true
    Maximum Length: 50
    The name of the result type associated with the course.
Nested Schema : courses-courseOfferings-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 a 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 unique identifier of the credential type of the 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 generated primary key column for a curriculum 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 currency code associated with the flat amount.
  • 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 : courses-courseOfferings-scheduledCourses-meetingPatterns-item-response
Type: object
Show Source
Nested Schema : courses-courseOfferings-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 : courses-courseOfferings-tags-item-response
Type: object
Show Source
Nested Schema : courses-courseRequisites-item-response
Type: object
Show Source
  • Title: Requisite Curriculum ID
    Read Only: true
    The unique identifier for a requisite curriculum item.
  • Title: Requisite Curriculum Name
    Read Only: true
    Maximum Length: 150
    The name of a requisite curriculum item.
  • Title: Curriculum Requisite ID
    Read Only: true
    The unique identifier for the curriculum requisite.
  • Title: Curriculum Item Type
    Read Only: true
    Maximum Length: 30
    The code of the curriculum type of the requisite associated with the course.
  • Read Only: true
    Maximum Length: 50
    The name of the curriculum type of the requisite associated with the course.
  • Links
  • Title: Requisite Scheme ID
    Read Only: true
    The unique identifier for a requisite scheme.
  • Title: Requisite Scheme
    Read Only: true
    Maximum Length: 50
    The requisite scheme name entered by the user.
  • 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.
  • Title: Requisite Type
    Read Only: true
    Maximum Length: 80
    The meaning of the requisite type. Valid values include Corequisite or Prerequisite. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE.
Nested Schema : courses-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 : courses-offeringStorefronts-item-response
Type: object
Show Source
Nested Schema : courses-staffSummary-item-response
Type: object
Show Source
  • Title: Academic Period ID
    Read Only: true
    The unique identifier for an academic period.
  • Links
  • Title: Period Name
    Read Only: true
    Maximum Length: 50
    The name of the academic period.
  • Title: Name
    Read Only: true
    Maximum Length: 450
    The name of the staff member associated with the course.
  • Title: Primary
    Read Only: true
    Maximum Length: 1
    Identifies the primary staff member for a program or course. When yes, the staff row is considered the primary staff resource. The default value is false. If only one record exists, the default value is true.
  • 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.
  • Title: Role Access
    Read Only: true
    Maximum Length: 30
    The code for the role access of the staff member in relation to a curriculum item. Valid values include ORA_GRADE and ORA_POC. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_ACCESS_CODE.
  • Title: Role Access Code Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of a staff role access value. Valid values include Grader or Point of contact. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_ACCESS_CODE.
  • Title: Role Type
    Read Only: true
    Maximum Length: 30
    The role type of the staff member in relation to a curriculum item. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
  • Title: Role Type Code Meaning
    Read Only: true
    Maximum Length: 80
    The meaning of a staff role type value. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
Nested Schema : courses-tags-item-response
Type: object
Show Source
Back to Top