Get all wish lists

get

/fscmRestApi/resources/11.13.18.05/wishlists

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all wish lists that match the primary key criteria specified.
      Finder Variables
      • WishlistId; integer; Unique identifier for the wish list.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CreatedBy; string; Identifies the name of the person who created the wish list detail.
    • CreationDate; string; The date when the wish list detail was created.
    • LastUpdateDate; string; The date when the wish list was last updated.
    • LastUpdatedBy; string; Identifies the name of the person who last updated the wish list.
    • WishlistId; integer; A generated primary key column for a wish list.
    • WishlistName; string; A name for a wish list.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : wishlists
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : wishlists-item-response
Type: object
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 : wishlists-wishlistItems-item-response
Type: object
Show Source
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-response
Type: object
Show Source
  • 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.
  • Title: Curriculum ID
    Read Only: true
    The unique identifier for a curriculum item such as course.
  • Title: Long Description
    Read Only: true
    The long description for a course.
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The name of a course.
  • Title: Title
    Read Only: true
    Maximum Length: 100
    The title or formal description of a course.
  • Images
    Title: Images
    The images resource is a child of the program resource and provides the image attachments associated with a program.
  • Links
  • 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.
  • 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 : wishlists-wishlistItems-course-courseOfferings-item-response
Type: object
Show Source
  • Title: Academic Level ID
    Read Only: true
    The unique identifier of the academic level associated with the offering.
  • Title: Academic Level
    Read Only: true
    Maximum Length: 100
    The name of the academic level associated with the offering.
  • Title: Subject Code
    Read Only: true
    Maximum Length: 30
    The code for the course's academic subject.
  • Title: Academic Subject ID
    Read Only: true
    The unique identifier for the course's academic subject.
  • Title: Subject
    Read Only: true
    Maximum Length: 50
    The name of the course's academic subject.
  • 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.
  • Title: Course Offering Credential ID
    Read Only: true
    The unique identifier of the credential associated with the course.
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The name of the credential associated with the course.
  • 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.
  • 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.
  • Title: Catalog Number
    Read Only: true
    Maximum Length: 10
    The catalog number associated with the course.
  • Title: Curriculum ID
    Read Only: true
    The unique identifier for a curriculum item such as a course.
  • Title: Institution
    Read Only: true
    The unique identifier for the institution that owns the course.
  • 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
  • Title: Offer Number
    Read Only: true
    The unique sort identifier for the offering of the course.
  • 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 : wishlists-wishlistItems-course-images-item-response
Type: object
Show Source
  • Title: Attachment Content
    Read Only: true
    The content of a curriculum item attachment such as an image file.
  • 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.
  • Title: Curriculum Attachment ID
    Read Only: true
    The unique identifier for an attachment associated with a curriculum item.
  • Links
Nested Schema : wishlists-wishlistItems-program-item-response
Type: object
Show Source
  • Title: Academic Level ID
    Read Only: true
    The unique identifier for an academic level value that's associated with a program.
  • Title: Academic Level Name
    Read Only: true
    Maximum Length: 100
    The name of an academic level value that's associated with a program.
  • 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.
  • Title: Name
    Read Only: true
    The name of the campus where the program is offered.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Curriculum ID
    Read Only: true
    The unique identifier for a curriculum item such as program.
  • Title: Long Description
    Read Only: true
    The long description for a program.
  • Title: Name
    Read Only: true
    Maximum Length: 50
    The name of a program.
  • Title: Title
    Read Only: true
    Maximum Length: 100
    The title or formal description of a program.
  • Images
    Title: Images
    The images resource is a child of the program resource and provides the image attachments associated with a program.
  • Title: Institution ID
    Read Only: true
    The identifier for the institution to which the program belongs.
  • Title: Institution
    Read Only: true
    Maximum Length: 50
    The name of the institution to which the program belongs.
  • Links
  • Title: Main program
    Read Only: true
    Maximum Length: 1
    Indicates whether the program type is considered a main, degree-bearing program.
  • 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.
  • 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
    Title: Parameters
    The parameters resource is a child of the programs resource and provides a list of program parameters for a program.
  • 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.
  • 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.
  • 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 : 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: object
Show Source
  • Title: Attachment Content
    Read Only: true
    The content of a curriculum item attachment such as an image file.
  • 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.
  • Title: Curriculum Attachment ID
    Read Only: true
    The unique identifier for an attachment associated with a curriculum item.
  • Links
Nested Schema : wishlists-wishlistItems-program-offeringCampuses-item-response
Type: object
Show Source
Nested Schema : wishlists-wishlistItems-program-offeringCredentials-item-response
Type: object
Show Source
Nested Schema : wishlists-wishlistItems-program-parameters-item-response
Type: object
Show Source
Nested Schema : wishlists-wishlistItems-scheduledCourse-item-response
Type: object
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 : meetingPatterns
Type: array
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: object
Show Source
  • Title: Attachment Content
    Read Only: true
    The content of a curriculum item attachment such as an image file.
  • 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.
  • Title: Curriculum Attachment ID
    Read Only: true
    The unique identifier for an attachment associated with a curriculum item.
  • Links
Nested Schema : wishlists-wishlistItems-scheduledCourse-meetingPatterns-item-response
Type: object
Show Source
Nested Schema : wishlists-wishlistItems-scheduledCourse-offeringOrganizationStaff-item-response
Type: object
Show Source
  • Title: Curriculum Staff ID
    Read Only: true
    The generated primary key column for a curriculum staff record.
  • Links
  • Title: Academic Title
    Read Only: true
    Maximum Length: 30
    The academic title of the program staff person.
  • Title: Staff Image
    Read Only: true
    The content of a staff attachment such as an image file.
  • Title: Attachment ID
    Read Only: true
    A unique identifier for an attachment associated with a program.
  • Title: Name
    Read Only: true
    Maximum Length: 450
    The name of a program staff person.
  • Title: Title
    Read Only: true
    Maximum Length: 60
    The title of the program staff person.
  • Title: Biography
    Read Only: true
    The text providing biographical or background information on a staff member.
  • 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.
  • 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.
  • 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.
  • Title: Staff Sequence Number
    Read Only: true
    The sequence number of a staff row associated with a program.
Back to Top