Get all recommended items
get
/fscmRestApi/resources/11.13.18.05/studentScheduleByPeriods/{studentScheduleByPeriodsUniqID}/child/schedulePeriods/{schedulePeriodsUniqID}/child/recommendedItems
Request
Path Parameters
-
schedulePeriodsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Schedule Periods resource and used to uniquely identify an instance of Schedule Periods. The client should not generate the hash key value. Instead, the client should query on the Schedule Periods collection resource in order to navigate to a specific instance of Schedule Periods to get the hash key.
-
studentScheduleByPeriodsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Student Schedule by Periods resource and used to uniquely identify an instance of Student Schedule by Periods. The client should not generate the hash key value. Instead, the client should query on the Student Schedule by Periods collection resource in order to navigate to a specific instance of Student Schedule by Periods to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all recommended items that match the item curriculum ID.
Finder Variables- ItemCurriculumId; integer; Finds all recommended items that match the item curriculum ID.
- PrimaryKey Finds all recommended items that match the item curriculum ID.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AcademicSubjectCode; string; The subject code for the course.
- AcademicSubjectId; integer; The unique identifier for the subject of the course.
- AcademicSubjectName; string; The subject name for the course.
- CourseEnrollmentStatusCode; string; The enrollment status code of the course section indicating if the course is available for enrollment.
- CourseEnrollmentStatusMeaning; string; The enrollment status of the course section indicating if the course is available for enrollment.
- CourseOfferingId; integer; The offering identifier for the course.
- CreditTypeCode; string; The credit type code for the course.
- CreditTypeMeaning; string; The credit type for the course or course section.
- CurriculumCatalogNumber; string; The catalog number for the course.
- ItemCurriculumId; integer; The unique identifier of the curriculum item (course) that's recommended.
- ItemCurriculumName; string; The name of the curriculum item (course) that's recommended.
- ItemCurriculumType; string; The type of curriculum that's recommended.
- ItemCurriculumTypeId; integer; The unique identifier for the type of curriculum that's recommended.
- ItemCurriculumTypeName; string; The type name of the curriculum that's recommended.
- MaximumUnitsQuantity; number; The maximum number of units for which a course can be taken.
- MinimumUnitsQuantity; number; The minimum number of units for which a course can be taken.
- OfferSequenceNumber; integer; The offering sequence number for the course.
- RepeatAllowedFlag; boolean; Indicates that repeating the course is allowed. The default value is false.
- RepeatAllowedTotal; integer; The total number of times a student can take a course.
- RepeatInPeriodFlag; boolean; Indicates that repeating the course is allowed within the same period.
- RepeatUnitsTotal; number; The total number of repeated units which are allowed for the course.
- RequisiteExistsFlag; boolean; Indicates if requisites exist for the course.
- RequisiteInformation; string; The text used to describe the requisites of a course.
- SourceProgramCurriculumId; integer; The curriculum ID of the program used to generate the recommendation.
- SourceProgramTemplateId; integer; The template ID of the program template used to generate the recommendation.
- SourceTemplatePeriodId; integer; The template period ID of the program template used to generate the recommendation.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : studentScheduleByPeriods-schedulePeriods-recommendedItems
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentScheduleByPeriods-schedulePeriods-recommendedItems-item-response
Type:
Show Source
object
-
AcademicSubjectCode: string
Read Only:
true
Maximum Length:255
The subject code for the course. -
AcademicSubjectId: integer
Read Only:
true
The unique identifier for the subject of the course. -
AcademicSubjectName: string
Read Only:
true
Maximum Length:255
The subject name for the course. -
CourseEnrollmentStatusCode: string
Read Only:
true
Maximum Length:255
The enrollment status code of the course section indicating if the course is available for enrollment. -
CourseEnrollmentStatusMeaning: string
Read Only:
true
Maximum Length:255
The enrollment status of the course section indicating if the course is available for enrollment. -
CourseOfferingId: integer
Read Only:
true
The offering identifier for the course. -
CreditTypeCode: string
Read Only:
true
Maximum Length:255
The credit type code for the course. -
CreditTypeMeaning: string
Read Only:
true
Maximum Length:255
The credit type for the course or course section. -
CurriculumCatalogNumber: string
Read Only:
true
Maximum Length:255
The catalog number for the course. -
ItemCurriculumId: integer
Read Only:
true
The unique identifier of the curriculum item (course) that's recommended. -
ItemCurriculumName: string
Read Only:
true
The name of the curriculum item (course) that's recommended. -
ItemCurriculumType: string
Read Only:
true
The type of curriculum that's recommended. -
ItemCurriculumTypeId: integer
Read Only:
true
The unique identifier for the type of curriculum that's recommended. -
ItemCurriculumTypeName: string
Read Only:
true
Maximum Length:255
The type name of the curriculum that's recommended. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumUnitsQuantity: number
Read Only:
true
The maximum number of units for which a course can be taken. -
MinimumUnitsQuantity: number
Read Only:
true
The minimum number of units for which a course can be taken. -
OfferSequenceNumber: integer
Read Only:
true
The offering sequence number for the course. -
RepeatAllowedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates that repeating the course is allowed. The default value is false. -
RepeatAllowedTotal: integer
Read Only:
true
The total number of times a student can take a course. -
RepeatInPeriodFlag: boolean
Read Only:
true
Indicates that repeating the course is allowed within the same period. -
RepeatUnitsTotal: number
Read Only:
true
The total number of repeated units which are allowed for the course. -
RequisiteExistsFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if requisites exist for the course. -
RequisiteInformation: string
(byte)
Read Only:
true
Maximum Length:255
The text used to describe the requisites of a course. -
SourceProgramCurriculumId: integer
Read Only:
true
The curriculum ID of the program used to generate the recommendation. -
SourceProgramTemplateId: integer
Read Only:
true
The template ID of the program template used to generate the recommendation. -
SourceTemplatePeriodId: integer
Read Only:
true
The template period ID of the program template used to generate the recommendation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.