Get all scheduled courses of a student
get
/fscmRestApi/resources/11.13.18.05/studentScheduledCourses
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- EnrollmentId; integer; Unique identifier for a scheduled course of a student.
- PrimaryKey Finds all scheduled courses that match the primary key criteria specified.
-
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 the academic level associated with a curriculum item.
- AcademicLevelName; string; The name for an academic level such as undergraduate.
- AcademicPeriodEndDate; string; The date when an academic period associated with a scheduled course ends.
- AcademicPeriodId; integer; The generated primary key column for an academic period.
- AcademicPeriodName; string; The name of the academic period associated with a student enrollment record.
- AcademicPeriodStartDate; string; The date when the academic period associated with a scheduled course starts.
- AttachmentId; integer; The unique identifier of the course image associated with the scheduled course enrollment record.
- BillingUnitQuantity; number; The amount billed for the scheduled course during enrollment.
- CampusId; integer; The unique identifier of the campus associated with the scheduled course enrollment record.
- ClassEndDate; string; The scheduled course end date calculated during enrollment.
- ClassStartDate; string; The scheduled course start date calculated during enrollment.
- CurriculumAttachmentId; integer; The generated primary key column for a curriculum attachment.
- CurriculumHeaderId; integer; The generated primary key column for a curriculum header row, which is the record that's shared across curriculum item types.
- CurriculumId; integer; The scheduled course associated with the scheduled course enrollment record.
- CurriculumName; string; The course name associated with the scheduled course enrollment record.
- CurriculumType; string; The code value of the curriculum type related to the scheduled course enrollment record.
- CurriculumTypeId; integer; The unique identifier of the curriculum type related to the scheduled course enrollment record.
- DropDate; string; The date when the student dropped the scheduled course.
- DropEnabledFlag; boolean; Indicates if the scheduled course can be dropped.
- EnrolledCreditQuantity; number; The enrolled credit quantity calculated during enrollment.
- EnrollmentDate; string; The date when the student enrolled in the scheduled course.
- EnrollmentId; integer; The generated primary key column for a scheduled course of a student.
- EnrollmentStatusCode; string; A code indicating a student's enrollment status for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.
- EnrollmentStatusMeaning; string; The meaning of the code indicating a student's enrollment status for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS.
- InstitutionId; integer; The unique identifier of the institution associated with the scheduled course enrollment record.
- LastActionReasonId; integer; The unique identifier of the action reason associated with the scheduled course enrollment record.
- LastActionType; string; The action associated with the scheduled course enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE.
- LastDateToDrop; string; The last date when a student can drop a scheduled course.
- LastDateToDropWithGreaterPenalty; string; The last date when a student can withdraw from a scheduled course with greater penalty.
- LastDateToDropWithPenalty; string; The last date when a student can withdraw from a scheduled course with penalty.
- LastDateToDropWithRetain; string; The last date when a student can drop a scheduled course and the student enrollment record will be retained.
- LastDateToDropWithoutRetain; string; The last date when a student can drop a scheduled course and the student enrollment record won't be retained.
- LastUpdateDate; string; The date the row was last updated.
- OwningCurriculumId; integer; The unique identifier of the course associated with the scheduled course enrollment record.
- PeriodCategoryCode; string; The period category code associated with the academic period of a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.
- PeriodCategoryMeaning; string; The meaning of the period category code associated with the academic period of a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.
- ReportingPeriodEndDate; string; The date when the reporting period associated with a scheduled course ends.
- ReportingPeriodId; integer; The generated primary key column for a reporting period.
- ReportingPeriodName; string; The name of the reporting period associated with a student enrollment record.
- ReportingPeriodStartDate; string; The date when the reporting period associated with a scheduled course starts.
- RequisiteStatusCode; string; A code indicating a student's requisite status for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_STATUS_CODE.
- RequisiteStatusMeaning; string; The meaning of the code indicating a student's requisite status for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_STATUS_CODE.
- ResultSetCode; string; The result set code associated with the scheduled course at the time of enrollment.
- ResultSetId; integer; The unique identifier for a result set associated with the scheduled course at the time of enrollment. Use result sets to support various types of measurement such as grades, units, and grade points.
- ResultSetName; string; The result set name associated with the scheduled course at the time of enrollment. An example is Letter Grade.
- SelfPacedFlag; boolean; Indicates if the scheduled course is self-paced. The default value is false.
- StudentPartyId; integer; The unique identifier of the student associated with the scheduled course enrollment record.
-
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 : studentScheduledCourses
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 : studentScheduledCourses-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
The unique identifier for the academic level associated with a curriculum item.
-
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name for an academic level such as undergraduate. -
AcademicPeriodEndDate: string
(date)
Title:
Academic Period End Date
Read Only:true
The date when an academic period associated with a scheduled course ends. -
AcademicPeriodId: integer
(int64)
Title:
Academic Period ID
Read Only:true
The generated primary key column for an academic period. -
AcademicPeriodName: string
Title:
Academic Period Name
Read Only:true
Maximum Length:50
The name of the academic period associated with a student enrollment record. -
AcademicPeriodStartDate: string
(date)
Title:
Academic Period Start Date
Read Only:true
The date when the academic period associated with a scheduled course starts. -
AttachmentId: integer
(int64)
Title:
Curriculum Attachment ID
Read Only:true
The unique identifier of the course image associated with the scheduled course enrollment record. -
BillingUnitQuantity: number
Title:
Billing Units
Read Only:true
Default Value:0
The amount billed for the scheduled course during enrollment. -
CampusId: integer
(int64)
Title:
Campus ID
Read Only:true
The unique identifier of the campus associated with the scheduled course enrollment record. -
ClassEndDate: string
(date)
Title:
Student End Date
Read Only:true
The scheduled course end date calculated during enrollment. -
ClassStartDate: string
(date)
Title:
Student Start Date
Read Only:true
The scheduled course start date calculated during enrollment. -
controlDates: array
Control Dates
Title:
Control Dates
The control dates resource is a child of the student scheduled course resource and provides a list of enrollment related dates associated with a scheduled course. -
CurriculumAttachmentId: integer
(int64)
Read Only:
true
The generated primary key column for a curriculum attachment. -
CurriculumHeaderId: integer
(int64)
Read Only:
true
The generated primary key column for a curriculum header row, which is the record that's shared across curriculum item types. -
CurriculumId: integer
(int64)
Title:
Scheduled Course
Read Only:true
The scheduled course associated with the scheduled course enrollment record. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
The course name associated with the scheduled course enrollment record. -
CurriculumType: string
Title:
Curriculum Item Type
Read Only:true
Maximum Length:30
The code value of the curriculum type related to the scheduled course enrollment record. -
CurriculumTypeId: integer
(int64)
Title:
Curriculum Type
Read Only:true
The unique identifier of the curriculum type related to the scheduled course enrollment record. -
DropDate: string
(date)
Title:
Drop Date
Read Only:true
The date when the student dropped the scheduled course. -
DropEnabledFlag: boolean
Title:
Drop Enabled
Read Only:true
Indicates if the scheduled course can be dropped. -
EnrolledCreditQuantity: number
Title:
Units
Read Only:true
The enrolled credit quantity calculated during enrollment. -
EnrollmentDate: string
(date)
Title:
Enrollment Date
Read Only:true
The date when the student enrolled in the scheduled course. -
EnrollmentId: integer
(int64)
Title:
Student Curriculum Item ID
Read Only:true
The generated primary key column for a scheduled course of a student. -
EnrollmentStatusCode: string
Title:
Enrollment Status
Maximum Length:30
A code indicating a student's enrollment status for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS. -
EnrollmentStatusMeaning: string
Title:
Enrollment Status Meaning
Read Only:true
Maximum Length:80
The meaning of the code indicating a student's enrollment status for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS. -
InstitutionId: integer
(int64)
Title:
Institution ID
Read Only:true
The unique identifier of the institution associated with the scheduled course enrollment record. -
LastActionReasonId: integer
(int64)
Title:
Last Action Reason ID
Read Only:true
The unique identifier of the action reason associated with the scheduled course enrollment record. -
LastActionType: string
Title:
Last Action
Read Only:true
Maximum Length:30
The action associated with the scheduled course enrollment record. A list of accepted values is defined in the lookup type ORA_HER_ACTION_TYPE. -
LastDateToDrop: string
(date-time)
Title:
Last Date to Drop
Read Only:true
The last date when a student can drop a scheduled course. -
LastDateToDropWithGreaterPenalty: string
(date-time)
Title:
Last Date to Drop with Greater Penalty
Read Only:true
The last date when a student can withdraw from a scheduled course with greater penalty. -
LastDateToDropWithoutRetain: string
(date-time)
Title:
Last Date to Drop: Delete Record
Read Only:true
The last date when a student can drop a scheduled course and the student enrollment record won't be retained. -
LastDateToDropWithPenalty: string
(date-time)
Title:
Last Date to Drop: Withdrew with Penalty
Read Only:true
The last date when a student can withdraw from a scheduled course with penalty. -
LastDateToDropWithRetain: string
(date-time)
Title:
Last Date to Drop: Retain Record
Read Only:true
The last date when a student can drop a scheduled course and the student enrollment record will be retained. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwningCurriculumId: integer
(int64)
Title:
Owning Course Curriculum ID
Read Only:true
The unique identifier of the course associated with the scheduled course enrollment record. -
PeriodCategoryCode: string
Title:
Period Category
Read Only:true
Maximum Length:30
The period category code associated with the academic period of a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE. -
PeriodCategoryMeaning: string
Title:
Period Category Meaning
Read Only:true
Maximum Length:80
The meaning of the period category code associated with the academic period of a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE. -
ReportingPeriodEndDate: string
(date)
Title:
Reporting Period End Date
Read Only:true
The date when the reporting period associated with a scheduled course ends. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period ID
Read Only:true
The generated primary key column for a reporting period. -
ReportingPeriodName: string
Title:
Reporting Period Name
Read Only:true
Maximum Length:50
The name of the reporting period associated with a student enrollment record. -
ReportingPeriodStartDate: string
(date)
Title:
Reporting Period Start Date
Read Only:true
The date when the reporting period associated with a scheduled course starts. -
RequisiteStatusCode: string
Title:
Requisite Status Code
Read Only:true
Maximum Length:30
A code indicating a student's requisite status for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_STATUS_CODE. -
RequisiteStatusMeaning: string
Title:
Requisite Status Code Meaning
Read Only:true
Maximum Length:80
The meaning of the code indicating a student's requisite status for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_STATUS_CODE. -
results: array
Results
Title:
Results
The results resource is a child of the student scheduled course resource and provides a list of results associated with a scheduled course. -
ResultSetCode: string
Title:
Code
Read Only:true
Maximum Length:30
The result set code associated with the scheduled course at the time of enrollment. -
ResultSetId: integer
(int64)
Title:
Result Set ID
Read Only:true
The unique identifier for a result set associated with the scheduled course at the time of enrollment. Use result sets to support various types of measurement such as grades, units, and grade points. -
ResultSetName: string
Title:
Name
Read Only:true
Maximum Length:50
The result set name associated with the scheduled course at the time of enrollment. An example is Letter Grade. -
scheduledCourses: array
Scheduled Courses
Title:
Scheduled Courses
The scheduled courses resource is a child of the student scheduled course resource and provides a list of scheduled courses offered by institutions. -
SelfPacedFlag: boolean
Title:
Self-Paced
Read Only:true
Maximum Length:1
Indicates if the scheduled course is self-paced. The default value is false. -
StudentPartyId: integer
(int64)
Title:
Student ID
Read Only:true
The unique identifier of the student associated with the scheduled course enrollment record.
Nested Schema : Control Dates
Type:
array
Title:
Control Dates
The control dates resource is a child of the student scheduled course resource and provides a list of enrollment related dates associated with a scheduled course.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Results
Type:
array
Title:
Results
The results resource is a child of the student scheduled course resource and provides a list of results associated with a scheduled course.
Show Source
Nested Schema : Scheduled Courses
Type:
array
Title:
Scheduled Courses
The scheduled courses resource is a child of the student scheduled course resource and provides a list of scheduled courses offered by institutions.
Show Source
Nested Schema : studentScheduledCourses-controlDates-item-response
Type:
Show Source
object
-
ControlDateId: integer
(int64)
Title:
Student Control Date Item ID
Read Only:true
The generated primary key column for a control date related to the enrollment record. -
DateTimeCode: string
Title:
Control Date Time Code
Read Only:true
Maximum Length:30
The code for the control date record. -
DateTimeMeaning: string
Title:
Attribute
Read Only:true
Maximum Length:50
The meaning of the code for the control date record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StartDateTime: string
(date-time)
Title:
Control Date Time
Read Only:true
The time stamp value of the control date. -
StatusCode: string
Title:
Control Date Status Code
Read Only:true
Maximum Length:30
Default Value:ORA_ACT
The status code associated with the control date record. Valid values include ORA_ACT, ORA_DEL, or ORA_INACT. A list of accepted values is defined in the lookup type ORA_HER_RECORD_STATUS. -
StatusMeaning: string
Title:
Control Date Status Code Meaning
Read Only:true
Maximum Length:80
The meaning of the status code associated with the control date record. Valid values include Active, Deleted, or Inactive. A list of accepted values is defined in the lookup type ORA_HER_RECORD_STATUS.
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 : studentScheduledCourses-results-item-response
Type:
Show Source
object
-
Gradepoints: number
Title:
Student Result Grade Points
Read Only:true
The grade points value of the result, such as 4.00. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumericValue: number
Title:
Numeric Result
Read Only:true
The result value in numeric format, such as a score of 95. -
OutcomeCode: string
Title:
Outcome
Read Only:true
Maximum Length:30
The code of the result outcome. An example of a result outcome is Pass. A list of accepted values is defined in the lookup type ORA_HER_OUTCOME_CODE. -
OutcomeDescription: string
Title:
Outcome Description
Read Only:true
Maximum Length:240
The description of the result outcome. -
OutcomeMeaning: string
Title:
Outcome Meaning
Read Only:true
Maximum Length:80
The meaning of the result outcome. A list of accepted values is defined in the lookup type ORA_HER_OUTCOME_CODE. -
ResultId: integer
(int64)
Title:
Result ID
Read Only:true
The generated primary key column for a result related to the enrollment record. -
ResultSetCode: string
Title:
Code
Read Only:true
Maximum Length:30
The result set code of the result. Use result sets to support various types of measurement such as grades, units, and grade points. -
ResultSetId: integer
(int64)
Title:
Result Set ID
Read Only:true
The unique identifier of the result set. Use result sets to support various types of measurement such as grades, units, and grade points. -
ResultSetName: string
Title:
Name
Read Only:true
Maximum Length:50
The result set name, such as Letter Grade, of the result. -
ResultTypeCode: string
Title:
Result Type Code
Read Only:true
Maximum Length:30
The result type code of the result. An example of a result type is Course Result. -
StatusCode: string
Title:
Result Status
Read Only:true
Maximum Length:30
The status code of the result. A list of accepted values is defined in the lookup type ORA_HER_RESULT_STATUS. -
StatusMeaning: string
Title:
Result Status Meaning
Read Only:true
Maximum Length:80
The meaning of the status code of the result. A list of accepted values is defined in the lookup type ORA_HER_RESULT_STATUS. -
TextValue: string
Title:
Text Result
Read Only:true
Maximum Length:30
The result value in text format, such as a grade of A.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentScheduledCourses-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. -
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. -
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. -
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. -
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. -
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. -
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 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 : studentScheduledCourses-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 : studentScheduledCourses-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