Get all programs
get
/fscmRestApi/resources/11.13.18.05/programs
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- AcademicGroupFinder Finds all programs that match the academic group criteria specified.
Finder Variables- AcademicGroupId; integer; Unique identifier for the academic group.
- CurriculumNameFinder Finds all programs that match the keyword specified.
Finder Variables- Keyword; string; Keyword; string; for the program.
- PrimaryKey Finds all programs that match the primary key criteria specified.
Finder Variables- CurriculumHeaderId; integer; The unique identifier for a curriculum header record.
- AcademicGroupFinder Finds all programs that match the academic group 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 an academic level value that's associated with a program.
- AcademicLevelName; string; The name of an academic level value that's associated with a program.
- AdmissionRequiredFlag; boolean; Indicates if a person must be formally admitted to a program. If yes, admission is required. If no, a person can join the program without requesting admission.
- AllAcademicGroupsFlag; boolean; Indicates whether a program can be associated with any academic group.
- AutoAdmitFlag; boolean; Indicates whether a student can be automatically admitted to a program based on a simple application.
- CampusId; integer; The unique identifier for a campus that's associated with a program.
- CampusName; string; The name of the campus where this program is offered.
- CourseSelectorEnabledFlag; boolean; Indicates that an application form is already created for this program in course selector mode.
- CredentialId; integer; The credential associated with the program.
- CredentialName; string; The name of the credential associated with the program.
- CreditTypeCode; string; A code for the type of credit used in a program. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
- CreditTypeMeaning; string; The meaning of the credit type code for a program. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE.
- CurriculumFormatCode; string; A code for the format, such as online, in which a program is offered. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
- CurriculumFormatMeaning; string; The meaning of a program format code. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE.
- CurriculumHeaderId; integer; The unique identifier for a curriculum header record.
- CurriculumId; integer; The generated primary key column for a program.
- CurriculumLongDescription; string; The long description for a program.
- CurriculumName; string; The name of a program.
- CurriculumStatusCode; string; The status code for a program.
- CurriculumTitle; string; The title or formal description of a program.
- EnforceRequirementSequenceFlag; boolean; Determines the sort order of child courses for a program. If yes, courses are sorted by sequence number. If no, courses are sorted by requirement category and sequence number.
- EnrollmentModeCode; string; The code of the enrollment mode that's used to enroll students in the program. Valid values include ORA_SCHEDULER or ORA_SHOPPING_CART. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE.
- EnrollmentModeMeaning; string; The meaning of the enrollment mode that's used to enroll students in the program. Valid values include Scheduler or Shopping Cart. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE.
- FirstAdmitDate; string; The first date when a program is available for admission.
- InstitutionId; integer; The identifier for the institution to which the program belongs.
- InstitutionName; string; The name of the institution to which the program belongs.
- IsCartableFlag; boolean; Indicates whether a program is available for the shopping cart. If yes, a user can add the program to their shopping cart. If no, the add to shopping cart option isn't available. The default value is yes.
- IsWishableFlag; boolean; Indicates whether a program can be added to a user's wish list. If yes, a user can add the program to their wish list. If no, the add to wish list option isn't available. The default value is yes.
- LastAdmitDate; string; The last date when a program is available for admission.
- MaximumTimespanMeasure; string; A unit of measure for the maximum length of time allowed to complete the program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
- MaximumTimespanMeasureMeaning; string; The meaning of the unit of measure for the maximum length of time allowed to complete the program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
- MaximumTimespanQuantity; integer; Along with the unit of measure, this defines the maximum length of time allowed to complete the program.
- PayToAccessFlag; boolean; Indicates if a program is one where a student must pay tuition or fees upfront in order to enroll in the courses that comprise this program.
- PaymentModeCode; string; The code of the payment mode that's used for the program when enrolling students. Valid values include ORA_PAY_TO_ENRL or ORA_BILL_LATER. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE.
- PaymentModeMeaning; string; The meaning of the payment mode that's used for the program when enrolling students. Valid values include Pay to enroll or Bill later. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE.
- PlanFormatId; integer; The unique identifier for a default academic plan format that's associated with the program.
- PlanFormatName; string; The name of the default academic plan format that's associated with the program.
- ProgramTypeId; integer; The unique identifier for a program type value that's associated with a program.
- ProgramTypeMainFlag; boolean; Indicates whether a program is a main program.
- ProgramTypeName; string; The name of a program type value that's associated with a program.
- TypicalTimespanMeasure; string; A code that indicates the type of units used to express the typical time duration for a program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
- TypicalTimespanMeasureMeaning; string; The meaning of the unit of measurement code for the typical duration of program, such as months or years. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE.
- TypicalTimespanQuantity; integer; The number of time span units used to express the typical duration of a program, such as 4 years.
- URLAddress; string; The URL for a web page associated with a program.
-
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:
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 : programs
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-item-response
Type:
Show Source
object-
academicGroups: array
Academic Groups
Title:
Academic GroupsThe academic groups resource is a child of the programs resource and provides a list of academic groups associated with a program. -
AcademicLevelId: integer
(int64)
Title:
Academic Level IDRead Only:trueThe unique identifier for an academic level value that's associated with a program. -
AcademicLevelName: string
Title:
Academic Level NameRead Only:trueMaximum Length:100The name of an academic level value that's associated with a program. -
additionalInformation: array
Additional Information
Title:
Additional InformationThe additional information resource is a child of the courses resource and provides a list of messages associated with a course. -
AdmissionRequiredFlag: boolean
Title:
Admission RequiredRead Only:trueMaximum Length:1Default Value:trueIndicates if a person must be formally admitted to a program. If yes, admission is required. If no, a person can join the program without requesting admission. -
AllAcademicGroupsFlag: boolean
Title:
Available to all academic groupsRead Only:trueMaximum Length:1Default Value:falseIndicates whether a program can be associated with any academic group. -
AutoAdmitFlag: boolean
Title:
Auto admitRead Only:trueMaximum Length:1Default Value:falseIndicates whether a student can be automatically admitted to a program based on a simple application. -
CampusId: integer
Title:
Campus IDRead Only:trueThe unique identifier for a campus that's associated with a program. -
CampusName: string
Title:
NameRead Only:trueThe name of the campus where this program is offered. -
CourseSelectorEnabledFlag: boolean
Read Only:
trueMaximum Length:255Indicates that an application form is already created for this program in course selector mode. -
CredentialId: integer
Title:
Program Credential IDRead Only:trueThe credential associated with the program. -
CredentialName: string
Title:
NameRead Only:trueThe name of the credential associated with the program. -
CreditTypeCode: string
Title:
Type of CreditRead Only:trueMaximum Length:30A code for the type of credit used in a program. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CreditTypeMeaning: string
Title:
Type of Credit MeaningRead Only:trueMaximum Length:80The meaning of the credit type code for a program. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CurriculumFormatCode: string
Title:
FormatRead Only:trueMaximum Length:30A code for the format, such as online, in which a program is offered. Valid values include ORA_BLD, ORA_ONL, or ORA_ONP. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
CurriculumFormatMeaning: string
Title:
Curriculum Format MeaningRead Only:trueMaximum Length:80The meaning of a program format code. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
CurriculumHeaderId: integer
(int64)
Title:
Curriculum Header IDRead Only:trueThe unique identifier for a curriculum header record. -
CurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe generated primary key column for a program. -
CurriculumLongDescription: string
Title:
Long DescriptionRead Only:trueThe long description for a program. -
CurriculumName: string
Title:
NameRead Only:trueMaximum Length:150The name of a program. -
CurriculumStatusCode: string
Title:
StatusRead Only:trueMaximum Length:30The status code for a program. -
CurriculumTitle: string
Title:
TitleRead Only:trueMaximum Length:100The title or formal description of a program. -
EnforceRequirementSequenceFlag: boolean
Title:
List by SequenceRead Only:trueMaximum Length:1Default Value:falseDetermines the sort order of child courses for a program. If yes, courses are sorted by sequence number. If no, courses are sorted by requirement category and sequence number. -
EnrollmentModeCode: string
Title:
Enrollment ModeRead Only:trueMaximum Length:30The code of the enrollment mode that's used to enroll students in the program. Valid values include ORA_SCHEDULER or ORA_SHOPPING_CART. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE. -
EnrollmentModeMeaning: string
Title:
Enrollment Mode MeaningRead Only:trueMaximum Length:80The meaning of the enrollment mode that's used to enroll students in the program. Valid values include Scheduler or Shopping Cart. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_MODE. -
fees: array
Fees
Title:
FeesThe fees resource is a child of the program elements resource and provides a list of fees for a program. -
FirstAdmitDate: string
(date)
Title:
First Admit DateRead Only:trueThe first date when a program is available for admission. -
images: array
Images
Title:
ImagesThe images resource is a child of the courses resource and provides a list of image attachments associated with a course. -
InstitutionId: integer
(int64)
Title:
InstitutionRead Only:trueThe identifier for the institution to which the program belongs. -
InstitutionName: string
Title:
InstitutionRead Only:trueMaximum Length:50The name of the institution to which the program belongs. -
IsCartableFlag: boolean
Title:
Shopping Cart EnabledRead Only:trueMaximum Length:255Indicates whether a program is available for the shopping cart. If yes, a user can add the program to their shopping cart. If no, the add to shopping cart option isn't available. The default value is yes. -
IsWishableFlag: boolean
Title:
Wish List EnabledRead Only:trueMaximum Length:255Indicates whether a program can be added to a user's wish list. If yes, a user can add the program to their wish list. If no, the add to wish list option isn't available. The default value is yes. -
LastAdmitDate: string
(date)
Title:
Last Admit DateRead Only:trueThe last date when a program is available for admission. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumTimespanMeasure: string
Title:
Maximum DurationRead Only:trueMaximum Length:30A unit of measure for the maximum length of time allowed to complete the program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE. -
MaximumTimespanMeasureMeaning: string
Title:
Maximum Duration MeaningRead Only:trueMaximum Length:80The meaning of the unit of measure for the maximum length of time allowed to complete the program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE. -
MaximumTimespanQuantity: integer
Title:
Maximum Duration QuantityRead Only:trueAlong with the unit of measure, this defines the maximum length of time allowed to complete the program. -
offeringAcademicOrganizations: array
Offering Academic Organizations
Title:
Offering Academic OrganizationsThe offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering. -
offeringCampuses: array
Offering Campuses
Title:
Offering CampusesThe offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering. -
offeringCredentials: array
Offering Credentials
Title:
Offering CredentialsThe offering credentials resource is a child of the programs resource and provides a list of credentials available for a program. -
offeringStorefronts: array
Offering Storefronts
Title:
Offering StorefrontsThe offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course. -
parameters: array
Parameters
Title:
ParametersThe parameters resource is a child of the programs resource and provides a list of program parameters for a program. -
PaymentModeCode: string
Title:
Payment ModeRead Only:trueMaximum Length:30The code of the payment mode that's used for the program when enrolling students. Valid values include ORA_PAY_TO_ENRL or ORA_BILL_LATER. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE. -
PaymentModeMeaning: string
Title:
Payment Mode MeaningRead Only:trueMaximum Length:80The meaning of the payment mode that's used for the program when enrolling students. Valid values include Pay to enroll or Bill later. A list of accepted values is defined in the lookup type ORA_HER_PAYMENT_MODE. -
PayToAccessFlag: boolean
Title:
Pay to accessRead Only:trueMaximum Length:1Default Value:falseIndicates if a program is one where a student must pay tuition or fees upfront in order to enroll in the courses that comprise this program. -
PlanFormatId: integer
(int64)
Title:
Plan Format IDRead Only:trueThe unique identifier for a default academic plan format that's associated with the program. -
PlanFormatName: string
Title:
Format NameRead Only:trueMaximum Length:50The name of the default academic plan format that's associated with the program. -
programElements: array
Program Elements
Title:
Program ElementsThe program elements resource is a child of the programs resource and provides a flattened list of courses and course list elements associated with a program. -
ProgramTypeId: integer
(int64)
Title:
Program Type IDRead Only:trueThe unique identifier for a program type value that's associated with a program. -
ProgramTypeMainFlag: boolean
Title:
Main ProgramRead Only:trueMaximum Length:1Indicates whether a program is a main program. -
ProgramTypeName: string
Title:
Program TypeRead Only:trueMaximum Length:50The name of a program type value that's associated with a program. -
tags: array
Tags
Title:
TagsThe tags resource is a child of the courses resource and provides a list of tags associated with a course. -
TypicalTimespanMeasure: string
Title:
Duration MeasurementRead Only:trueMaximum Length:30A code that indicates the type of units used to express the typical time duration for a program. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE. -
TypicalTimespanMeasureMeaning: string
Title:
Typical Time SpanRead Only:trueMaximum Length:80The meaning of the unit of measurement code for the typical duration of program, such as months or years. A list of accepted values is defined in the lookup type ORA_HER_TIMESPAN_MEASURE. -
TypicalTimespanQuantity: integer
Title:
Typical DurationRead Only:trueThe number of time span units used to express the typical duration of a program, such as 4 years. -
URLAddress: string
Title:
URL AddressRead Only:trueThe URL for a web page associated with a program.
Nested Schema : Academic Groups
Type:
arrayTitle:
Academic GroupsThe academic groups resource is a child of the programs resource and provides a list of academic groups associated with a program.
Show Source
Nested Schema : Additional Information
Type:
arrayTitle:
Additional InformationThe 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:
arrayTitle:
FeesThe fees resource is a child of the program elements resource and provides a list of fees for a program.
Show Source
Nested Schema : Images
Type:
arrayTitle:
ImagesThe images resource is a child of the courses resource and provides a list of image attachments associated with a course.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Offering Academic Organizations
Type:
arrayTitle:
Offering Academic OrganizationsThe offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering.
Show Source
Nested Schema : Offering Campuses
Type:
arrayTitle:
Offering CampusesThe offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.
Show Source
Nested Schema : Offering Credentials
Type:
arrayTitle:
Offering CredentialsThe offering credentials resource is a child of the programs resource and provides a list of credentials available for a program.
Show Source
Nested Schema : Offering Storefronts
Type:
arrayTitle:
Offering StorefrontsThe offering storefronts resource is a child of the course resource and provides a list of offering storefronts associated with a course.
Show Source
Nested Schema : Parameters
Type:
arrayTitle:
ParametersThe parameters resource is a child of the programs resource and provides a list of program parameters for a program.
Show Source
Nested Schema : Program Elements
Type:
arrayTitle:
Program ElementsThe program elements resource is a child of the programs resource and provides a flattened list of courses and course list elements associated with a program.
Show Source
Nested Schema : programs-academicGroups-item-response
Type:
Show Source
object-
AcademicGroupId: integer
(int64)
Title:
Academic Group IDRead Only:trueThe unique identifier for an academic group value that's associated with a program. -
AcademicGroupName: string
Title:
Academic Group NameRead Only:trueMaximum Length:150The name of an academic group value that's associated with a program. -
AcademicGroupTitle: string
Title:
Academic Group TitleRead Only:trueMaximum Length:100The title of an academic group value that's associated with a program. -
additionalInformation: array
Additional Information
Title:
Additional InformationThe additional information resource is a child of the courses resource and provides a list of messages associated with a course. -
CurriculumAssociationId: integer
(int64)
Title:
Curriculum Association IDRead Only:trueThe generated primary key column for a curriculum association record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Additional Information
Type:
arrayTitle:
Additional InformationThe additional information resource is a child of the courses resource and provides a list of messages associated with a course.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-academicGroups-additionalInformation-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageSequenceNumber: integer
Title:
Message Sequence NumberRead Only:trueThe unique identifier for the additional information of the course. -
MessageSortNumber: integer
(int32)
Title:
Sort NumberRead Only:trueThe unique sort identifier for the additional information of the course. -
MessageText: string
Title:
TextRead Only:trueThe text for the additional information of the course. -
MessageTypeCode: string
Title:
TypeRead Only:trueMaximum Length:30Default Value:GENThe message type of the additional information of the course. -
MessageTypeMeaning: string
Title:
Message Type MeaningRead Only:trueMaximum Length:80The description of the additional information type of the course.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : programs-additionalInformation-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageSequenceNumber: integer
Title:
Message Sequence NumberRead Only:trueThe unique identifier for the additional information of the course. -
MessageSortNumber: integer
(int32)
Title:
Sort NumberRead Only:trueThe unique sort identifier for the additional information of the course. -
MessageText: string
Title:
TextRead Only:trueThe text for the additional information of the course. -
MessageTypeCode: string
Title:
TypeRead Only:trueMaximum Length:30Default Value:GENThe message type of the additional information of the course. -
MessageTypeMeaning: string
Title:
Message Type MeaningRead Only:trueMaximum Length:80The description of the additional information type of the course.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-fees-item-response
Type:
Show Source
object-
CurrencyCode: string
Read Only:
trueThe unique identifier of the flat amount associated with the program. -
CurrentAcademicPeriodId: integer
Read Only:
trueThe unique identifier for a default academic period. -
CurrentAcademicPeriodName: string
Read Only:
trueThe name of the default academic period. -
CurriculumFeeId: integer
(int64)
Read Only:
trueThe unique identifier for a curriculum fee that's associated with the program. -
CurriculumId: integer
(int64)
Read Only:
trueThe generated unique identifier of a course. -
FeeAmount: number
Read Only:
trueThe numeric value of the flat amount associated with the program. -
FeeId: integer
(int64)
Read Only:
trueThe unique identifier for a fee that's associated with the program. -
FeeName: string
Read Only:
trueMaximum Length:50The name of the fee associated with the program. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Symbol: string
Read Only:
trueThe denomination of the flat amount associated with the program.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-images-item-response
Type:
Show Source
object-
ImageContent: string
(byte)
Title:
Attachment ContentRead Only:trueThe content of the attachment associated with the course. -
ImageContextCode: string
Title:
Curriculum Attachment ContextRead Only:trueMaximum Length:30The context name of the attachment associated with the course. -
ImageId: integer
(int64)
Title:
Curriculum Attachment IDRead Only:trueThe unique identifier of the attachment associated with the course. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-offeringAcademicOrganizations-item-response
Type:
Show Source
object-
AcademicOrgId: integer
(int64)
Title:
Academic Organization IDRead Only:trueThe academic organization that owns the curriculum item. -
AcademicOrgName: string
Title:
Academic OrganizationRead Only:trueMaximum Length:50The name of the academic organization associated with the offering. -
CurriculumOrgId: integer
(int64)
Title:
Curriculum Organization IDRead Only:trueThe generated primary key column for an offering academic organization. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
offeringOrganizationStaff: array
Offering Organization Staff
Title:
Offering Organization StaffThe offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Offering Organization Staff
Type:
arrayTitle:
Offering Organization StaffThe 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 : programs-offeringAcademicOrganizations-offeringOrganizationStaff-item-response
Type:
Show Source
object-
CurriculumStaffId: integer
(int64)
Title:
Curriculum Staff IDRead Only:trueThe generated primary key column for a curriculum staff record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersonAcademicTitle: string
Title:
Academic TitleRead Only:trueMaximum Length:30The academic title of the program staff person. -
PersonImageContent: string
(byte)
Title:
Staff ImageRead Only:trueThe content of a staff attachment such as an image file. -
PersonImageId: integer
(int64)
Title:
Attachment IDRead Only:trueA unique identifier for an attachment associated with a program. -
PersonName: string
Title:
NameRead Only:trueMaximum Length:450The name of a program staff person. -
PersonTitle: string
Title:
TitleRead Only:trueMaximum Length:60The title of the program staff person. -
StaffBiography: string
Title:
BiographyRead Only:trueThe text providing biographical or background information on a staff member. -
StaffPrimaryFlag: boolean
Title:
PrimaryRead Only:trueMaximum Length:1Identifies 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 TypeRead Only:trueMaximum Length:30The role type of the staff member associated with the course. An example is instructor. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
StaffRoleTypeMeaning: string
Title:
Role MeaningRead Only:trueMaximum Length:80The meaning of the role type of the staff member associated with the course. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
StaffSequenceNumber: integer
(int32)
Title:
Staff Sequence NumberRead Only:trueThe sequence number of a staff row associated with a program.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-offeringCampuses-item-response
Type:
Show Source
object-
CampusId: integer
(int64)
Title:
CampusRead Only:trueThe unique identifier for the campus where a course is offered. -
CampusName: string
Title:
NameRead Only:trueMaximum Length:50The name of the campus where a course is offered. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-offeringCredentials-item-response
Type:
Show Source
object-
CredentialDisplaySequence: integer
(int32)
Title:
Display SequenceRead Only:trueA sequence number that overrides the default sort order for a program's credentials. -
CredentialFormalName: string
Read Only:
trueMaximum Length:100The formal name of the credential. -
CredentialId: integer
(int64)
Title:
CredentialRead Only:trueThe unique identifier for a credential value that's associated with a program. -
CredentialName: string
Title:
NameRead Only:trueMaximum Length:50The name of the credential. -
FinalCredentialFlag: boolean
Title:
Final CredentialRead Only:trueMaximum Length:1An indicator that identifies a credential as the final or maximum credential available for a program. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-offeringStorefronts-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
StorefrontId: integer
(int64)
Title:
Storefront IDRead Only:trueThe unique identifier for the offering storefront. -
StorefrontName: string
Title:
Storefront NameRead Only:trueThe name of the offering storefront.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-parameters-item-response
Type:
Show Source
object-
ContactHoursQuantity: integer
(int32)
Title:
Contact HoursRead Only:trueDefault Value:0The number of contact hours required to satisfy a program parameter. -
DisplaySequenceNumber: integer
(int32)
Title:
Display SequenceRead Only:trueA sequence number that overrides the default sort order for a program's child courses. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Number of CoursesRead Only:trueDefault Value:0The maximum number of courses that can be taken toward satisfying a program parameter. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum UnitsRead Only:trueDefault Value:0The maximum number of credits available for a program. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Number of CoursesRead Only:trueDefault Value:0The minimum number of courses that must be taken toward satisfying a program parameter. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum UnitsRead Only:trueDefault Value:0The minimum number of credits available for a program. -
ParameterSequenceNumber: integer
(int32)
Title:
Parameter Sequence NumberRead Only:trueThe sequence number for a program parameter row. -
RequirementCategoryCode: string
Title:
Requirement Category CodeRead Only:trueMaximum Length:30A code that categorizes program course requirements. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category IDRead Only:trueThe unique identifier for a requirement category code assigned to a program parameter. -
RequirementCategoryName: string
Title:
NameRead Only:trueMaximum Length:50The name of the requirement category code.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-programElements-item-response
Type:
Show Source
object-
additionalInformation: array
Additional Information
Title:
Additional InformationThe additional information resource is a child of the courses resource and provides a list of messages associated with a course. -
ConnectorCode: string
Title:
Connector CodeRead Only:trueMaximum Length:30The hierarchical level at which the current element appears from the program. -
courseOfferings: array
Course Offerings
Title:
Course OfferingsThe course offerings resource is a child of the courses resource and provides a list of offerings for a course. -
CurriculumFormatCode: string
Title:
FormatRead Only:trueMaximum Length:30The code of the curriculum format used by the program element. 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 MeaningRead Only:trueMaximum Length:80The meaning of the curriculum format used by the program element. Valid values include Blended, Online, or On site. A list of accepted values is defined in the lookup type ORA_HER_CURRICULUM_FORMAT_CODE. -
CurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe generated primary key column for a course or course list which is associated with the program. -
CurriculumLongDescription: string
Title:
DescriptionRead Only:trueThe long description for a program element. -
CurriculumName: string
Title:
Curriculum NameRead Only:trueMaximum Length:50The name of the course or course list program element. -
CurriculumType: string
Title:
Curriculum TypeRead Only:trueMaximum Length:30The curriculum type of the program element such as course or course list. -
ElementId: integer
Title:
Curriculum Element IDRead Only:trueThe generated primary key column for a curriculum element record. -
HierarchyLevel: number
Title:
Hierarchy LevelRead Only:trueA concatenated list of curriculum ID values representing the hierarchical path of current element from the program. -
HierarchyPath: string
Title:
Hierarchy PathRead Only:trueMaximum Length:4000The unique identifier for a requirement category code assigned to a program parameter. -
LeftParenthesesQuantity: integer
(int32)
Title:
Left Parentheses QuantityRead Only:trueThe number of left parentheses included in a curriculum element row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumUnitsQuantity: number
Title:
Maximum UnitsRead Only:trueThe maximum number of units of credit that must be completed to satisfy a curriculum item requirement. -
MinimumUnitsQuantity: number
Title:
Minimum UnitsRead Only:trueThe minimum number of units of credit that can be completed or used to satisfy a curriculum item requirement. -
offeringCampuses: array
Offering Campuses
Title:
Offering CampusesThe offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering. -
parameters: array
Parameters
Title:
ParametersThe parameters resource is a child of the programs resource and provides a list of program parameters for a program. -
ParentCurriculumId: integer
(int64)
Title:
Parent Curriculum IDRead Only:trueThe code for the connectors between the elements of a curriculum item. Valid values include ORA_AND or ORA_OR. A list of accepted values is defined in the lookup type ORA_HER__ELEMENT_CONNECTOR_CODE. -
RequirementCategoryCode: string
Title:
Requirement Category CodeRead Only:trueMaximum Length:30The generated primary key column for a parent course or course list which is associated with the program. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category IDRead Only:trueA code that categorizes program course requirements. -
RequirementCategoryName: string
Title:
Requirement CategoryRead Only:trueMaximum Length:50The name of the requirement category code. -
RequirementsText: string
Title:
RequirementsRead Only:trueThe long description of requirements for a program element. -
RequisiteExistsFlag: boolean
Title:
Requisite ExistsRead Only:trueIndicates if requisite courses exist for a program element. -
requisites: array
Requisites
Title:
RequisitesThe requisites resource is a child of the program elements resource and provides a list of prerequisite or corequisite courses for a course. -
RightParenthesesQuantity: integer
(int32)
Title:
Right Parentheses QuantityRead Only:trueThe number of right parentheses included in a curriculum element row. -
SortNumber: integer
(int32)
Title:
Sort NumberRead Only:trueA sequence number that overrides the default sort order for a program's elements. -
staffSummary: array
Staff Summaries
Title:
Staff SummariesThe staff summary resource is a child of the program elements resource and provides a unique list of all associated staff. -
tags: array
Tags
Title:
TagsThe tags resource is a child of the courses resource and provides a list of tags associated with a course.
Nested Schema : Additional Information
Type:
arrayTitle:
Additional InformationThe additional information resource is a child of the courses resource and provides a list of messages associated with a course.
Show Source
Nested Schema : Course Offerings
Type:
arrayTitle:
Course OfferingsThe course offerings resource is a child of the courses resource and provides a list of offerings for a course.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Offering Campuses
Type:
arrayTitle:
Offering CampusesThe offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.
Show Source
Nested Schema : Parameters
Type:
arrayTitle:
ParametersThe parameters resource is a child of the programs resource and provides a list of program parameters for a program.
Show Source
Nested Schema : Requisites
Type:
arrayTitle:
RequisitesThe requisites resource is a child of the program elements resource and provides a list of prerequisite or corequisite courses for a course.
Show Source
Nested Schema : Staff Summaries
Type:
arrayTitle:
Staff SummariesThe staff summary resource is a child of the program elements resource and provides a unique list of all associated staff.
Show Source
Nested Schema : programs-programElements-additionalInformation-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MessageSequenceNumber: integer
Title:
Message Sequence NumberRead Only:trueThe unique identifier for the additional information of the course. -
MessageSortNumber: integer
(int32)
Title:
Sort NumberRead Only:trueThe unique sort identifier for the additional information of the course. -
MessageText: string
Title:
TextRead Only:trueThe text for the additional information of the course. -
MessageTypeCode: string
Title:
TypeRead Only:trueMaximum Length:30Default Value:GENThe message type of the additional information of the course. -
MessageTypeMeaning: string
Title:
Message Type MeaningRead Only:trueMaximum Length:80The description of the additional information type of the course.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-programElements-courseOfferings-item-response
Type:
Show Source
object-
AcademicLevelId: integer
(int64)
Title:
Academic Level IDRead Only:trueThe unique identifier of the academic level associated with offering. -
AcademicLevelName: string
Title:
Academic LevelRead Only:trueMaximum Length:100The name of the academic level associated with offering. -
AcademicSubjectCode: string
Title:
Subject CodeRead Only:trueMaximum Length:30The code for the course's academic subject. -
AcademicSubjectId: integer
(int64)
Title:
Academic Subject IDRead Only:trueThe meaning of the requisite type. Valid values include Corequisite or Prerequisite. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE. -
AcademicSubjectName: string
Title:
SubjectRead Only:trueMaximum Length:50The name of the course's academic subject. -
ClosestScheduledCourseId: integer
Title:
Closest Scheduled IDRead Only:trueThe curriculum identifier for the scheduled instance of a course that has a start date closest to today's date. -
ConsentTypeCode: string
Title:
Permission TypeRead Only:trueMaximum Length:30Default Value:ORA_NOT_REQUIREDThe 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 MeaningRead Only:trueMaximum Length:80The meaning of consent type code. A list of accepted values is defined in the lookup type ORA_HER_CONSENT_TYPE. -
CredentialId: integer
(int64)
Title:
Course Offering Credential IDRead Only:trueThe unique identifier of the credential associated with the curriculum offering. -
CredentialName: string
Title:
NameRead Only:trueMaximum Length:50The name of the credential associated with the course. -
CreditTypeCode: string
Title:
Type of CreditRead Only:trueMaximum Length:30The code for the type of credit assigned to a course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CreditTypeMeaning: string
Title:
Type of Credit MeaningRead Only:trueMaximum Length:80The meaning of the type of credit attached to a course. Valid values include Continuing education units, Credit hours, or No credit type. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CurriculumCatalogNumber: string
Title:
Catalog NumberRead Only:trueMaximum Length:10The catalog number associated with the course. -
CurriculumHeaderId: integer
(int64)
Title:
Curriculum Header IDRead Only:trueThe generated primary key column for a curriculum record. -
CurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe generated primary key column for a curriculum offering. -
EnrollConsentRequiredFlag: boolean
Title:
Permission required to enrollRead Only:trueMaximum Length:1Default Value:falseIndicates that a student must obtain consent to enroll in the curriculum item. The default value is false. -
InstitutionId: integer
(int64)
Title:
InstitutionRead Only:trueThe unique identifier for the institution on the offering of the course. -
InstitutionName: string
Title:
InstitutionRead Only:trueMaximum Length:50The name of the institution to which the course offering belongs. -
IsWishableFlag: boolean
Title:
Wish List EnabledRead Only:trueIndicates whether the course can be added to the wish list. The default value is true. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
offeringAcademicOrganizations: array
Offering Academic Organizations
Title:
Offering Academic OrganizationsThe offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering. -
offeringCampuses: array
Offering Campuses
Title:
Offering CampusesThe offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering. -
OfferSequenceNumber: integer
(int32)
Title:
Offer NumberRead Only:trueThe unique sort identifier for the offering of the course. -
RepeatAllowedFlag: boolean
Title:
RepeatableRead Only:trueMaximum Length:1Default Value:falseIndicates whether a course can be repeated. The default value is false. -
RepeatAllowedTotal: integer
(int32)
Title:
Total Completions AllowedRead Only:trueThe total number of times a student can complete a course that's repeatable. -
RepeatInPeriodFlag: boolean
Title:
Allow multiple enrollmentRead Only:trueMaximum Length:1Default Value:falseIndicates whether a student can enroll in multiple instances of the same course in the same enrollment period. The default value is false. -
RepeatUnitsTotal: number
Title:
Total Units AllowedRead Only:trueThe maximum number of credits that a student can receive for multiple completions of a repeatable course. -
ScheduledCourseCount: integer
Title:
Scheduled Course CountRead Only:trueThe number of scheduled instances of a course that are available for enrollment as of the current date. -
StudentRequestConsentFlag: boolean
Title:
Allow permission requestRead Only:trueMaximum Length:1Default Value:falseIndicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is false. -
TypicallyOfferedCode: string
Title:
Typically OfferedRead Only:trueMaximum Length:30The code of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE. -
TypicallyOfferedMeaning: string
Title:
Typically Offered MeaningRead Only:trueMaximum Length:80The meaning of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Offering Academic Organizations
Type:
arrayTitle:
Offering Academic OrganizationsThe offering academic organizations resource is a child of the course offerings resource and provides a list of academic organizations associated with a course offering.
Show Source
Nested Schema : Offering Campuses
Type:
arrayTitle:
Offering CampusesThe offering campuses resource is a child of the course offerings resource and provides a list of campuses associated with a course offering.
Show Source
Nested Schema : programs-programElements-courseOfferings-offeringAcademicOrganizations-item-response
Type:
Show Source
object-
AcademicOrgId: integer
(int64)
Title:
Academic Organization IDRead Only:trueThe academic organization that owns the curriculum item. -
AcademicOrgName: string
Title:
Academic OrganizationRead Only:trueMaximum Length:50The name of the academic organization associated with the offering. -
CurriculumOrgId: integer
(int64)
Title:
Curriculum Organization IDRead Only:trueThe generated primary key column for an offering academic organization. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
offeringOrganizationStaff: array
Offering Organization Staff
Title:
Offering Organization StaffThe offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Offering Organization Staff
Type:
arrayTitle:
Offering Organization StaffThe 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 : programs-programElements-courseOfferings-offeringAcademicOrganizations-offeringOrganizationStaff-item-response
Type:
Show Source
object-
CurriculumStaffId: integer
(int64)
Title:
Curriculum Staff IDRead Only:trueThe generated primary key column for a curriculum staff record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersonAcademicTitle: string
Title:
Academic TitleRead Only:trueMaximum Length:30The academic title of the program staff person. -
PersonImageContent: string
(byte)
Title:
Staff ImageRead Only:trueThe content of a staff attachment such as an image file. -
PersonImageId: integer
(int64)
Title:
Attachment IDRead Only:trueA unique identifier for an attachment associated with a program. -
PersonName: string
Title:
NameRead Only:trueMaximum Length:450The name of a program staff person. -
PersonTitle: string
Title:
TitleRead Only:trueMaximum Length:60The title of the program staff person. -
StaffBiography: string
Title:
BiographyRead Only:trueThe text providing biographical or background information on a staff member. -
StaffPrimaryFlag: boolean
Title:
PrimaryRead Only:trueMaximum Length:1Identifies 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 TypeRead Only:trueMaximum Length:30The role type of the staff member associated with the course. An example is instructor. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
StaffRoleTypeMeaning: string
Title:
Role MeaningRead Only:trueMaximum Length:80The meaning of the role type of the staff member associated with the course. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
StaffSequenceNumber: integer
(int32)
Title:
Staff Sequence NumberRead Only:trueThe sequence number of a staff row associated with a program.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-programElements-courseOfferings-offeringCampuses-item-response
Type:
Show Source
object-
CampusId: integer
(int64)
Title:
CampusRead Only:trueThe unique identifier for the campus where a course is offered. -
CampusName: string
Title:
NameRead Only:trueMaximum Length:50The name of the campus where a course is offered. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-programElements-offeringCampuses-item-response
Type:
Show Source
object-
CampusId: integer
(int64)
Title:
CampusRead Only:trueThe unique identifier for the campus where a course is offered. -
CampusName: string
Title:
NameRead Only:trueMaximum Length:50The name of the campus where a course is offered. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-programElements-parameters-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Number of CoursesRead Only:trueDefault Value:0The maximum number of courses that can be taken toward satisfying a program parameter. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum UnitsRead Only:trueDefault Value:0The maximum number of credits available for a program. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Number of CoursesRead Only:trueDefault Value:0The minimum number of courses that must be taken toward satisfying a program parameter. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum UnitsRead Only:trueDefault Value:0The minimum number of credits available for a program. -
ParameterId: integer
(int64)
Title:
Curriculum Parameter IDRead Only:trueThe unique identifier for a parameter that's associated with a program element. -
ParameterSequenceNumber: integer
(int32)
Title:
Parameter Sequence NumberRead Only:trueThe sequence number for a program parameter row. -
RequirementCategoryCode: string
Title:
Requirement Category CodeRead Only:trueMaximum Length:30A code that categorizes program course requirements. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category IDRead Only:trueThe unique identifier for a requirement category code assigned to a program parameter. -
RequirementCategoryName: string
Title:
NameRead Only:trueMaximum Length:50The name of the requirement category code.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-programElements-requisites-item-response
Type:
Show Source
object-
CurriculumId: integer
(int64)
Title:
Requisite Curriculum IDRead Only:trueThe unique identifier for a course which is a requisite for the program element. -
CurriculumName: string
Title:
NameRead Only:trueMaximum Length:150The name of the course which is a requisite for the program element. -
CurriculumRequisiteId: integer
(int64)
Title:
Curriculum Requisite IDRead Only:trueThe generated primary key column for a requisite. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
RequisiteSchemeId: integer
(int64)
Title:
Requisite Scheme IDRead Only:trueThe unique identifier for the scheme associated with the requisite. -
RequisiteTypeCode: string
Title:
Requisite Type CodeRead Only:trueMaximum Length:30A code that indicates the type of requisite. Valid values include ORA_CO or ORA_PRE. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE. -
RequisiteTypeMeaning: string
Title:
Requisite TypeRead Only:trueMaximum Length:80The meaning of the requisite type. Valid values include Corequisite or Prerequisite. A list of accepted values is defined in the lookup type ORA_HER_REQUISITE_TYPE_CODE. -
SchemeName: string
Title:
Requisite SchemeRead Only:trueMaximum Length:50The name of the scheme associated with the requisite. -
SortSequenceNumber: integer
(int32)
Title:
Sort Sequence NumberRead Only:trueA sequence number that overrides the default sort order for the requisite.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : programs-programElements-staffSummary-item-response
Type:
Show Source
object-
AcademicPeriodId: integer
(int64)
Title:
Academic Period IDRead Only:trueThe unique identifier for an academic period. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PeriodName: string
Title:
Period NameRead Only:trueMaximum Length:50The name of the academic period. -
PersonName: string
Title:
NameRead Only:trueMaximum Length:450The name of the staff member associated with the course. -
PrimaryFlag: boolean
Title:
PrimaryRead Only:trueMaximum Length:1Identifies the primary staff member for a program or course. When yes, the staff row is considered the primary staff resource. The default value is false. If only one record exists, the default value is true. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period IDRead Only:trueThe unique identifier for a reporting period. -
ReportingPeriodName: string
Title:
Reporting Period NameRead Only:trueMaximum Length:50The name of the reporting period. -
RoleAccessCode: string
Title:
Role AccessRead Only:trueMaximum Length:30The code for the role access of the staff member in relation to a curriculum item. Valid values include ORA_GRADE and ORA_POC. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_ACCESS_CODE. -
RoleAccessMeaning: string
Title:
Role Access Code MeaningRead Only:trueMaximum Length:80The meaning of a staff role access value. Valid values include Grader or Point of contact. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_ACCESS_CODE. -
RoleTypeCode: string
Title:
Role TypeRead Only:trueMaximum Length:30The role type of the staff member in relation to a curriculum item. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
RoleTypeMeaning: string
Title:
Role Type Code MeaningRead Only:trueMaximum Length:80The meaning of a staff role type value. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source