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 Unique identifier for the scheduled course.
Finder Variables- CurriculumHeaderId; integer; The unique identifier for a curriculum header record.
- SearchableFinder Finds all scheduled courses that match the primary key criteria specified.
Finder Variables - SponsoredCourseFinder Finds all scheduled courses which are sponsored.
Finder Variables
- PrimaryKey Unique identifier for the scheduled course.
-
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; Unique identifier for the offering organization staff.
- 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 unique identifier of the credit type associated with the scheduled course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
- 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 unique identifier for the format of the scheduled course. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
- 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 a scheduled course ends.
- ScheduledCourseNumber; integer; A generated, alternate identifier for a scheduled course.
- ScheduledCourseStartDate; string; The date when a scheduled course starts.
- StudentRequestConsentFlag; boolean; The code used to identify a scheduled course within a given course and academic period.
- 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:
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:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : scheduledCourses-item-response
Type:
Show Source
object
-
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
Unique identifier for the offering organization staff. -
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 unique identifier of the credit type associated with the scheduled course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
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 unique identifier for the format of the scheduled course. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
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 programs resource and provides a list of image attachments for a program. -
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 offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program. -
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
The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program. -
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 a scheduled course ends. -
ScheduledCourseNumber: integer
(int32)
Title:
Scheduled Course Number
Read Only:true
A generated, alternate identifier for a scheduled course. -
ScheduledCourseStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The date when a scheduled course starts. -
StudentRequestConsentFlag: boolean
Title:
Allow permission request
Read Only:true
Maximum Length:1
Default Value:false
The code used to identify a scheduled course within a given course and academic period. -
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.
Nested Schema : Additional Information
Type:
array
Title:
Additional Information
The additional information resource is a child of the courses resource and provides a list of messages associated with a course.
Show Source
Nested Schema : 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
Nested Schema : Images
Type:
array
Title:
Images
The images resource is a child of the programs resource and provides a list of image attachments for a program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : Meeting Patterns
Type:
array
Title:
Meeting Patterns
The meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course.
Show Source
Nested Schema : Offering 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
Nested Schema : Offering Organization Staff
Type:
array
Title:
Offering Organization Staff
The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.
Show Source
Nested Schema : Results
Type:
array
Title:
Results
The results resource is a child of the course offerings resource and provides a list of result type and result set combinations associated with the course offering.
Show Source
Nested Schema : Offering Storefronts
Type:
array
Title:
Offering Storefronts
The offering storefronts resource is a child of the programs resource and provides a list of offering storefronts associated with a program.
Show Source
Nested Schema : scheduledCourses-additionalInformation-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageSequenceNumber: integer
Title:
Message Sequence Number
Read Only:true
The unique identifier 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : scheduledCourses-fees-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : scheduledCourses-images-item-response
Type:
Show Source
object
-
ImageContent: string
(byte)
Title:
Attachment Content
Read Only:true
The image associated with the program. -
ImageContextCode: string
Title:
Curriculum Attachment Context
Read Only:true
Maximum Length:30
The context or usage of the image associated with the program. Valid values include ORA_MOBILE, ORA_STANDARD, or ORA_THUMB. A list of accepted values is defined in the lookup type ORA_HER_ATTACHMENT_CONTEXT. -
ImageId: integer
(int64)
Title:
Curriculum Attachment ID
Read Only:true
A unique identifier for the image associated with the program. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : scheduledCourses-meetingDates-item-response
Type:
Show Source
object
-
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)
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
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : scheduledCourses-meetingPatterns-item-response
Type:
Show Source
object
-
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)
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
Read Only:
true
Maximum Length:30
The instructional method code of the meeting. -
InstructionalMethodMeaning: string
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : scheduledCourses-offeringAcademicPeriods-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : scheduledCourses-offeringOrganizationStaff-item-response
Type:
Show Source
object
-
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 program staff person. -
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 program. -
PersonName: string
Title:
Name
Read Only:true
Maximum Length:450
The name of a program staff person. -
PersonTitle: string
Title:
Title
Read Only:true
Maximum Length:60
The title of the program staff person. -
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 program. When yes, the staff row is considered the primary staff resource for the program. The default value is false. If only one record exists, the default value is true. -
StaffRoleTypeCode: string
Title:
Role Type
Read Only:true
Maximum Length:30
A code identifying the role of a program staff member. 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 code of the program staff member. 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 program.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : scheduledCourses-offeringResultSets-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : scheduledCourses-offeringStorefronts-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source