Get a course offering
get
/fscmRestApi/resources/11.13.18.05/programs/{programsUniqID}/child/programElements/{ElementId}/child/courseOfferings/{courseOfferingsUniqID}
Request
Path Parameters
-
ElementId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
courseOfferingsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Course Offerings resource and used to uniquely identify an instance of Course Offerings. The client should not generate the hash key value. Instead, the client should query on the Course Offerings collection resource in order to navigate to a specific instance of Course Offerings to get the hash key.
-
programsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Programs resource and used to uniquely identify an instance of Programs. The client should not generate the hash key value. Instead, the client should query on the Programs collection resource in order to navigate to a specific instance of Programs to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : programs-programElements-courseOfferings-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Read Only:true
The unique identifier of the academic level associated with the offering. -
AcademicLevelName: string
Title:
Academic Level
Read Only:true
Maximum Length:100
The name of the academic level associated with the offering. -
AcademicSubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
The code for the 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:
Subject
Read Only:true
Maximum Length:50
The name of the course's academic subject. -
ClosestScheduledCourseId: integer
Title:
Closest Scheduled ID
Read Only:true
The curriculum identifier for the scheduled instance of a course that has a start date closest to today's date. -
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 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 ID
Read Only:true
The unique identifier of the credential associated with the offering. -
CredentialName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the credential associated with the course. -
CreditTypeCode: string
Title:
Type of Credit
Read Only:true
Maximum Length:30
The code for the type of credit assigned to a course. Valid values include ORA_CEU, ORA_CRH, or ORA_NONE. A list of accepted values is defined in the lookup type ORA_HER_CREDIT_TYPE_CODE. -
CreditTypeMeaning: string
Title:
Type of Credit Meaning
Read Only:true
Maximum Length:80
The meaning of the type of credit assigned 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 Number
Read Only:true
Maximum Length:10
The catalog number associated with the course. -
CurriculumHeaderId: integer
(int64)
Title:
Curriculum Header ID
Read Only:true
The generated primary key column for a curriculum record. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The unique identifier for a curriculum item such as a 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 false. -
InstitutionId: integer
(int64)
Title:
Institution
Read Only:true
The unique identifier for the institution that owns the course. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The name of the institution to which the course offering belongs. -
IsWishableFlag: boolean
Title:
Wish List Enabled
Read Only:true
Indicates whether the 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. -
offeringAcademicOrganizations: array
Offering Academic Organizations
Title:
Offering Academic Organizations
The offering academic organizations resource is a child of the programs resource and provides a list of academic organizations associated with a program. -
offeringCampuses: array
Offering Campuses
Title:
Offering Campuses
The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered. -
OfferSequenceNumber: integer
(int32)
Title:
Offer Number
Read Only:true
The unique sort identifier for the offering of the course. -
RepeatAllowedFlag: boolean
Title:
Repeatable
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether a course can be repeated. The default value is false. -
RepeatAllowedTotal: integer
(int32)
Title:
Total Completions Allowed
Read Only:true
The total number of times a student can complete a course that's repeatable. -
RepeatInPeriodFlag: boolean
Title:
Allow multiple enrollment
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether a student can enroll in multiple instances of the same course in the same enrollment period. The default value is false. -
RepeatUnitsTotal: number
Title:
Total Units Allowed
Read Only:true
The maximum number of credits that a student can receive for multiple completions of a repeatable course. -
ScheduledCourseCount: integer
Title:
Scheduled Course Count
Read Only:true
The number of scheduled instances of a course that are available for enrollment as of the current date. -
StudentRequestConsentFlag: boolean
Title:
Allow permission request
Read Only:true
Maximum Length:1
Default Value:false
Indicates that a student can initiate a request for consent or exception in relation to enrollment. The default value is false. -
TypicallyOfferedCode: string
Title:
Typically Offered
Read Only:true
Maximum Length:30
The code of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE. -
TypicallyOfferedMeaning: string
Title:
Typically Offered Meaning
Read Only:true
Maximum Length:80
The meaning of the typically offered value of the course. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Offering Academic Organizations
Type:
array
Title:
Offering Academic Organizations
The offering academic organizations resource is a child of the programs resource and provides a list of academic organizations associated with a program.
Show Source
Nested Schema : Offering Campuses
Type:
array
Title:
Offering Campuses
The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered.
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 : programs-programElements-courseOfferings-offeringAcademicOrganizations-item-response
Type:
Show Source
object
-
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
Read Only:true
The generated primary key column for an offering academic organization. -
AcademicOrgName: string
Title:
Academic Organization
Read Only:true
Maximum Length:50
The name of the academic organization associated with the offering. -
CurriculumOrgId: integer
(int64)
Title:
Curriculum Organization ID
Read Only:true
The identifier of the academic organization that owns the program. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : programs-programElements-courseOfferings-offeringAcademicOrganizations-offeringOrganizationStaff-item-response
Type:
Show Source
object
-
CurriculumStaffId: integer
(int64)
Title:
Curriculum Staff ID
Read Only:true
The generated primary key column for a curriculum staff record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonAcademicTitle: string
Title:
Academic Title
Read Only:true
Maximum Length:30
The academic title of the program staff person. -
PersonImageContent: string
(byte)
Title:
Staff Image
Read Only:true
The content of a staff attachment such as an image file. -
PersonImageId: integer
(int64)
Title:
Attachment ID
Read Only:true
A unique identifier for an attachment associated with a program. -
PersonName: string
Title:
Name
Read Only:true
Maximum Length:450
The name of a program staff person. -
PersonTitle: string
Title:
Title
Read Only:true
Maximum Length:60
The title of the program staff person. -
StaffBiography: string
Title:
Biography
Read Only:true
The text providing biographical or background information on a staff member. -
StaffPrimaryFlag: boolean
Title:
Primary
Read Only:true
Maximum Length:1
Identifies the primary staff member for a program. When yes, the staff row is considered the primary staff resource for the program. The default value is false. If only one record exists, the default value is true. -
StaffRoleTypeCode: string
Title:
Role Type
Read Only:true
Maximum Length:30
A code identifying the role of a program staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
StaffRoleTypeMeaning: string
Title:
Role Meaning
Read Only:true
Maximum Length:80
The meaning of the role code of the program staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
StaffSequenceNumber: integer
(int32)
Title:
Staff Sequence Number
Read Only:true
The sequence number of a staff row associated with a program.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : programs-programElements-courseOfferings-offeringCampuses-item-response
Type:
Show Source
object
-
CampusId: integer
(int64)
Title:
Campus
Read Only:true
A unique identifier for the campus where the program is offered. -
CampusName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the campus where the program is offered. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CourseLOV
-
Operation: /fscmRestApi/resources/11.13.18.05/coursesThe list of values for the course offering associated with the program.
- SubjectsLOV
-
Operation: /fscmRestApi/resources/11.13.18.05/subjectsThe list of values for the academic subject name of the course offering.
- academicLevelsLOV
-
The list of values for the academic level of the course offering.
- consentTypeCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HER_CONSENT_TYPE
The list of values for the consent type associated with the course. - finder:
- offeringAcademicOrganizations
-
Parameters:
- ElementId:
$request.path.ElementId
- courseOfferingsUniqID:
$request.path.courseOfferingsUniqID
- programsUniqID:
$request.path.programsUniqID
The offering academic organizations resource is a child of the programs resource and provides a list of academic organizations associated with a program. - ElementId:
- offeringCampuses
-
Parameters:
- ElementId:
$request.path.ElementId
- courseOfferingsUniqID:
$request.path.courseOfferingsUniqID
- programsUniqID:
$request.path.programsUniqID
The offering campuses resource is a child of the programs resource and provides a list of campuses where a program is offered. - ElementId: