Create a wish list
post
/fscmRestApi/resources/11.13.18.05/wishlists
Request
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
wishlistItems: array
Wish List Items
Title:
Wish List ItemsThe wish list items resource is a child of the wish lists resource and provides a list of items added to a wish list. -
WishlistName: string
Title:
Wish List NameMaximum Length:50Default Value:Wish ListA name for a wish list.
Nested Schema : Wish List Items
Type:
arrayTitle:
Wish List ItemsThe wish list items resource is a child of the wish lists resource and provides a list of items added to a wish list.
Show Source
Nested Schema : wishlists-wishlistItems-item-post-request
Type:
Show Source
object-
course: array
Courses
Title:
CoursesThe course resource is a child of the wish list items resource and provides the information for a course wish list item. -
program: array
Programs
Title:
ProgramsThe program resource is a child of the wish list items resource and provides the information for a program wish list item. -
scheduledCourse: array
Scheduled Courses
Title:
Scheduled CoursesThe scheduled course resource is a child of the wish list items resource and provides the information for a scheduled course wish list item. -
WishlistItemId(required): integer
(int64)
Title:
Wish List Item IDThe generated identifier for a wish list entry. For a program or scheduled course, this is the curriculum ID.
Nested Schema : Courses
Type:
arrayTitle:
CoursesThe course resource is a child of the wish list items resource and provides the information for a course wish list item.
Show Source
Nested Schema : Programs
Type:
arrayTitle:
ProgramsThe program resource is a child of the wish list items resource and provides the information for a program wish list item.
Show Source
Nested Schema : Scheduled Courses
Type:
arrayTitle:
Scheduled CoursesThe scheduled course resource is a child of the wish list items resource and provides the information for a scheduled course wish list item.
Show Source
Nested Schema : wishlists-wishlistItems-course-item-post-request
Type:
Show Source
object-
courseOfferings: array
Unscheduled Course Offerings
Title:
Unscheduled Course OfferingsThe unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item. -
images: array
Images
Title:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program.
Nested Schema : Unscheduled Course Offerings
Type:
arrayTitle:
Unscheduled Course OfferingsThe unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item.
Show Source
Nested Schema : Images
Type:
arrayTitle:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program.
Show Source
Nested Schema : wishlists-wishlistItems-course-courseOfferings-item-post-request
Type:
Show Source
objectNested Schema : wishlists-wishlistItems-program-item-post-request
Type:
Show Source
object-
images: array
Images
Title:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program. -
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. -
parameters: array
Parameters
Title:
ParametersThe parameters resource is a child of the programs resource and provides a list of program parameters for a program.
Nested Schema : Images
Type:
arrayTitle:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program.
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 : 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 : wishlists-wishlistItems-program-offeringCampuses-item-post-request
Type:
Show Source
objectNested Schema : wishlists-wishlistItems-program-offeringCredentials-item-post-request
Type:
Show Source
objectNested Schema : wishlists-wishlistItems-program-parameters-item-post-request
Type:
Show Source
objectNested Schema : wishlists-wishlistItems-scheduledCourse-item-post-request
Type:
Show Source
object-
images: array
Images
Title:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program. -
meetingPatterns: array
Meeting Patterns
Title:
Meeting PatternsThe meeting patterns resource is a child of the scheduled courses resource and provides a list of meeting patterns associated with a scheduled course. -
offeringOrganizationStaff: array
Offering Organization Staff
Title:
Offering Organization StaffThe staff associated with a curriculum item.
Nested Schema : Images
Type:
arrayTitle:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program.
Show Source
Nested Schema : Meeting Patterns
Type:
arrayTitle:
Meeting PatternsThe 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:
arrayTitle:
Offering Organization StaffThe staff associated with a curriculum item.
Show Source
Nested Schema : wishlists-wishlistItems-scheduledCourse-images-item-post-request
Type:
Show Source
objectNested Schema : wishlists-wishlistItems-scheduledCourse-meetingPatterns-item-post-request
Type:
Show Source
objectNested Schema : wishlists-wishlistItems-scheduledCourse-offeringOrganizationStaff-item-post-request
Type:
Show Source
objectResponse
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 : wishlists-item-response
Type:
Show Source
object-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Identifies the name of the person who created the wish list detail. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the wish list detail was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the wish list was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Identifies the name of the person who last updated the wish list. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
WishlistId: integer
(int64)
Title:
Wish List IDRead Only:trueA generated primary key column for a wish list. -
wishlistItems: array
Wish List Items
Title:
Wish List ItemsThe wish list items resource is a child of the wish lists resource and provides a list of items added to a wish list. -
WishlistName: string
Title:
Wish List NameMaximum Length:50Default Value:Wish ListA name for a wish list.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Wish List Items
Type:
arrayTitle:
Wish List ItemsThe wish list items resource is a child of the wish lists resource and provides a list of items added to a wish list.
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 : wishlists-wishlistItems-item-response
Type:
Show Source
object-
course: array
Courses
Title:
CoursesThe course resource is a child of the wish list items resource and provides the information for a course wish list item. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64Identifies the name of the person who created the wish list item. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the wish list was created. -
CurriculumType: string
Title:
Curriculum Item TypeRead Only:trueMaximum Length:30The curriculum item type for a wish list entry. -
InstitutionId: integer
(int64)
Title:
Institution IDRead Only:trueThe identifier for the institution to which the wish list entry, such as a scheduled course, belongs. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the wish list was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64Identifies the name of the person who last updated the wish list. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
program: array
Programs
Title:
ProgramsThe program resource is a child of the wish list items resource and provides the information for a program wish list item. -
scheduledCourse: array
Scheduled Courses
Title:
Scheduled CoursesThe scheduled course resource is a child of the wish list items resource and provides the information for a scheduled course wish list item. -
WishlistDetailId: integer
(int64)
Title:
Wish List Detail IDRead Only:trueA unique identifier for a wish list entry. -
WishlistItemId: integer
(int64)
Title:
Wish List Item IDThe generated identifier for a wish list entry. For a program or scheduled course, this is the curriculum ID.
Nested Schema : Courses
Type:
arrayTitle:
CoursesThe course resource is a child of the wish list items resource and provides the information for a course wish list item.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Programs
Type:
arrayTitle:
ProgramsThe program resource is a child of the wish list items resource and provides the information for a program wish list item.
Show Source
Nested Schema : Scheduled Courses
Type:
arrayTitle:
Scheduled CoursesThe scheduled course resource is a child of the wish list items resource and provides the information for a scheduled course wish list item.
Show Source
Nested Schema : wishlists-wishlistItems-course-item-response
Type:
Show Source
object-
courseOfferings: array
Unscheduled Course Offerings
Title:
Unscheduled Course OfferingsThe unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item. -
CurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe unique identifier for a curriculum item such as course. -
CurriculumLongDescription: string
Title:
Long DescriptionRead Only:trueThe long description for a course. -
CurriculumName: string
Title:
NameRead Only:trueMaximum Length:50The name of a course. -
CurriculumTitle: string
Title:
TitleRead Only:trueMaximum Length:100The title or formal description of a course. -
images: array
Images
Title:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TypicallyOfferedCode: string
Title:
Typically OfferedRead Only:trueMaximum Length:30The code for the time of year that a course is usually offered. 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 code for the time of year that a course is usually offered. A list of accepted values is defined in the lookup type ORA_HER_TYPICALLY_OFFERED_CODE.
Nested Schema : Unscheduled Course Offerings
Type:
arrayTitle:
Unscheduled Course OfferingsThe unscheduled course offering resource is a child of the curriculum items resource and provides the information for a course offering curriculum item.
Show Source
Nested Schema : Images
Type:
arrayTitle:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : wishlists-wishlistItems-course-courseOfferings-item-response
Type:
Show Source
object-
AcademicLevelId: integer
(int64)
Title:
Academic Level IDRead Only:trueThe unique identifier of the academic level associated with the offering. -
AcademicLevelName: string
Title:
Academic LevelRead Only:trueMaximum Length:100The name of the academic level associated with the 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 unique identifier for the course's academic subject. -
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. -
CredentialId: integer
(int64)
Title:
Course Offering Credential IDRead Only:trueThe unique identifier of the credential associated with the course. -
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. -
CurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe unique identifier for a curriculum item such as a course. -
InstitutionId: integer
(int64)
Title:
InstitutionRead Only:trueThe unique identifier for the institution that owns the course. -
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. -
OfferSequenceNumber: integer
(int32)
Title:
Offer NumberRead Only:trueThe unique sort identifier for the offering of the 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : wishlists-wishlistItems-course-images-item-response
Type:
Show Source
object-
ImageContent: string
(byte)
Title:
Attachment ContentRead Only:trueThe content of a curriculum item attachment such as an image file. -
ImageContextCode: string
Title:
Curriculum Attachment ContextRead Only:trueMaximum Length:30The context or usage of a curriculum item attachment file. Valid values include ORA_MOBILE, ORA_STANDARD, or ORA_THUMB. A list of accepted values is defined in the lookup type ORA_HER_ATTACHMENT_CONTEXT. -
ImageId: integer
(int64)
Title:
Curriculum Attachment IDRead Only:trueThe unique identifier for an attachment associated with a curriculum item. -
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 : wishlists-wishlistItems-program-item-response
Type:
Show Source
object-
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. -
AdmissionRequiredFlag: boolean
Title:
Admission RequiredRead Only:trueMaximum Length:1Indicates 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. -
CampusName: string
Title:
NameRead Only:trueThe name of the campus where the program is offered. -
CreditTypeCode: string
Title:
Type of CreditRead Only:trueMaximum Length:30The code for the type of credit assigned to 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 a program credit type code. 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 indicating the format in which a program is delivered. 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. -
CurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe unique identifier for a curriculum item such as program. -
CurriculumLongDescription: string
Title:
Long DescriptionRead Only:trueThe long description for a program. -
CurriculumName: string
Title:
NameRead Only:trueMaximum Length:50The name of a program. -
CurriculumTitle: string
Title:
TitleRead Only:trueMaximum Length:100The title or formal description of a program. -
images: array
Images
Title:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program. -
InstitutionId: integer
(int64)
Title:
Institution IDRead 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. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MainProgramFlag: boolean
Title:
Main programRead Only:trueMaximum Length:1Indicates whether the program type is considered a main, degree-bearing program. -
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. -
parameters: array
Parameters
Title:
ParametersThe parameters resource is a child of the programs resource and provides a list of program parameters for a program. -
TypicalTimespanMeasure: string
Title:
Typical DurationRead 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.
Nested Schema : Images
Type:
arrayTitle:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program.
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 : 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 : 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 : wishlists-wishlistItems-program-images-item-response
Type:
Show Source
object-
ImageContent: string
(byte)
Title:
Attachment ContentRead Only:trueThe content of a curriculum item attachment such as an image file. -
ImageContextCode: string
Title:
Curriculum Attachment ContextRead Only:trueMaximum Length:30The context or usage of a curriculum item attachment file. Valid values include ORA_MOBILE, ORA_STANDARD, or ORA_THUMB. A list of accepted values is defined in the lookup type ORA_HER_ATTACHMENT_CONTEXT. -
ImageId: integer
(int64)
Title:
Curriculum Attachment IDRead Only:trueThe unique identifier for an attachment associated with a curriculum item. -
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 : wishlists-wishlistItems-program-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. -
CurriculumCampusId: integer
(int64)
Title:
Curriculum Campus IDRead Only:trueThe generated primary key column for a curriculum campus. -
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 : wishlists-wishlistItems-program-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
Title:
Credential Formal NameRead 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 : wishlists-wishlistItems-program-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 : wishlists-wishlistItems-scheduledCourse-item-response
Type:
Show Source
object-
AcademicLevelId: integer
(int64)
Title:
Academic Level IDRead Only:trueThe unique identifier for an academic level that's associated with a course. -
AcademicLevelName: string
Title:
Academic Level NameRead Only:trueMaximum Length:100The name of an academic level, such as undergraduate, that's associated with a course. -
AcademicOrgId: integer
(int64)
Title:
Academic Organization IDRead Only:trueThe unique identifier of the academic organization associated with the scheduled course. -
AcademicSubjectCode: string
Title:
Subject CodeRead Only:trueMaximum Length:30A code for an academic subject. -
AcademicSubjectId: integer
(int64)
Title:
Academic Subject IDRead Only:trueThe unique identifier for the course's academic subject. -
AcademicSubjectName: string
Title:
NameRead Only:trueMaximum Length:50The name of the academic subject. -
BuildingName: string
Title:
NameRead Only:trueThe name of the building in which a scheduled course occurs. -
BuildingShortCode: string
Title:
CodeRead Only:trueThe code or identifier for the building in which a scheduled course occurs. -
CampusId: integer
(int64)
Title:
Campus IDRead Only:trueThe unique identifier for the campus where a course is offered. -
CampusName: string
Title:
CampusRead Only:trueMaximum Length:50The campus where the scheduled course is offered. -
CoursePayToEnrollFlag: boolean
Title:
Pay to enrollRead Only:trueMaximum Length:1Indicates that the student must pay for the course at the time of enrollment. -
CredentialId: integer
(int64)
Title:
Scheduled Course Credential IDRead Only:trueThe unique identifier of the credential associated with the course. -
CredentialName: string
Title:
NameRead Only:trueMaximum Length:50The name of the credential associated with the scheduled course. -
CredentialTypeCode: string
Title:
Credential TypeRead Only:trueMaximum Length:30The 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 CreditRead Only:trueMaximum Length:30The code for the type of credit assigned to a 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 MeaningRead Only:trueMaximum Length:80The meaning of a scheduled course credit type code. 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. -
CurrencyCode: string
Title:
Currency CodeRead Only:trueThe currency of the course fee. -
CurrencySymbol: string
Title:
Currency SymbolRead Only:trueThe currency symbol associated with a scheduled course fee. -
CurriculumCatalogNumber: string
Title:
Catalog NumberRead Only:trueMaximum Length:10The catalog number of a scheduled course. -
CurriculumFormatCode: string
Title:
FormatRead Only:trueMaximum Length:30A code indicating the format in which a scheduled course is delivered. 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 scheduled course 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. -
CurriculumId: integer
(int64)
Title:
Curriculum IDRead Only:trueThe unique identifier for a curriculum item such as scheduled course. -
CurriculumLongDescription: string
Title:
Long DescriptionRead Only:trueThe long description for a scheduled course. -
CurriculumName: string
Title:
NameRead Only:trueMaximum Length:50The name of a scheduled course. -
CurriculumTitle: string
Title:
TitleRead Only:trueMaximum Length:100The title of the scheduled course. -
EnrollmentCapacityQuantity: integer
(int32)
Title:
Enrollment CapacityRead Only:trueThe largest number of enrollments allowed for the course. -
EnrollmentEndDate: string
(date-time)
Title:
Enrollment DatesRead Only:trueThe date when the enrollment period for the scheduled course ends. -
EnrollmentStartDate: string
(date-time)
Title:
Enrollment DatesRead Only:trueThe date when the enrollment period for the scheduled course starts. -
EnrollmentStatusCode: string
Title:
Enrollment StatusRead Only:trueMaximum Length:30A code that indicates the enrollment status of a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE. -
EnrollmentStatusMeaning: string
Title:
Enrollment Status MeaningRead Only:trueMaximum Length:80The meaning of the enrollment status code for a scheduled course. A list of accepted values is defined in the lookup type ORA_HER_ENROLLMENT_STATUS_CODE. -
ExpiryMessage: string
Title:
Expiry MessageRead Only:trueA message indicating that a wish list item has expired. -
FacilityDescription: string
Title:
DescriptionRead Only:trueThe description of the facility associated with the scheduled course. -
FacilityRoomNumber: string
Title:
Room NumberRead Only:trueThe room identifier for scheduled course meeting. -
FacilityShortCode: string
Title:
FacilityRead Only:trueThe facility or building code for scheduled course meeting. -
FlatAmount: number
Title:
AmountRead Only:trueThe fee amount for a course. -
images: array
Images
Title:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program. -
InstitutionId: integer
(int64)
Title:
Institution IDRead Only:trueThe unique identifier for the institution where the scheduled course is offered. -
InstitutionName: string
Title:
InstitutionRead Only:trueMaximum Length:50The name of the institution where the scheduled course is offered. -
InstructorName: string
Title:
NameRead Only:trueThe name of the primary instructor for a scheduled course. -
IsCartableFlag: boolean
Title:
Shopping Cart EnabledRead Only:trueIndicates whether a scheduled course is available for the shopping cart. When yes, the scheduled course can be added to a user's shopping cart. When no, the add to cart function is disabled. -
IsSelfPacedFlag: boolean
Title:
Self-PacedRead Only:trueIndicates whether a student can select the date on which they start a scheduled course. When yes, a user must provide a start date. When no, the scheduled course start date is used. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationControlCode: string
Title:
Location Control CodeRead Only:trueThe location control code for a scheduled course meeting. A list of accepted values is defined in the lookup type ORA_HER_LOCATION_CONTROL_CODE. -
LocationLatitude: string
Title:
LatitudeRead Only:trueThe GPS latitude coordinates for the scheduled course meeting location. -
LocationLongitude: string
Title:
LongitudeRead Only:trueThe GPS longitude coordinates for the scheduled course meeting location. -
LocationLongName: string
Title:
Location Long NameRead Only:trueThe name of the location for a scheduled course. -
MapIntegrationURL: string
Title:
Map Integration URLRead Only:trueThe uniform resource locator of the map application to be used for displaying scheduled course meeting location. -
MaximumUnitsQuantity: number
Title:
Maximum UnitsRead Only:trueThe maximum number of credits available for a scheduled course. -
MeetingPatternDescription: string
Title:
Pattern NameRead Only:trueThe name or description of the scheduled course meeting pattern, such as Monday and Wednesdays. -
MeetingPatternEndDate: string
(date)
Title:
End DateRead Only:trueThe date when the meeting pattern of a scheduled course ends. -
MeetingPatternEndTime: string
(date-time)
Title:
End TimeRead Only:trueThe time when the meeting pattern of a scheduled course ends. -
meetingPatterns: array
Meeting Patterns
Title:
Meeting PatternsThe 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 DateRead Only:trueThe date when the meeting pattern of a scheduled course starts. -
MeetingPatternStartTime: string
(date-time)
Title:
Start TimeRead Only:trueThe time when the meeting pattern of a scheduled course starts. -
MinimumUnitsQuantity: number
Title:
Minimum UnitsRead Only:trueThe minimum number of credits available for a scheduled course. -
offeringOrganizationStaff: array
Offering Organization Staff
Title:
Offering Organization StaffThe staff associated with a curriculum item. -
OwningCurriculumId: integer
(int64)
Title:
Owning Curriculum IDRead Only:trueThe identifier of the parent course of this scheduled course. This scheduled course is a scheduled instance of the course identified by this value. -
OwningCurriculumName: string
Title:
NameRead Only:trueMaximum Length:50The name of the credential attached to the course. -
OwningOfferNumber: integer
(int32)
Title:
Owning Offer NumberRead Only:trueThe unique identifier for the parent curriculum item offer number of the scheduled course. -
ReportingPeriodEndDate: string
(date)
Title:
Reporting Period End DateRead Only:trueThe date when the reporting period associated with the scheduled course ends. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period IDRead Only:trueThe unique identifier for the reporting period associated with the scheduled course. -
ReportingPeriodName: string
Title:
Reporting Period NameRead Only:trueMaximum Length:50The name of the reporting period associated with the scheduled course. -
ReportingPeriodStartDate: string
(date)
Title:
Reporting Period Start DateRead Only:trueThe date when the reporting period associated with the scheduled course begins. -
ScheduledCourseCode: string
Title:
Scheduled Course CodeRead Only:trueMaximum Length:30A code used to identify a scheduled course within a given course and academic period. -
ScheduledCourseEndDate: string
(date-time)
Title:
End DateRead Only:trueThe date when the scheduled course ends. -
ScheduledCourseNumber: integer
(int32)
Title:
Scheduled Course NumberRead Only:trueA generated, unique key for a scheduled course. -
ScheduledCourseStartDate: string
(date-time)
Title:
Start DateRead Only:trueThe date when the scheduled course starts. -
TotalEnrolledQuantity: integer
(int32)
Title:
Total EnrolledRead Only:trueThe number that indicates the current enrollment total or seats taken for a scheduled course. -
URLAddress: string
Title:
URL AddressRead Only:trueThe unique URL address of the scheduled course.
Nested Schema : Images
Type:
arrayTitle:
ImagesThe images resource is a child of the program resource and provides the image attachments associated with a program.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Meeting Patterns
Type:
arrayTitle:
Meeting PatternsThe 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:
arrayTitle:
Offering Organization StaffThe staff associated with a curriculum item.
Show Source
Nested Schema : wishlists-wishlistItems-scheduledCourse-images-item-response
Type:
Show Source
object-
ImageContent: string
(byte)
Title:
Attachment ContentRead Only:trueThe content of a curriculum item attachment such as an image file. -
ImageContextCode: string
Title:
Curriculum Attachment ContextRead Only:trueMaximum Length:30The context or usage of a curriculum item attachment file. Valid values include ORA_MOBILE, ORA_STANDARD, or ORA_THUMB. A list of accepted values is defined in the lookup type ORA_HER_ATTACHMENT_CONTEXT. -
ImageId: integer
(int64)
Title:
Curriculum Attachment IDRead Only:trueThe unique identifier for an attachment associated with a curriculum item. -
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 : wishlists-wishlistItems-scheduledCourse-meetingPatterns-item-response
Type:
Show Source
object-
BuildingName: string
Title:
NameRead Only:trueMaximum Length:50The name of the building associated with the meeting pattern of the scheduled course. -
BuildingShortCode: string
Title:
CodeRead Only:trueMaximum Length:6The unique identifier of the building associated with the meeting pattern of the scheduled course. -
DurationQuantity: integer
(int32)
Title:
DurationRead Only:trueThe numeric value that indicates the length of a meeting of the scheduled course. -
FacilityDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240The description of the meeting pattern of the scheduled course. -
FacilityRoomNumber: string
Title:
Room NumberRead Only:trueMaximum Length:10The room number associated with the meeting pattern of the scheduled course. -
FacilityShortCode: string
Title:
FacilityRead Only:trueMaximum Length:20The identifier of the facility associated with the meeting pattern of the scheduled course. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationControlCode: string
Title:
Location Control CodeRead Only:trueMaximum Length:30Default Value:ORA_USE_FACILITYThe unique identifier of the single use location associated with the meeting pattern of the scheduled course. -
LocationLongName: string
Title:
Location Long NameRead Only:trueMaximum Length:100The name of the single use location associated with the meeting pattern of the scheduled course. -
MeetingName: string
Title:
Meeting NameRead Only:trueMaximum Length:50The name of the meeting pattern of the scheduled course. -
MeetingPatternLatitude: number
Title:
LatitudeRead Only:trueThe GPS latitude coordinates for the scheduled course meeting location. -
MeetingPatternLongitude: number
Title:
LongitudeRead Only:trueThe GPS longitude coordinates for the scheduled course meeting location. -
PatternDescription: string
Title:
Pattern NameRead Only:trueMaximum Length:50The name of the meeting pattern of the scheduled course. -
RecurrenceDayFriFlag: boolean
Title:
FridayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Friday. -
RecurrenceDayMonFlag: boolean
Title:
MondayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Monday. -
RecurrenceDaySatFlag: boolean
Title:
SaturdayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Saturday. -
RecurrenceDaySunFlag: boolean
Title:
SundayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Sunday. -
RecurrenceDayThursFlag: boolean
Title:
ThursdayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Thursday. -
RecurrenceDayTuesFlag: boolean
Title:
TuesdayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Tuesday. -
RecurrenceDayWedFlag: boolean
Title:
WednesdayRead Only:trueMaximum Length:1Default Value:falseThe unique identifier for the day of the week Wednesday. -
ScheduleEndDate: string
(date)
Title:
End DateRead Only:trueThe date when the meeting pattern of the scheduled course ends. -
ScheduleEndTime: string
(date-time)
Title:
End TimeRead Only:trueThe time when the meeting pattern of the scheduled course ends. -
ScheduleSequenceNumber: integer
(int32)
Title:
Schedule Sequence NumberRead Only:trueThe sequence identifier of the meeting pattern of the scheduled course. -
ScheduleStartDate: string
(date)
Title:
Start DateRead Only:trueThe date when the meeting pattern of the scheduled course starts. -
ScheduleStartTime: string
(date-time)
Title:
Start TimeRead Only:trueThe time when the meeting pattern of the scheduled course starts.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : wishlists-wishlistItems-scheduledCourse-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 staff member associated with the curriculum item. -
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 curriculum item. -
PersonName: string
Title:
NameRead Only:trueMaximum Length:450The name of the staff member associated with the curriculum item. -
PersonTitle: string
Title:
TitleRead Only:trueMaximum Length:60The title of the staff member associated with the curriculum item. -
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 curriculum item. When yes, the staff row is considered the primary staff resource for the curriculum item. The default value is false. If only one record exists, the default value is true. -
StaffRoleTypeCode: string
Title:
Role TypeRead Only:trueMaximum Length:30The role type of the staff member associated with the curriculum item. An example is instructor. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
StaffRoleTypeMeaning: string
Title:
Role MeaningRead Only:trueMaximum Length:80The meaning of the role type of the staff member associated with the curriculum item. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE. -
StaffSequenceNumber: integer
(int32)
Title:
Staff Sequence NumberRead Only:trueThe sequence number of a staff row associated with a curriculum item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- wishlistItems
-
Parameters:
- WishlistId:
$request.path.WishlistId
The wish list items resource is a child of the wish lists resource and provides a list of items added to a wish list. - WishlistId: