Create a wish list
post
/fscmRestApi/resources/11.13.18.05/wishlists
Request
Header Parameters
-
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.
-
Upsert-Mode:
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 Items
The 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 Name
Maximum Length:50
Default Value:Wish List
A name for a wish list.
Nested Schema : Wish List Items
Type:
array
Title:
Wish List Items
The 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:
Courses
The 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:
Programs
The 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 Courses
The 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 ID
The generated identifier for a wish list entry. For a program or scheduled course, this is the curriculum ID.
Nested Schema : Courses
Type:
array
Title:
Courses
The 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:
array
Title:
Programs
The 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:
array
Title:
Scheduled Courses
The 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 Offerings
The 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:
Images
The images resource is a child of the program resource and provides the image attachments associated with a program.
Nested Schema : Unscheduled Course Offerings
Type:
array
Title:
Unscheduled Course Offerings
The 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:
array
Title:
Images
The 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
object
Nested Schema : wishlists-wishlistItems-program-item-post-request
Type:
Show Source
object
-
images: array
Images
Title:
Images
The images resource is a child of the program resource and provides the image attachments 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. -
offeringCredentials: array
Offering Credentials
Title:
Offering Credentials
The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program. -
parameters: array
Parameters
Title:
Parameters
The parameters resource is a child of the programs resource and provides a list of program parameters for a program.
Nested Schema : Images
Type:
array
Title:
Images
The 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:
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 : Offering Credentials
Type:
array
Title:
Offering Credentials
The 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:
array
Title:
Parameters
The 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
object
Nested Schema : wishlists-wishlistItems-program-offeringCredentials-item-post-request
Type:
Show Source
object
Nested Schema : wishlists-wishlistItems-program-parameters-item-post-request
Type:
Show Source
object
Nested Schema : wishlists-wishlistItems-scheduledCourse-item-post-request
Type:
Show Source
object
-
images: array
Images
Title:
Images
The images resource is a child of the program resource and provides the image attachments associated with a program. -
meetingPatterns: array
meetingPatterns
-
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 : Images
Type:
array
Title:
Images
The images resource is a child of the program resource and provides the image attachments associated with a program.
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 : wishlists-wishlistItems-scheduledCourse-images-item-post-request
Type:
Show Source
object
Nested Schema : wishlists-wishlistItems-scheduledCourse-meetingPatterns-item-post-request
Type:
Show Source
object
Nested Schema : wishlists-wishlistItems-scheduledCourse-offeringOrganizationStaff-item-post-request
Type:
Show Source
object
Response
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 : wishlists-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Identifies the name of the person who created the wish list detail. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the wish list detail was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the wish list was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Identifies the name of the person who last updated the wish list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WishlistId: integer
(int64)
Title:
Wish List ID
Read Only:true
A generated primary key column for a wish list. -
wishlistItems: array
Wish List Items
Title:
Wish List Items
The 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 Name
Maximum Length:50
Default Value:Wish List
A name for a wish list.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Wish List Items
Type:
array
Title:
Wish List Items
The 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 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 : wishlists-wishlistItems-item-response
Type:
Show Source
object
-
course: array
Courses
Title:
Courses
The 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 By
Read Only:true
Maximum Length:64
Identifies the name of the person who created the wish list item. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the wish list was created. -
CurriculumType: string
Title:
Curriculum Item Type
Read Only:true
Maximum Length:30
The curriculum item type for a wish list entry. -
InstitutionId: integer
(int64)
Title:
Institution ID
Read Only:true
The identifier for the institution to which the wish list entry, such as a scheduled course, belongs. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the wish list was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Identifies the name of the person who last updated the wish list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
program: array
Programs
Title:
Programs
The 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 Courses
The 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 ID
Read Only:true
A unique identifier for a wish list entry. -
WishlistItemId: integer
(int64)
Title:
Wish List Item ID
The generated identifier for a wish list entry. For a program or scheduled course, this is the curriculum ID.
Nested Schema : Courses
Type:
array
Title:
Courses
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Programs
Type:
array
Title:
Programs
The 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:
array
Title:
Scheduled Courses
The 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 Offerings
The 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 ID
Read Only:true
The unique identifier for a curriculum item such as course. -
CurriculumLongDescription: string
Title:
Long Description
Read Only:true
The long description for a course. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of a course. -
CurriculumTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The title or formal description of a course. -
images: array
Images
Title:
Images
The images resource is a child of the program resource and provides the image attachments associated with a program. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TypicallyOfferedCode: string
Title:
Typically Offered
Read Only:true
Maximum Length:30
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. -
TypicallyOfferedMeaning: string
Title:
Typically Offered Meaning
Read Only:true
Maximum Length:80
The 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:
array
Title:
Unscheduled Course Offerings
The 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:
array
Title:
Images
The images resource is a child of the program resource and provides the image attachments associated with a program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The 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 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. -
CredentialId: integer
(int64)
Title:
Course Offering Credential ID
Read Only:true
The unique identifier of the credential associated with the course. -
CredentialName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the credential associated with the course. -
CreditTypeCode: string
Title:
Type of Credit
Read Only:true
Maximum Length:30
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
Title:
Type of Credit Meaning
Read Only:true
Maximum Length:80
The 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 Number
Read Only:true
Maximum Length:10
The catalog number associated with the course. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The unique identifier for a curriculum item such as a course. -
InstitutionId: integer
(int64)
Title:
Institution
Read Only:true
The unique identifier for the institution that owns the course. -
IsWishableFlag: boolean
Title:
Wish List Enabled
Read Only:true
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferSequenceNumber: integer
(int32)
Title:
Offer Number
Read Only:true
The unique sort identifier for the offering of the 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.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Content
Read Only:true
The content of a curriculum item attachment such as an image file. -
ImageContextCode: string
Title:
Curriculum Attachment Context
Read Only:true
Maximum Length:30
The 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 ID
Read Only:true
The unique identifier for an attachment associated with a curriculum item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : wishlists-wishlistItems-program-item-response
Type:
Show Source
object
-
AcademicLevelId: integer
(int64)
Title:
Academic Level ID
Read Only:true
The unique identifier for an academic level value that's associated with a program. -
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of an academic level value that's associated with a program. -
AdmissionRequiredFlag: boolean
Title:
Admission Required
Read Only:true
Maximum Length:1
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. -
CampusName: string
Title:
Name
Read Only:true
The name of the campus where the program is offered. -
CreditTypeCode: string
Title:
Type of Credit
Read Only:true
Maximum Length:30
The 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 Meaning
Read Only:true
Maximum Length:80
The 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:
Format
Read Only:true
Maximum Length:30
A 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 Meaning
Read Only:true
Maximum Length:80
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. -
CurriculumId: integer
(int64)
Title:
Curriculum ID
Read Only:true
The unique identifier for a curriculum item such as program. -
CurriculumLongDescription: string
Title:
Long Description
Read Only:true
The long description for a program. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of a program. -
CurriculumTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The title or formal description of a program. -
images: array
Images
Title:
Images
The images resource is a child of the program resource and provides the image attachments associated with a program. -
InstitutionId: integer
(int64)
Title:
Institution ID
Read Only:true
The identifier for the institution to which the program belongs. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The name of the institution to which the program belongs. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MainProgramFlag: boolean
Title:
Main program
Read Only:true
Maximum Length:1
Indicates whether the program type is considered a main, degree-bearing 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. -
offeringCredentials: array
Offering Credentials
Title:
Offering Credentials
The offering credentials resource is a child of the programs resource and provides a list of credentials available for a program. -
parameters: array
Parameters
Title:
Parameters
The parameters resource is a child of the programs resource and provides a list of program parameters for a program. -
TypicalTimespanMeasure: string
Title:
Typical Duration
Read Only:true
Maximum Length:30
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
Title:
Typical Time Span
Read Only:true
Maximum Length:80
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
Title:
Typical Duration
Read Only:true
The number of time span units used to express the typical duration of a program, such as 4 years.
Nested Schema : Images
Type:
array
Title:
Images
The images resource is a child of the program resource and provides the image attachments associated with a program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : Offering Credentials
Type:
array
Title:
Offering Credentials
The 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:
array
Title:
Parameters
The 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 Content
Read Only:true
The content of a curriculum item attachment such as an image file. -
ImageContextCode: string
Title:
Curriculum Attachment Context
Read Only:true
Maximum Length:30
The 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 ID
Read Only:true
The unique identifier for an attachment associated with a curriculum item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : wishlists-wishlistItems-program-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
Nested Schema : wishlists-wishlistItems-program-offeringCredentials-item-response
Type:
Show Source
object
-
CredentialDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
A sequence number that overrides the default sort order for a program's credentials. -
CredentialFormalName: string
Read Only:
true
Maximum Length:100
The formal name of the credential. -
CredentialId: integer
(int64)
Title:
Credential
Read Only:true
The unique identifier for a credential value that's associated with a program. -
CredentialName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the credential. -
FinalCredentialFlag: boolean
Title:
Final Credential
Read Only:true
Maximum Length:1
An indicator that identifies a credential as the final or maximum credential available for a program. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : wishlists-wishlistItems-program-parameters-item-response
Type:
Show Source
object
-
ContactHoursQuantity: integer
(int32)
Title:
Contact Hours
Read Only:true
Default Value:0
The number of contact hours required to satisfy a program parameter. -
DisplaySequenceNumber: integer
(int32)
Title:
Display Sequence
Read Only:true
A sequence number that overrides the default sort order for a program's child courses. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumCoursesQuantity: integer
(int32)
Title:
Maximum Number of Courses
Read Only:true
Default Value:0
The maximum number of courses that can be taken toward satisfying a program parameter. -
MaximumUnitsQuantity: integer
(int32)
Title:
Maximum Units
Read Only:true
Default Value:0
The maximum number of credits available for a program. -
MinimumCoursesQuantity: integer
(int32)
Title:
Minimum Number of Courses
Read Only:true
Default Value:0
The minimum number of courses that must be taken toward satisfying a program parameter. -
MinimumUnitsQuantity: integer
(int32)
Title:
Minimum Units
Read Only:true
Default Value:0
The minimum number of credits available for a program. -
ParameterSequenceNumber: integer
(int32)
Title:
Parameter Sequence Number
Read Only:true
The sequence number for a program parameter row. -
RequirementCategoryCode: string
Title:
Requirement Category Code
Read Only:true
Maximum Length:30
A code that categorizes program course requirements. -
RequirementCategoryId: integer
(int64)
Title:
Requirement Category ID
Read Only:true
The unique identifier for a requirement category code assigned to a program parameter. -
RequirementCategoryName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the requirement category code.
Nested Schema : Links
Type:
array
Title:
Links
The 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 ID
Read Only:true
The unique identifier for an academic level that's associated with a course. -
AcademicLevelName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of an academic level, such as undergraduate, that's associated with a course. -
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
Read Only:true
The unique identifier of the academic organization associated with the scheduled course. -
AcademicSubjectCode: string
Title:
Subject Code
Read Only:true
Maximum Length:30
A code for an academic subject. -
AcademicSubjectId: integer
(int64)
Title:
Academic Subject ID
Read Only:true
The unique identifier for the course's academic subject. -
AcademicSubjectName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the academic subject. -
BuildingName: string
Title:
Name
Read Only:true
The name of the building in which a scheduled course occurs. -
BuildingShortCode: string
Title:
Code
Read Only:true
The code or identifier for the building in which a scheduled course occurs. -
CampusId: integer
(int64)
Title:
Campus ID
Read Only:true
The unique identifier for the campus where a course is offered. -
CampusName: string
Title:
Campus
Read Only:true
Maximum Length:50
The campus where the scheduled course is offered. -
CoursePayToEnrollFlag: boolean
Title:
Pay to enroll
Read Only:true
Maximum Length:1
Indicates that the student must pay for the course at the time of enrollment. -
CredentialId: integer
(int64)
Title:
Scheduled Course Credential ID
Read Only:true
The unique identifier of the credential associated with the course. -
CredentialName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of the credential associated with the scheduled course. -
CredentialTypeCode: string
Title:
Credential Type
Read Only:true
Maximum Length:30
The code for the type of credential associated with the scheduled course. Valid values include ORA_CERTIFICATE, ORA_DEGREE, or ORA_DIPLOMA. A list of accepted values is defined in the lookup type ORA_HER_CREDENTIAL_TYPE_CODE. -
CreditTypeCode: string
Title:
Type of Credit
Read Only:true
Maximum Length:30
The 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 Meaning
Read Only:true
Maximum Length:80
The 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 Code
Read Only:true
The currency of the course fee. -
CurrencySymbol: string
Title:
Currency Symbol
Read Only:true
The currency symbol associated with a scheduled course fee. -
CurriculumCatalogNumber: string
Title:
Catalog Number
Read Only:true
Maximum Length:10
The catalog number of a scheduled course. -
CurriculumFormatCode: string
Title:
Format
Read Only:true
Maximum Length:30
A 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 Meaning
Read Only:true
Maximum Length:80
The 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 ID
Read Only:true
The unique identifier for a curriculum item such as scheduled course. -
CurriculumLongDescription: string
Title:
Long Description
Read Only:true
The long description for a scheduled course. -
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
The name of a scheduled course. -
CurriculumTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The title of the scheduled course. -
EnrollmentCapacityQuantity: integer
(int32)
Title:
Enrollment Capacity
Read Only:true
The largest number of enrollments allowed for the course. -
EnrollmentEndDate: string
(date-time)
Title:
Enrollment Dates
Read Only:true
The date when the enrollment period for the scheduled course ends. -
EnrollmentStartDate: string
(date-time)
Title:
Enrollment Dates
Read Only:true
The date when the enrollment period for the scheduled course starts. -
EnrollmentStatusCode: string
Title:
Enrollment Status
Read Only:true
Maximum Length:30
A 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 Meaning
Read Only:true
Maximum Length:80
The 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 Message
Read Only:true
A message indicating that a wish list item has expired. -
FacilityDescription: string
Title:
Description
Read Only:true
The description of the facility associated with the scheduled course. -
FacilityRoomNumber: string
Title:
Room Number
Read Only:true
The room identifier for scheduled course meeting. -
FacilityShortCode: string
Title:
Facility
Read Only:true
The facility or building code for scheduled course meeting. -
FlatAmount: number
Title:
Amount
Read Only:true
The fee amount for a course. -
images: array
Images
Title:
Images
The images resource is a child of the program resource and provides the image attachments associated with a program. -
InstitutionId: integer
(int64)
Title:
Institution ID
Read Only:true
The unique identifier for the institution where the scheduled course is offered. -
InstitutionName: string
Title:
Institution
Read Only:true
Maximum Length:50
The name of the institution where the scheduled course is offered. -
InstructorName: string
Title:
Name
Read Only:true
The name of the primary instructor for a scheduled course. -
IsCartableFlag: boolean
Title:
Shopping Cart Enabled
Read Only:true
Indicates 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-Paced
Read Only:true
Indicates 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:
Links
The link relations associated with the resource instance. -
LocationControlCode: string
Title:
Location Control Code
Read Only:true
The 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:
Latitude
Read Only:true
The GPS latitude coordinates for the scheduled course meeting location. -
LocationLongitude: string
Title:
Longitude
Read Only:true
The GPS longitude coordinates for the scheduled course meeting location. -
LocationLongName: string
Title:
Location Long Name
Read Only:true
The name of the location for a scheduled course. -
MapIntegrationURL: string
Title:
Map Integration URL
Read Only:true
The uniform resource locator of the map application to be used for displaying scheduled course meeting location. -
MaximumUnitsQuantity: number
Title:
Maximum Units
Read Only:true
The maximum number of credits available for a scheduled course. -
MeetingPatternDescription: string
Title:
Pattern Name
Read Only:true
The name or description of the scheduled course meeting pattern, such as Monday and Wednesdays. -
MeetingPatternEndDate: string
(date)
Title:
End Date
Read Only:true
The date when the meeting pattern of a scheduled course ends. -
MeetingPatternEndTime: string
(date-time)
Title:
End Time
Read Only:true
The time when the meeting pattern of a scheduled course ends. -
meetingPatterns: array
meetingPatterns
-
MeetingPatternStartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the meeting pattern of a scheduled course starts. -
MeetingPatternStartTime: string
(date-time)
Title:
Start Time
Read Only:true
The time when the meeting pattern of a scheduled course starts. -
MinimumUnitsQuantity: number
Title:
Minimum Units
Read Only:true
The minimum number of credits available for a scheduled course. -
offeringOrganizationStaff: array
Offering Organization Staff
Title:
Offering Organization Staff
The offering organization staff resource is a child of the offering academic organizations resource and provides a list of staff associated with a program. -
OwningCurriculumId: integer
(int64)
Title:
Owning Curriculum ID
Read Only:true
The 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:
Name
Read Only:true
Maximum Length:50
The name of the credential attached to the course. -
OwningOfferNumber: integer
(int32)
Title:
Owning Offer Number
Read Only:true
The unique identifier for the parent curriculum item offer number of the scheduled course. -
ReportingPeriodEndDate: string
(date)
Title:
Reporting Period End Date
Read Only:true
The date when the reporting period associated with the scheduled course ends. -
ReportingPeriodId: integer
(int64)
Title:
Reporting Period ID
Read Only:true
The unique identifier for the reporting period associated with the scheduled course. -
ReportingPeriodName: string
Title:
Reporting Period Name
Read Only:true
Maximum Length:50
The name of the reporting period associated with the scheduled course. -
ReportingPeriodStartDate: string
(date)
Title:
Reporting Period Start Date
Read Only:true
The date when the reporting period associated with the scheduled course begins. -
ScheduledCourseCode: string
Title:
Scheduled Course Code
Read Only:true
Maximum Length:30
A code used to identify a scheduled course within a given course and academic period. -
ScheduledCourseEndDate: string
(date-time)
Title:
End Date
Read Only:true
The date when the scheduled course ends. -
ScheduledCourseNumber: integer
(int32)
Title:
Scheduled Course Number
Read Only:true
A generated, unique key for a scheduled course. -
ScheduledCourseStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The date when the scheduled course starts. -
TotalEnrolledQuantity: integer
(int32)
Title:
Total Enrolled
Read Only:true
The number that indicates the current enrollment total or seats taken for a scheduled course. -
URLAddress: string
Title:
URL Address
Read Only:true
The unique URL address of the scheduled course.
Nested Schema : Images
Type:
array
Title:
Images
The images resource is a child of the program resource and provides the image attachments associated with a program.
Show Source
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 : wishlists-wishlistItems-scheduledCourse-images-item-response
Type:
Show Source
object
-
ImageContent: string
(byte)
Title:
Attachment Content
Read Only:true
The content of a curriculum item attachment such as an image file. -
ImageContextCode: string
Title:
Curriculum Attachment Context
Read Only:true
Maximum Length:30
The 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 ID
Read Only:true
The unique identifier for an attachment associated with a curriculum item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : wishlists-wishlistItems-scheduledCourse-meetingPatterns-item-response
Type:
Show Source
object
-
BuildingName: string
Title:
Name
Read Only:true
Maximum Length:50
-
BuildingShortCode: string
Title:
Code
Read Only:true
Maximum Length:6
-
DurationQuantity: integer
(int32)
Title:
Duration
Read Only:true
-
FacilityDescription: string
Title:
Description
Read Only:true
Maximum Length:240
-
FacilityRoomNumber: string
Title:
Room Number
Read Only:true
Maximum Length:10
-
FacilityShortCode: string
Title:
Facility
Read Only:true
Maximum Length:20
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationControlCode: string
Title:
Location Control Code
Read Only:true
Maximum Length:30
Default Value:ORA_USE_FACILITY
-
LocationLongName: string
Title:
Location Long Name
Read Only:true
Maximum Length:100
-
MeetingName: string
Title:
Meeting Name
Read Only:true
Maximum Length:50
-
MeetingPatternLatitude: number
Title:
Latitude
Read Only:true
-
MeetingPatternLongitude: number
Title:
Longitude
Read Only:true
-
PatternDescription: string
Title:
Pattern Name
Read Only:true
Maximum Length:50
-
RecurrenceDayFriFlag: boolean
Title:
Friday
Read Only:true
Maximum Length:1
Default Value:false
-
RecurrenceDayMonFlag: boolean
Title:
Monday
Read Only:true
Maximum Length:1
Default Value:false
-
RecurrenceDaySatFlag: boolean
Title:
Saturday
Read Only:true
Maximum Length:1
Default Value:false
-
RecurrenceDaySunFlag: boolean
Title:
Sunday
Read Only:true
Maximum Length:1
Default Value:false
-
RecurrenceDayThursFlag: boolean
Title:
Thursday
Read Only:true
Maximum Length:1
Default Value:false
-
RecurrenceDayTuesFlag: boolean
Title:
Tuesday
Read Only:true
Maximum Length:1
Default Value:false
-
RecurrenceDayWedFlag: boolean
Title:
Wednesday
Read Only:true
Maximum Length:1
Default Value:false
-
ScheduleEndDate: string
(date)
Title:
End Date
Read Only:true
-
ScheduleEndTime: string
(date-time)
Title:
End Time
Read Only:true
-
ScheduleSequenceNumber: integer
(int32)
Title:
Schedule Sequence Number
Read Only:true
-
ScheduleStartDate: string
(date)
Title:
Start Date
Read Only:true
-
ScheduleStartTime: string
(date-time)
Title:
Start Time
Read Only:true
Nested Schema : Links
Type:
array
Title:
Links
The 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 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
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: