REST API for Oracle Fusion Cloud Student Management

Get all scheduled courses

get

/fscmRestApi/resources/11.13.18.05/scheduledCourses

Request

Query Parameters

effectiveDate: string

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
expand: string

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).
fields: string

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
finder: string
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 courses that match the primary key criteria specified.
  Finder Variables
  - CurriculumHeaderId; integer; The unique identifier for a curriculum header record.
- SearchableFinder Finds all scheduled courses that match the searchable criteria.
  Finder Variables
- SponsoredCourseFinder Finds all scheduled courses which are sponsored.
  Finder Variables
limit: integer

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.
links: string

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
offset: integer

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.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

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
q: string
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 an academic level value that's associated with a course.
- AcademicLevelName; string; The name of an academic level, such as undergraduate, that's associated with a course.
- AcademicOrgId; integer; The unique identifier of the academic organization of the scheduled course.
- AcademicSubjectCode; string; The code for the scheduled course's academic subject.
- AcademicSubjectId; integer; The unique identifier for the course's academic subject.
- AcademicSubjectName; string; The name of the subject of the scheduled course.
- BuildingName; string; The name of the building associated with the meeting pattern of the scheduled course.
- BuildingShortCode; string; The unique identifier of the building associated with the meeting pattern of the scheduled course.
- CampusId; integer; The unique identifier for the campus where a course is offered.
- CampusName; string; The campus where the scheduled course is offered.
- ConsentTypeCode; string; The type of enrollment consent required by the student. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. Examples include course instructor, department chair and registrar.
- ConsentTypeMeaning; string; The meaning of the consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.
- CoursePayToEnrollFlag; boolean; Indicates that the student must pay for the course at the time of enrollment. The default value is false.
- CredentialId; integer; The unique identifier of the credential associated with the course.
- CredentialName; string; The name of the credential associated with the scheduled course.
- CredentialTypeCode; string; The code for the type of credential associated with the scheduled course. Valid values include ORA_CERTIFICATE, ORA_DEGREE, or ORA_DIPLOMA. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_TYPE_CODE.
- CreditTypeCode; string; The code for the type of credit associated with the scheduled course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
- CreditTypeMeaning; string; 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.
- CurriculumFormatCode; string; The code for the format of the scheduled course. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
- CurriculumFormatMeaning; string; The meaning of the format of the scheduled course. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
- CurriculumHeaderId; integer; The unique identifier for a curriculum header record.
- CurriculumId; integer; The generated unique identifier of a scheduled course.
- CurriculumLongDescription; string; The description of the scheduled course.
- CurriculumName; string; The name of the scheduled course.
- CurriculumTitle; string; The title of the scheduled course.
- EnrollConsentRequiredFlag; boolean; Indicates that a student must obtain consent to enroll in the curriculum item. The default value is inherited from the course.
- EnrollmentCapacityQuantity; integer; A numeric value indicating the enrollment capacity of the scheduled course.
- EnrollmentStatusCode; string; 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.
- EnrollmentStatusMeaning; string; 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.
- FacilityDescription; string; The description of the facility associated with the scheduled course.
- FacilityRoomNumber; string; The room number associated with the meeting pattern of the scheduled course.
- FacilityShortCode; string; The identifier of the facility associated with the meeting pattern of the scheduled course.
- FlatAmount; number; The numeric value of the flat amount charge of a scheduled course.
- FlatAmountCurrencyCode; string; The unique identifier of the flat amount charge of a scheduled course.
- FlatAmountCurrencySymbol; string; The denomination of the flat amount charge of a scheduled course.
- InstitutionId; integer; The unique identifier for the institution where the scheduled course is offered.
- InstitutionName; string; The name of the institution where the scheduled course is offered.
- InstructorName; string; The name of the instructor of the scheduled course.
- IsCartableFlag; boolean; Indicates whether the scheduled course can be added to the shopping cart. The default value is true.
- IsSchedulableFlag; boolean; Indicates whether the scheduled course can be added to the scheduler. The default value is true.
- IsSelfPacedFlag; boolean; Indicates whether the scheduled course is self-paced. The default value is false.
- IsWishableFlag; boolean; Indicates whether the scheduled course can be added to the wish list. The default value is true.
- LocationControlCode; string; The unique identifier of the single use location associated with the meeting pattern of the scheduled course.
- LocationLatitude; number; The GPS latitude coordinates for the scheduled course meeting location.
- LocationLongName; string; The name of the single use location associated with the meeting pattern of the scheduled course.
- LocationLongitude; number; The GPS longitude coordinates for the scheduled course meeting location.
- MapIntegrationURL; string; The uniform resource locator of the map application to be used for displaying scheduled course meeting location.
- MaximumUnitsQuantity; number; A numeric value indicating the maximum units of the scheduled course.
- MeetingPatternDescription; string; The name of the meeting pattern of the scheduled course.
- MeetingPatternEndDate; string; The date when the meeting pattern of the scheduled course ends.
- MeetingPatternEndTime; string; The time when the meeting pattern of the scheduled course ends.
- MeetingPatternStartDate; string; The date when the meeting pattern of the scheduled course starts.
- MeetingPatternStartTime; string; The time when the meeting pattern of the scheduled course starts.
- MinimumUnitsQuantity; number; A numeric value indicating the minimum units of the scheduled 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.
- OwningOfferNumber; integer; The unique identifier for the parent curriculum item offer number of the scheduled course.
- ReportingPeriodEndDate; string; The date when the reporting period associated with the scheduled course ends.
- ReportingPeriodId; integer; The unique identifier for the reporting period associated with the scheduled course.
- ReportingPeriodName; string; The name of the reporting period associated with the scheduled course.
- ReportingPeriodStartDate; string; The date when the reporting period associated with the scheduled course starts.
- ScheduledCourseCode; string; The code used to identify a scheduled course within a given course and academic period.
- ScheduledCourseEndDate; string; The date when the scheduled course ends.
- ScheduledCourseNumber; integer; A generated unique key for a scheduled course.
- ScheduledCourseStartDate; string; The date when the scheduled course starts.
- StudentRequestConsentFlag; boolean; Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is inherited from the course.
- TotalEnrolledQuantity; integer; A numeric value indicating the number of enrollments in the scheduled course.
- URLAddress; string; The unique URL address of the scheduled course.
totalResults: boolean

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

Effective-Of: string

This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
Metadata-Context: string

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version: string

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.

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : scheduledCourses

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/scheduledCourses-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object scheduledCourses-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/scheduledCourses-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : scheduledCourses-item-response

Type: object

Show Source

AcademicLevelId: integer (int64)

Title: Academic Level ID

Read Only: true

The unique identifier for an academic level value that's associated with a course.
AcademicLevelName: string

Title: Academic Level Name

Read Only: true

Maximum Length: 100

The name of an academic level, such as undergraduate, that's associated with a course.
AcademicOrgId: integer (int64)

Title: Academic Organization ID

Read Only: true

The unique identifier of the academic organization of the scheduled course.
AcademicSubjectCode: string

Title: Subject Code

Read Only: true

Maximum Length: 30

The code for the scheduled course's academic subject.
AcademicSubjectId: integer (int64)

Title: Academic Subject ID

Read Only: true

The unique identifier for the course's academic subject.
AcademicSubjectName: string

Title: Name

Read Only: true

Maximum Length: 50

The name of the subject of the scheduled course.
additionalInformation: array 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.
BuildingName: string

Title: Name

Read Only: true

The name of the building associated with the meeting pattern of the scheduled course.
BuildingShortCode: string

Title: Code

Read Only: true

The unique identifier of the building associated with the meeting pattern of the scheduled course.
CampusId: integer (int64)

Title: Campus

Read Only: true

The unique identifier for the campus where a course is offered.
CampusName: string

Title: Campus

Read Only: true

Maximum Length: 50

The campus where the scheduled course is offered.
ConsentTypeCode: string

Title: Permission Type

Read Only: true

Maximum Length: 30

Default Value: ORA_NOT_REQUIRED

The type of enrollment consent required by the student. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. Examples include course instructor, department chair and registrar.
ConsentTypeMeaning: string

Title: Consent Type Meaning

Read Only: true

Maximum Length: 80

The meaning of the consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.
CoursePayToEnrollFlag: boolean

Title: Pay to enroll

Read Only: true

Maximum Length: 1

Default Value: false

Indicates that the student must pay for the course at the time of enrollment. The default value is false.
CredentialId: integer (int64)

Title: Scheduled Course Credential ID

Read Only: true

The unique identifier of the credential associated with the course.
CredentialName: string

Title: Name

Read Only: true

Maximum Length: 50

The name of the credential associated with the scheduled course.
CredentialTypeCode: string

Title: Credential Type

Read Only: true

Maximum Length: 30

The code for the type of credential associated with the scheduled course. Valid values include ORA_CERTIFICATE, ORA_DEGREE, or ORA_DIPLOMA. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_TYPE_CODE.
CreditTypeCode: string

Title: Type of Credit

Read Only: true

Maximum Length: 30

The code for the type of credit associated with the scheduled course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
CreditTypeMeaning: string

Title: Type of Credit Meaning

Read Only: true

Maximum Length: 80

The meaning of the type of credit of the scheduled course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
CurriculumCatalogNumber: string

Title: Catalog Number

Read Only: true

Maximum Length: 10

The catalog number of the scheduled course.
CurriculumFormatCode: string

Title: Format

Read Only: true

Maximum Length: 30

The code for the format of the scheduled course. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
CurriculumFormatMeaning: string

Title: Curriculum Format Meaning

Read Only: true

Maximum Length: 80

The meaning of the format of the scheduled course. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
CurriculumHeaderId: integer (int64)

Title: Curriculum Header ID

Read Only: true

The unique identifier for a curriculum header record.
CurriculumId: integer (int64)

Title: Curriculum ID

Read Only: true

The generated unique identifier of a scheduled course.
CurriculumLongDescription: string

Title: Long Description

Read Only: true

The description of the scheduled course.
CurriculumName: string

Title: Name

Read Only: true

Maximum Length: 150

The name of the scheduled course.
CurriculumTitle: string

Title: Title

Read Only: true

Maximum Length: 100

The title of the scheduled course.
EnrollConsentRequiredFlag: boolean

Title: Permission Required to Enroll

Read Only: true

Maximum Length: 1

Default Value: false

Indicates that a student must obtain consent to enroll in the curriculum item. The default value is inherited from the course.
EnrollmentCapacityQuantity: integer (int32)

Title: Enrollment Capacity

Read Only: true

A numeric value indicating the enrollment capacity of the scheduled course.
EnrollmentStatusCode: string

Title: Enrollment Status

Read Only: true

Maximum Length: 30

Default Value: ORA_OPN

The unique identifier of the enrollment status of the scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE.
EnrollmentStatusMeaning: string

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.
FacilityDescription: string

Title: Description

Read Only: true

The description of the facility associated with the scheduled course.
FacilityRoomNumber: string

Title: Room Number

Read Only: true

The room number associated with the meeting pattern of the scheduled course.
FacilityShortCode: string

Title: Facility

Read Only: true

The identifier of the facility associated with the meeting pattern of the scheduled course.
fees: array Fees

Title: Fees

The fees resource is a child of the scheduled courses resource and provides a list of fees associated with a scheduled course.
FlatAmount: number

Title: Flat Amount

Read Only: true

The numeric value of the flat amount charge of a scheduled course.
FlatAmountCurrencyCode: string

Title: Currency Code

Read Only: true

The unique identifier of the flat amount charge of a scheduled course.
FlatAmountCurrencySymbol: string

Title: Currency Symbol

Read Only: true

The denomination of the flat amount charge of a scheduled course.
images: array Images

Title: Images

The images resource is a child of the courses resource and provides a list of image attachments associated with a course.
InstitutionId: integer (int64)

Title: Institution ID

Read Only: true

The unique identifier for the institution where the scheduled course is offered.
InstitutionName: string

Title: Institution

Read Only: true

Maximum Length: 50

The name of the institution where the scheduled course is offered.
InstructorName: string

Title: Name

Read Only: true

The name of the instructor of the scheduled course.
IsCartableFlag: boolean

Title: Shopping Cart Enabled

Read Only: true

Indicates whether the scheduled course can be added to the shopping cart. The default value is true.
IsSchedulableFlag: boolean

Title: Scheduler Enabled

Read Only: true

Indicates whether the scheduled course can be added to the scheduler. The default value is true.
IsSelfPacedFlag: boolean

Title: Self-Paced

Read Only: true

Indicates whether the scheduled course is self-paced. The default value is false.
IsWishableFlag: boolean

Title: Wish List Enabled

Read Only: true

Indicates whether the scheduled course can be added to the wish list. The default value is true.
links: array Links

Title: Links

The link relations associated with the resource instance.
LocationControlCode: string

Title: Location Control Code

Read Only: true

The unique identifier of the single use location associated with the meeting pattern of the scheduled course.
LocationLatitude: number

Title: Latitude

Read Only: true

The GPS latitude coordinates for the scheduled course meeting location.
LocationLongitude: number

Title: Longitude

Read Only: true

The GPS longitude coordinates for the scheduled course meeting location.
LocationLongName: string

Title: Location Long Name

Read Only: true

The name of the single use location associated with the meeting pattern of the scheduled course.
MapIntegrationURL: string

Title: Map Integration URL

Read Only: true

The uniform resource locator of the map application to be used for displaying scheduled course meeting location.
MaximumUnitsQuantity: number

Title: Maximum Units

Read Only: true

A numeric value indicating the maximum units of the scheduled course.
meetingDates: array Meeting Dates

Title: Meeting Dates

The meeting dates resource is a child of the scheduled courses resource and provides a list of meetings associated with a scheduled course.
MeetingPatternDescription: string

Title: Pattern Name

Read Only: true

The name of the meeting pattern of the scheduled course.
MeetingPatternEndDate: string (date)

Title: End Date

Read Only: true

The date when the meeting pattern of the scheduled course ends.
MeetingPatternEndTime: string (date-time)

Title: End Time

Read Only: true

The time when the meeting pattern of the scheduled course ends.
meetingPatterns: array Meeting Patterns

Title: Meeting Patterns

The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.
MeetingPatternStartDate: string (date)

Title: Start Date

Read Only: true

The date when the meeting pattern of the scheduled course starts.
MeetingPatternStartTime: string (date-time)

Title: Start Time

Read Only: true

The time when the meeting pattern of the scheduled course starts.
MinimumUnitsQuantity: number

Title: Minimum Units

Read Only: true

A numeric value indicating the minimum units of the scheduled course.
offeringAcademicPeriods: array Offering Academic Periods

Title: Offering Academic Periods

The offering academic periods resource is a child of the scheduled courses resource and provides a list of academic periods associated with a scheduled course.
offeringOrganizationStaff: array Offering Organization Staff

Title: Offering Organization Staff

The staff associated with a curriculum item.
offeringResultSets: array 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.
offeringStorefronts: array Offering Storefronts

Title: Offering Storefronts

Storefronts organize curriculum items into groups that can be presented with different branding to different audiences.
OwningCurriculumId: integer (int64)

Title: Owning Curriculum ID

Read Only: true

The unique identifier for the parent curriculum item of the scheduled course.
OwningCurriculumName: string

Title: Name

Read Only: true

Maximum Length: 150

The name for the parent curriculum item of the scheduled course.
OwningOfferNumber: integer (int32)

Title: Owning Offer Number

Read Only: true

The unique identifier for the parent curriculum item offer number of the scheduled course.
ReportingPeriodEndDate: string (date)

Title: Reporting Period End Date

Read Only: true

The date when the reporting period associated with the scheduled course ends.
ReportingPeriodId: integer (int64)

Title: Reporting Period ID

Read Only: true

The unique identifier for the reporting period associated with the scheduled course.
ReportingPeriodName: string

Title: Reporting Period

Read Only: true

Maximum Length: 50

The name of the reporting period associated with the scheduled course.
ReportingPeriodStartDate: string (date)

Title: Reporting Period Start Date

Read Only: true

The date when the reporting period associated with the scheduled course starts.
ScheduledCourseCode: string

Title: Scheduled Course Code

Read Only: true

Maximum Length: 30

The code used to identify a scheduled course within a given course and academic period.
ScheduledCourseEndDate: string (date-time)

Title: End Date

Read Only: true

The date when the scheduled course ends.
ScheduledCourseNumber: integer (int32)

Title: Scheduled Course Number

Read Only: true

A generated unique key for a scheduled course.
ScheduledCourseStartDate: string (date-time)

Title: Start Date

Read Only: true

The date when the scheduled course starts.
StudentRequestConsentFlag: boolean

Title: Allow Permission Request

Read Only: true

Maximum Length: 1

Default Value: false

Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is inherited from the course.
TotalEnrolledQuantity: integer (int32)

Title: Total Enrolled

Read Only: true

A numeric value indicating the number of enrollments in the scheduled course.
URLAddress: string

Title: URL Address

Read Only: true

The unique URL address of the scheduled course.

{
    "type":"object",
    "properties":{
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level value that's associated with a course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of an academic level, such as undergraduate, that's associated with a course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The unique identifier of the academic organization of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicSubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the scheduled course's academic subject.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicSubjectId":{
            "title":"Academic Subject ID",
            "type":"integer",
            "description":"The unique identifier for the course's academic subject.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicSubjectName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the subject of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the building associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingShortCode":{
            "title":"Code",
            "type":"string",
            "description":"The unique identifier of the building associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"The unique identifier for the campus where a course is offered.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampusName":{
            "title":"Campus",
            "maxLength":50,
            "type":"string",
            "description":"The campus where the scheduled course is offered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsentTypeCode":{
            "title":"Permission Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_NOT_REQUIRED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConsentTypeMeaning":{
            "title":"Consent Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoursePayToEnrollFlag":{
            "title":"Pay to enroll",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the student must pay for the course at the time of enrollment. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "CredentialId":{
            "title":"Scheduled Course Credential ID",
            "type":"integer",
            "description":"The unique identifier of the credential associated with the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CredentialName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the credential associated with the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CredentialTypeCode":{
            "title":"Credential Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeCode":{
            "title":"Type of Credit",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeMeaning":{
            "title":"Type of Credit Meaning",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumCatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The catalog number of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumFormatCode":{
            "title":"Format",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumFormatMeaning":{
            "title":"Curriculum Format Meaning",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumHeaderId":{
            "title":"Curriculum Header ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum header record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurriculumId":{
            "title":"Curriculum ID",
            "type":"integer",
            "description":"The generated unique identifier of a scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurriculumLongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"The description of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumName":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumTitle":{
            "title":"Title",
            "maxLength":100,
            "type":"string",
            "description":"The title of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollConsentRequiredFlag":{
            "title":"Permission Required to Enroll",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student must obtain consent to enroll in the curriculum item. The default value is inherited from the course.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "EnrollmentCapacityQuantity":{
            "title":"Enrollment Capacity",
            "type":"integer",
            "description":"A numeric value indicating the enrollment capacity of the scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EnrollmentStatusCode":{
            "title":"Enrollment Status",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_OPN",
            "x-queryable":true
        },
        "EnrollmentStatusMeaning":{
            "title":"Enrollment Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityDescription":{
            "title":"Description",
            "type":"string",
            "description":"The description of the facility associated with the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityRoomNumber":{
            "title":"Room Number",
            "type":"string",
            "description":"The room number associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityShortCode":{
            "title":"Facility",
            "type":"string",
            "description":"The identifier of the facility associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Flat Amount",
            "type":"number",
            "description":"The numeric value of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "FlatAmountCurrencyCode":{
            "title":"Currency Code",
            "type":"string",
            "description":"The unique identifier of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlatAmountCurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"The denomination of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for the institution where the scheduled course is offered.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution where the scheduled course is offered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructorName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the instructor of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsCartableFlag":{
            "title":"Shopping Cart Enabled",
            "type":"boolean",
            "description":"Indicates whether the scheduled course can be added to the shopping cart. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CartEnabledFlag"
                ]
            },
            "x-queryable":true
        },
        "IsSchedulableFlag":{
            "title":"Scheduler Enabled",
            "type":"boolean",
            "description":"Indicates whether the scheduled course can be added to the scheduler. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsSelfPacedFlag":{
            "title":"Self-Paced",
            "type":"boolean",
            "description":"Indicates whether the scheduled course is self-paced. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsWishableFlag":{
            "title":"Wish List Enabled",
            "type":"boolean",
            "description":"Indicates whether the scheduled course can be added to the wish list. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationControlCode":{
            "title":"Location Control Code",
            "type":"string",
            "description":"The unique identifier of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The GPS latitude coordinates for the scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "LocationLongName":{
            "title":"Location Long Name",
            "type":"string",
            "description":"The name of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The GPS longitude coordinates for the scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "MapIntegrationURL":{
            "title":"Map Integration URL",
            "type":"string",
            "description":"The uniform resource locator of the map application to be used for displaying scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumUnitsQuantity":{
            "title":"Maximum Units",
            "type":"number",
            "description":"A numeric value indicating the maximum units of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "MeetingPatternDescription":{
            "title":"Pattern Name",
            "type":"string",
            "description":"The name of the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumUnitsQuantity":{
            "title":"Minimum Units",
            "type":"number",
            "description":"A numeric value indicating the minimum units of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":11,
                "scale":2
            },
            "x-queryable":true
        },
        "OwningCurriculumId":{
            "title":"Owning Curriculum ID",
            "type":"integer",
            "description":"The unique identifier for the parent curriculum item of the scheduled course.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "OwningCurriculumName":{
            "title":"Name",
            "maxLength":150,
            "type":"string",
            "description":"The name for the parent curriculum item of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningOfferNumber":{
            "title":"Owning Offer Number",
            "type":"integer",
            "description":"The unique identifier for the parent curriculum item offer number of the scheduled course.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ReportingPeriodEndDate":{
            "title":"Reporting Period End Date",
            "type":"string",
            "description":"The date when the reporting period associated with the scheduled course ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingPeriodId":{
            "title":"Reporting Period ID",
            "type":"integer",
            "description":"The unique identifier for the reporting period associated with the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReportingPeriodName":{
            "title":"Reporting Period",
            "maxLength":50,
            "type":"string",
            "description":"The name of the reporting period associated with the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingPeriodStartDate":{
            "title":"Reporting Period Start Date",
            "type":"string",
            "description":"The date when the reporting period associated with the scheduled course starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseCode":{
            "title":"Scheduled Course Code",
            "maxLength":30,
            "type":"string",
            "description":"The code used to identify a scheduled course within a given course and academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the scheduled course ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledCourseNumber":{
            "title":"Scheduled Course Number",
            "type":"integer",
            "description":"A generated unique key for a scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ScheduledCourseStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the scheduled course starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StudentRequestConsentFlag":{
            "title":"Allow Permission Request",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is inherited from the course.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "TotalEnrolledQuantity":{
            "title":"Total Enrolled",
            "type":"integer",
            "description":"A numeric value indicating the number of enrollments in the scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "URLAddress":{
            "title":"URL Address",
            "type":"string",
            "description":"The unique URL address of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "additionalInformation":{
            "title":"Additional Information",
            "type":"array",
            "description":"The additional information resource is a child of the courses resource and provides a list of messages associated with a course.",
            "items":{
                "$ref":"#/components/schemas/scheduledCourses-additionalInformation-item-response"
            }
        },
        "fees":{
            "title":"Fees",
            "type":"array",
            "description":"The fees resource is a child of the scheduled courses resource and provides a list of fees associated with a scheduled course.",
            "items":{
                "$ref":"#/components/schemas/scheduledCourses-fees-item-response"
            }
        },
        "images":{
            "title":"Images",
            "type":"array",
            "description":"The images resource is a child of the courses resource and provides a list of image attachments associated with a course.",
            "items":{
                "$ref":"#/components/schemas/scheduledCourses-images-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "meetingDates":{
            "title":"Meeting Dates",
            "type":"array",
            "description":"The meeting dates resource is a child of the scheduled courses resource and provides a list of meetings associated with a scheduled course.",
            "items":{
                "$ref":"#/components/schemas/scheduledCourses-meetingDates-item-response"
            }
        },
        "meetingPatterns":{
            "title":"Meeting Patterns",
            "type":"array",
            "description":"The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.",
            "items":{
                "$ref":"#/components/schemas/scheduledCourses-meetingPatterns-item-response"
            }
        },
        "offeringAcademicPeriods":{
            "title":"Offering Academic Periods",
            "type":"array",
            "description":"The offering academic periods resource is a child of the scheduled courses resource and provides a list of academic periods associated with a scheduled course.",
            "items":{
                "$ref":"#/components/schemas/scheduledCourses-offeringAcademicPeriods-item-response"
            }
        },
        "offeringOrganizationStaff":{
            "title":"Offering Organization Staff",
            "type":"array",
            "description":"The staff associated with a curriculum item.",
            "items":{
                "$ref":"#/components/schemas/scheduledCourses-offeringOrganizationStaff-item-response"
            }
        },
        "offeringResultSets":{
            "title":"Results",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/scheduledCourses-offeringResultSets-item-response"
            }
        },
        "offeringStorefronts":{
            "title":"Offering Storefronts",
            "type":"array",
            "description":"Storefronts organize curriculum items into groups that can be presented with different branding to different audiences.",
            "items":{
                "$ref":"#/components/schemas/scheduledCourses-offeringStorefronts-item-response"
            }
        }
    }
}

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

Array of: object scheduledCourses-additionalInformation-item-response

{
    "title":"Additional Information",
    "type":"array",
    "description":"The additional information resource is a child of the courses resource and provides a list of messages associated with a course.",
    "items":{
        "$ref":"#/components/schemas/scheduledCourses-additionalInformation-item-response"
    }
}

Nested Schema : Fees

Type: array

Title: Fees

The fees resource is a child of the scheduled courses resource and provides a list of fees associated with a scheduled course.

Show Source

Array of: object scheduledCourses-fees-item-response

{
    "title":"Fees",
    "type":"array",
    "description":"The fees resource is a child of the scheduled courses resource and provides a list of fees associated with a scheduled course.",
    "items":{
        "$ref":"#/components/schemas/scheduledCourses-fees-item-response"
    }
}

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

Array of: object scheduledCourses-images-item-response

{
    "title":"Images",
    "type":"array",
    "description":"The images resource is a child of the courses resource and provides a list of image attachments associated with a course.",
    "items":{
        "$ref":"#/components/schemas/scheduledCourses-images-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Meeting Dates

Type: array

Title: Meeting Dates

The meeting dates resource is a child of the scheduled courses resource and provides a list of meetings associated with a scheduled course.

Show Source

Array of: object scheduledCourses-meetingDates-item-response

{
    "title":"Meeting Dates",
    "type":"array",
    "description":"The meeting dates resource is a child of the scheduled courses resource and provides a list of meetings associated with a scheduled course.",
    "items":{
        "$ref":"#/components/schemas/scheduledCourses-meetingDates-item-response"
    }
}

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

Array of: object scheduledCourses-meetingPatterns-item-response

{
    "title":"Meeting Patterns",
    "type":"array",
    "description":"The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.",
    "items":{
        "$ref":"#/components/schemas/scheduledCourses-meetingPatterns-item-response"
    }
}

Nested Schema : Offering Academic Periods

Type: array

Title: Offering Academic Periods

The offering academic periods resource is a child of the scheduled courses resource and provides a list of academic periods associated with a scheduled course.

Show Source

Array of: object scheduledCourses-offeringAcademicPeriods-item-response

{
    "title":"Offering Academic Periods",
    "type":"array",
    "description":"The offering academic periods resource is a child of the scheduled courses resource and provides a list of academic periods associated with a scheduled course.",
    "items":{
        "$ref":"#/components/schemas/scheduledCourses-offeringAcademicPeriods-item-response"
    }
}

Nested Schema : Offering Organization Staff

Type: array

Title: Offering Organization Staff

The staff associated with a curriculum item.

Show Source

Array of: object scheduledCourses-offeringOrganizationStaff-item-response

{
    "title":"Offering Organization Staff",
    "type":"array",
    "description":"The staff associated with a curriculum item.",
    "items":{
        "$ref":"#/components/schemas/scheduledCourses-offeringOrganizationStaff-item-response"
    }
}

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

Array of: object scheduledCourses-offeringResultSets-item-response

{
    "title":"Results",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/scheduledCourses-offeringResultSets-item-response"
    }
}

Nested Schema : Offering Storefronts

Type: array

Title: Offering Storefronts

Storefronts organize curriculum items into groups that can be presented with different branding to different audiences.

Show Source

Array of: object scheduledCourses-offeringStorefronts-item-response

{
    "title":"Offering Storefronts",
    "type":"array",
    "description":"Storefronts organize curriculum items into groups that can be presented with different branding to different audiences.",
    "items":{
        "$ref":"#/components/schemas/scheduledCourses-offeringStorefronts-item-response"
    }
}

Nested Schema : scheduledCourses-additionalInformation-item-response

Type: object

Show Source

CurriculumMessageId: integer (int64)

Title: Curriculum Message ID

Read Only: true

The unique identifier for the additional information of the course.
links: array Links

Title: Links

The link relations associated with the resource instance.
MessageSequenceNumber: integer

Title: Message Sequence Number

Read Only: true

The sequence number for the additional information of the course.
MessageSortNumber: integer (int32)

Title: Sort Number

Read Only: true

The unique sort identifier for the additional information of the course.
MessageText: string

Title: Text

Read Only: true

The text for the additional information of the course.
MessageTypeCode: string

Title: Type

Read Only: true

Maximum Length: 30

Default Value: GEN

The message type of the additional information of the course.
MessageTypeMeaning: string

Title: Message Type Meaning

Read Only: true

Maximum Length: 80

The description of the additional information type of the course.

{
    "type":"object",
    "properties":{
        "CurriculumMessageId":{
            "title":"Curriculum Message ID",
            "type":"integer",
            "description":"The unique identifier for the additional information of the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MessageSequenceNumber":{
            "title":"Message Sequence Number",
            "type":"integer",
            "description":"The sequence number for the additional information of the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MessageSortNumber":{
            "title":"Sort Number",
            "type":"integer",
            "description":"The unique sort identifier for the additional information of the course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MessageText":{
            "title":"Text",
            "type":"string",
            "description":"The text for the additional information of the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The message type of the additional information of the course.",
            "nullable":false,
            "readOnly":true,
            "default":"GEN",
            "x-queryable":true
        },
        "MessageTypeMeaning":{
            "title":"Message Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The description of the additional information type of the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : scheduledCourses-fees-item-response

Type: object

Show Source

AcademicOrgId: integer (int64)

Title: Academic Organization ID

Read Only: true

The unique identifier of the academic organization associated with the fee of the scheduled course.
CurrencyCode: string

Title: Currency Code

Read Only: true

Maximum Length: 15

The unique identifier of the flat amount charge of a scheduled course.
CurrencySymbol: string

Title: Currency Symbol

Read Only: true

Maximum Length: 12

The denomination of the flat amount charge of a scheduled course.
FeeId: integer (int64)

Title: Fee ID

Read Only: true

The unique identifier of the fee of the scheduled course.
FeeName: string

Title: Fee Name

Read Only: true

Maximum Length: 50

The name of the fee of the scheduled course.
FlatAmount: number

Title: Amount

Read Only: true

The numeric value of the flat amount charge of a scheduled course.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The unique identifier of the academic organization associated with the fee of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "maxLength":12,
            "type":"string",
            "description":"The denomination of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"The unique identifier of the fee of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FeeName":{
            "title":"Fee Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the fee of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlatAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The numeric value of the flat amount charge of a scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":2
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : scheduledCourses-images-item-response

Type: object

Show Source

ImageContent: string (byte)

Title: Attachment Content

Read Only: true

The content of the attachment associated with the course.
ImageContextCode: string

Title: Curriculum Attachment Context

Read Only: true

Maximum Length: 30

The context name of the attachment associated with the course.
ImageId: integer (int64)

Title: Curriculum Attachment ID

Read Only: true

The unique identifier of the attachment associated with the course.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The content of the attachment associated with the course.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ImageContextCode":{
            "title":"Curriculum Attachment Context",
            "maxLength":30,
            "type":"string",
            "description":"The context name of the attachment associated with the course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImageId":{
            "title":"Curriculum Attachment ID",
            "type":"integer",
            "description":"The unique identifier of the attachment associated with the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : scheduledCourses-meetingDates-item-response

Type: object

Show Source

AcademicPeriodFirstDateTime: string (date-time)

Title: Start of Date Range

Read Only: true

The earliest date of the scheduled meeting period attribute of the academic period associated with the scheduled course.
AcademicPeriodSecondDateTime: string (date-time)

Title: End of Range Date

Read Only: true

The latest date of the scheduled meeting period attribute of the academic period associated with the scheduled course.
CurriculumDateId: integer (int64)

Title: Curriculum Date ID

Read Only: true

The generated primary key column for a curriculum date.
CurriculumScheduleId: integer (int64)

Title: Schedule ID

Read Only: true

The generated primary key column for a meeting pattern of the scheduled course.
FacilityDescription: string

Title: Description

Read Only: true

Maximum Length: 240

The description of the facility associated with the scheduled course.
FacilityRoomNumber: string

Title: Room Number

Read Only: true

Maximum Length: 10

The unique identifier of a room within a building.
FacilityShortCode: string

Title: Facility

Read Only: true

Maximum Length: 20

The unique identifier of a building code and room number that identifies the location of the scheduled course.
links: array Links

Title: Links

The link relations associated with the resource instance.
MeetingDateDescription: string

Title: Date Description

Read Only: true

Maximum Length: 240

The description of a date or date range associated with a scheduled course, such as lecture or field trip.
MeetingDateSequenceNumber: integer

Title: Meeting Date Sequence Number

Read Only: true

Default Value: 1

The date sequence number for scheduled course.
MeetingDateStatusCode: string

Title: Date Status Code

Read Only: true

Maximum Length: 30

Default Value: PND

The status code for a date range associated with a scheduled course.

{
    "type":"object",
    "properties":{
        "AcademicPeriodFirstDateTime":{
            "title":"Start of Date Range",
            "type":"string",
            "description":"The earliest date of the scheduled meeting period attribute of the academic period associated with the scheduled course.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodSecondDateTime":{
            "title":"End of Range Date",
            "type":"string",
            "description":"The latest date of the scheduled meeting period attribute of the academic period associated with the scheduled course.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumDateId":{
            "title":"Curriculum Date ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum date.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CurriculumScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "description":"The generated primary key column for a meeting pattern of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FacilityDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the facility associated with the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityRoomNumber":{
            "title":"Room Number",
            "maxLength":10,
            "type":"string",
            "description":"The unique identifier of a room within a building.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityShortCode":{
            "title":"Facility",
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of a building code and room number that identifies the location of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingDateDescription":{
            "title":"Date Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of a date or date range associated with a scheduled course, such as lecture or field trip.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingDateSequenceNumber":{
            "title":"Meeting Date Sequence Number",
            "type":"integer",
            "description":"The date sequence number for scheduled course.",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-queryable":false
        },
        "MeetingDateStatusCode":{
            "title":"Date Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code for a date range associated with a scheduled course.",
            "nullable":false,
            "readOnly":true,
            "default":"PND",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : scheduledCourses-meetingPatterns-item-response

Type: object

Show Source

BuildingName: string

Title: Name

Read Only: true

Maximum Length: 50

The name of the building associated with the meeting pattern of the scheduled course.
BuildingShortCode: string

Title: Code

Read Only: true

Maximum Length: 6

The unique identifier of the building associated with the meeting pattern of the scheduled course.
CurriculumScheduleId: integer (int64)

Title: Schedule ID

Read Only: true

The generated primary key column for a meeting pattern of the scheduled course.
DurationQuantity: integer (int32)

Title: Duration

Read Only: true

The numeric value that indicates the length of a meeting of the scheduled course.
FacilityDescription: string

Title: Description

Read Only: true

Maximum Length: 240

The description of the meeting pattern of the scheduled course.
FacilityRoomNumber: string

Title: Room Number

Read Only: true

Maximum Length: 10

The room number associated with the meeting pattern of the scheduled course.
FacilityShortCode: string

Title: Facility

Read Only: true

Maximum Length: 20

The identifier of the facility associated with the meeting pattern of the scheduled course.
InstructionalMethodCode: string

Title: Instructional Method Code

Read Only: true

Maximum Length: 30

The instructional method code of the meeting.
InstructionalMethodMeaning: string

Title: Instructional Method

Read Only: true

Maximum Length: 80

The instructional method meaning of the meeting.
links: array Links

Title: Links

The link relations associated with the resource instance.
LocationControlCode: string

Title: Location Control Code

Read Only: true

Maximum Length: 30

Default Value: ORA_USE_FACILITY

The unique identifier of the single use location associated with the meeting pattern of the scheduled course.
LocationLatitude: number

Title: Latitude

Read Only: true

The GPS latitude coordinates for the scheduled course meeting location.
LocationLongitude: number

Title: Longitude

Read Only: true

The GPS longitude coordinates for the scheduled course meeting location.
LocationLongName: string

Title: Location Long Name

Read Only: true

The name of the single use location associated with the meeting pattern of the scheduled course.
MeetingPatternDescription: string

Title: Pattern Name

Read Only: true

Maximum Length: 50

The name of the meeting pattern of the scheduled course.
MeetingPatternEndDate: string (date)

Title: End Date

Read Only: true

The date when the meeting pattern of the scheduled course ends.
MeetingPatternEndTime: string (date-time)

Title: End Time

Read Only: true

The time when the meeting pattern of the scheduled course ends.
MeetingPatternName: string

Title: Meeting Name

Read Only: true

Maximum Length: 50

The meeting name of the course scheduled in the facility.
MeetingPatternStartDate: string (date)

Title: Start Date

Read Only: true

The date when the meeting pattern of the scheduled course starts.
MeetingPatternStartTime: string (date-time)

Title: Start Time

Read Only: true

The time when the meeting pattern of the scheduled course starts.
RecurrenceDayFriFlag: boolean

Title: Friday

Read Only: true

Maximum Length: 1

Default Value: false

The unique identifier for the day of the week Friday.
RecurrenceDayMonFlag: boolean

Title: Monday

Read Only: true

Maximum Length: 1

Default Value: false

The unique identifier for the day of the week Monday.
RecurrenceDaySatFlag: boolean

Title: Saturday

Read Only: true

Maximum Length: 1

Default Value: false

The unique identifier for the day of the week Saturday.
RecurrenceDaySunFlag: boolean

Title: Sunday

Read Only: true

Maximum Length: 1

Default Value: false

The unique identifier for the day of the week Sunday.
RecurrenceDayThuFlag: boolean

Title: Thursday

Read Only: true

Maximum Length: 1

Default Value: false

The unique identifier for the day of the week Thursday.
RecurrenceDayTueFlag: boolean

Title: Tuesday

Read Only: true

Maximum Length: 1

Default Value: false

The unique identifier for the day of the week Tuesday.
RecurrenceDayWedFlag: boolean

Title: Wednesday

Read Only: true

Maximum Length: 1

Default Value: false

The unique identifier for the day of the week Wednesday.
ScheduleSequenceNumber: integer (int32)

Title: Schedule Sequence Number

Read Only: true

The sequence identifier of the meeting pattern of the scheduled course.

{
    "type":"object",
    "properties":{
        "BuildingName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the building associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingShortCode":{
            "title":"Code",
            "maxLength":6,
            "type":"string",
            "description":"The unique identifier of the building associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurriculumScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "description":"The generated primary key column for a meeting pattern of the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DurationQuantity":{
            "title":"Duration",
            "type":"integer",
            "description":"The numeric value that indicates the length of a meeting of the scheduled course.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "FacilityDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityRoomNumber":{
            "title":"Room Number",
            "maxLength":10,
            "type":"string",
            "description":"The room number associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FacilityShortCode":{
            "title":"Facility",
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the facility associated with the meeting pattern of the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionalMethodCode":{
            "title":"Instructional Method Code",
            "maxLength":30,
            "type":"string",
            "description":"The instructional method code of the meeting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstructionalMethodMeaning":{
            "title":"Instructional Method",
            "maxLength":80,
            "type":"string",
            "description":"The instructional method meaning of the meeting.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationControlCode":{
            "title":"Location Control Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_USE_FACILITY",
            "x-queryable":true
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The GPS latitude coordinates for the scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "LocationLongName":{
            "title":"Location Long Name",
            "type":"string",
            "description":"The name of the single use location associated with the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The GPS longitude coordinates for the scheduled course meeting location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":38,
                "scale":5
            },
            "x-queryable":true
        },
        "MeetingPatternDescription":{
            "title":"Pattern Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the meeting pattern of the scheduled course.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternName":{
            "title":"Meeting Name",
            "maxLength":50,
            "type":"string",
            "description":"The meeting name of the course scheduled in the facility.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the meeting pattern of the scheduled course starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeetingPatternStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The time when the meeting pattern of the scheduled course starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"TimeFrom-TimeTo",
                "customLinks":"true",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"80",
                "facetControl":"timeRange",
                "title":"Start Date",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayFriFlag":{
            "title":"Friday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Friday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Friday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnFri",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayMonFlag":{
            "title":"Monday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Monday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Monday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnMon",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDaySatFlag":{
            "title":"Saturday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Saturday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Saturday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnSat",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDaySunFlag":{
            "title":"Sunday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Sunday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Sunday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnSun",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayThuFlag":{
            "title":"Thursday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Thursday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Thursday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnThu",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayTueFlag":{
            "title":"Tuesday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Tuesday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Tuesday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnTue",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "RecurrenceDayWedFlag":{
            "title":"Wednesday",
            "maxLength":1,
            "type":"boolean",
            "description":"The unique identifier for the day of the week Wednesday.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "displayValue":"Wednesday",
                "facetDiscriminatorValue":"COURSE:SECTION",
                "queryAttribute":"OnWed",
                "facetGroup":"dayOfWeek",
                "facetDiscriminatorName":"CurriculumType",
                "sortNumber":"70",
                "facetControl":"multiSelectBoolean",
                "queryType":"finder"
            },
            "x-queryable":true
        },
        "ScheduleSequenceNumber":{
            "title":"Schedule Sequence Number",
            "type":"integer",
            "description":"The sequence identifier of the meeting pattern of the scheduled course.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : scheduledCourses-offeringAcademicPeriods-item-response

Type: object

Show Source

AcademicPeriodCategoryCode: string

Title: Category

Read Only: true

Maximum Length: 30

The category code of the period type. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.
AcademicPeriodEndDate: string (date)

Title: End Date

Read Only: true

The date when the academic period associated with the scheduled course ends.
AcademicPeriodId: integer (int64)

Title: Academic Period ID

Read Only: true

The unique identifier for the academic period associated with the scheduled course.
AcademicPeriodName: string

Title: Period Name

Read Only: true

Maximum Length: 50

The name of the academic period associated with the scheduled course.
AcademicPeriodStartDate: string (date)

Title: Start Date

Read Only: true

The date when the academic period associated with the scheduled course starts.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AcademicPeriodCategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category code of the period type. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the academic period associated with the scheduled course ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier for the academic period associated with the scheduled course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Period Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic period associated with the scheduled course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the academic period associated with the scheduled course starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : scheduledCourses-offeringOrganizationStaff-item-response

Type: object

Show Source

CurriculumStaffId: integer (int64)

Title: Curriculum Staff ID

Read Only: true

The generated primary key column for a curriculum staff record.
links: array Links

Title: Links

The link relations associated with the resource instance.
PersonAcademicTitle: string

Title: Academic Title

Read Only: true

Maximum Length: 30

The academic title of the staff member associated with the curriculum item.
PersonImageContent: string (byte)

Title: Staff Image

Read Only: true

The content of a staff attachment such as an image file.
PersonImageId: integer (int64)

Title: Attachment ID

Read Only: true

A unique identifier for an attachment associated with a curriculum item.
PersonName: string

Title: Name

Read Only: true

Maximum Length: 450

The name of the staff member associated with the curriculum item.
PersonTitle: string

Title: Title

Read Only: true

Maximum Length: 60

The title of the staff member associated with the curriculum item.
StaffBiography: string

Title: Biography

Read Only: true

The text providing biographical or background information on a staff member.
StaffPrimaryFlag: boolean

Title: Primary

Read Only: true

Maximum Length: 1

Identifies the primary staff member for a curriculum item. When yes, the staff row is considered the primary staff resource for the curriculum item. The default value is false. If only one record exists, the default value is true.
StaffRoleTypeCode: string

Title: Role Type

Read Only: true

Maximum Length: 30

The role type of the staff member associated with the curriculum item. An example is instructor. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
StaffRoleTypeMeaning: string

Title: Role Meaning

Read Only: true

Maximum Length: 80

The meaning of the role type of the staff member associated with the curriculum item. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
StaffSequenceNumber: integer (int32)

Title: Staff Sequence Number

Read Only: true

The sequence number of a staff row associated with a curriculum item.

{
    "type":"object",
    "properties":{
        "CurriculumStaffId":{
            "title":"Curriculum Staff ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum staff record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PersonAcademicTitle":{
            "title":"Academic Title",
            "maxLength":30,
            "type":"string",
            "description":"The academic title of the staff member associated with the curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonImageContent":{
            "title":"Staff Image",
            "type":"string",
            "description":"The content of a staff attachment such as an image file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonImageId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"A unique identifier for an attachment associated with a curriculum item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the staff member associated with the curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the staff member associated with the curriculum item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffBiography":{
            "title":"Biography",
            "type":"string",
            "description":"The text providing biographical or background information on a staff member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffPrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Identifies the primary staff member for a curriculum item. When yes, the staff row is considered the primary staff resource for the curriculum item. The default value is false. If only one record exists, the default value is true.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffRoleTypeCode":{
            "title":"Role Type",
            "maxLength":30,
            "type":"string",
            "description":"The role type of the staff member associated with the curriculum item. An example is instructor. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffRoleTypeMeaning":{
            "title":"Role Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the role type of the staff member associated with the curriculum item. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffSequenceNumber":{
            "title":"Staff Sequence Number",
            "type":"integer",
            "description":"The sequence number of a staff row associated with a curriculum item.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : scheduledCourses-offeringResultSets-item-response

Type: object

Show Source

CurriculumResultId: integer (int64)

Title: Curriculum Result ID

Read Only: true

The generated primary key column for a curriculum result record.
DefaultResultSetFlag: boolean

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: array Links

Title: Links

The link relations associated with the resource instance.
ResultSetCode: string

Title: Result Set Code

Read Only: true

Maximum Length: 30

The code of the result set associated with the course.
ResultSetId: integer (int64)

Title: Result Set ID

Read Only: true

The unique identifier of the result set associated with the course.
ResultSetName: string

Title: Result Set Name

Read Only: true

Maximum Length: 50

The name of the result set associated with the course.
ResultTypeCode: string

Title: Result Type Code

Read Only: true

Maximum Length: 30

The code of the result type associated with the course.
ResultTypeId: integer (int64)

Title: Result Type ID

Read Only: true

The unique identifier of the result type associated with the course.
ResultTypeName: string

Title: Result Type Name

Read Only: true

Maximum Length: 50

The name of the result type associated with the course.

{
    "type":"object",
    "properties":{
        "CurriculumResultId":{
            "title":"Curriculum Result ID",
            "type":"integer",
            "description":"The generated primary key column for a curriculum result record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DefaultResultSetFlag":{
            "title":"Default Result Set Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the result set row is the default for the course. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetCode":{
            "title":"Result Set Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the result set associated with the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetId":{
            "title":"Result Set ID",
            "type":"integer",
            "description":"The unique identifier of the result set associated with the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResultSetName":{
            "title":"Result Set Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the result set associated with the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultTypeCode":{
            "title":"Result Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the result type associated with the course.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResultTypeId":{
            "title":"Result Type ID",
            "type":"integer",
            "description":"The unique identifier of the result type associated with the course.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResultTypeName":{
            "title":"Result Type Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the result type associated with the course.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : scheduledCourses-offeringStorefronts-item-response

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.
StorefrontId: integer (int64)

Title: Storefront ID

Read Only: true

The unique identifier for the offering storefront.
StorefrontName: string

Title: Storefront Name

Read Only: true

The name of the offering storefront.

{
    "type":"object",
    "properties":{
        "StorefrontId":{
            "title":"Storefront ID",
            "type":"integer",
            "description":"The unique identifier for the offering storefront.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StorefrontName":{
            "title":"Storefront Name",
            "type":"string",
            "description":"The name of the offering storefront.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "StorefrontId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}