Get all results for a student's scheduled course
get
/fscmRestApi/resources/11.13.18.05/studentScheduledCourses/{studentScheduledCoursesUniqID}/child/results
Request
Path Parameters
-
studentScheduledCoursesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Student Scheduled Courses resource and used to uniquely identify an instance of Student Scheduled Courses. The client should not generate the hash key value. Instead, the client should query on the Student Scheduled Courses collection resource in order to navigate to a specific instance of Student Scheduled Courses 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> -
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 results that match the primary key criteria specified.
Finder Variables- ResultId; integer; Unique identifier for the result.
- PrimaryKey Finds all results that match the primary key criteria specified.
-
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:- Gradepoints; number; The grade points value of the result, such as 4.00.
- NumericValue; number; The result value in numeric format, such as a score of 95.
- OutcomeCode; string; The code of the result outcome. An example of a result outcome is Pass. A list of accepted values is defined in the lookup type ORA_HER_OUTCOME_CODE.
- OutcomeDescription; string; The description of the result outcome.
- OutcomeMeaning; string; The meaning of the result outcome. A list of accepted values is defined in the lookup type ORA_HER_OUTCOME_CODE.
- ResultId; integer; The generated primary key column for a result related to the enrollment record.
- ResultSetCode; string; The result set code of the result. Use result sets to support various types of measurement such as grades, units, and grade points.
- ResultSetId; integer; The unique identifier of the result set. Use result sets to support various types of measurement such as grades, units, and grade points.
- ResultSetName; string; The result set name, such as Letter Grade, of the result.
- ResultTypeCode; string; The result type code of the result. An example of a result type is Course Result.
- StatusCode; string; The status code of the result. A list of accepted values is defined in the lookup type ORA_HER_RESULT_STATUS.
- StatusMeaning; string; The meaning of the status code of the result. A list of accepted values is defined in the lookup type ORA_HER_RESULT_STATUS.
- TextValue; string; The result value in text format, such as a grade of A.
-
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : studentScheduledCourses-results
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 : studentScheduledCourses-results-item-response
Type:
Show Source
object
-
Gradepoints: number
Title:
Student Result Grade Points
Read Only:true
The grade points value of the result, such as 4.00. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumericValue: number
Title:
Numeric Result
Read Only:true
The result value in numeric format, such as a score of 95. -
OutcomeCode: string
Title:
Outcome
Read Only:true
Maximum Length:30
The code of the result outcome. An example of a result outcome is Pass. A list of accepted values is defined in the lookup type ORA_HER_OUTCOME_CODE. -
OutcomeDescription: string
Title:
Outcome Description
Read Only:true
Maximum Length:240
The description of the result outcome. -
OutcomeMeaning: string
Title:
Outcome Meaning
Read Only:true
Maximum Length:80
The meaning of the result outcome. A list of accepted values is defined in the lookup type ORA_HER_OUTCOME_CODE. -
ResultId: integer
(int64)
Title:
Result ID
Read Only:true
The generated primary key column for a result related to the enrollment record. -
ResultSetCode: string
Title:
Code
Read Only:true
Maximum Length:30
The result set code of the result. Use result sets to support various types of measurement such as grades, units, and grade points. -
ResultSetId: integer
(int64)
Title:
Result Set ID
Read Only:true
The unique identifier of the result set. Use result sets to support various types of measurement such as grades, units, and grade points. -
ResultSetName: string
Title:
Name
Read Only:true
Maximum Length:50
The result set name, such as Letter Grade, of the result. -
ResultTypeCode: string
Title:
Result Type Code
Read Only:true
Maximum Length:30
The result type code of the result. An example of a result type is Course Result. -
StatusCode: string
Title:
Result Status
Read Only:true
Maximum Length:30
The status code of the result. A list of accepted values is defined in the lookup type ORA_HER_RESULT_STATUS. -
StatusMeaning: string
Title:
Result Status Meaning
Read Only:true
Maximum Length:80
The meaning of the status code of the result. A list of accepted values is defined in the lookup type ORA_HER_RESULT_STATUS. -
TextValue: string
Title:
Text Result
Read Only:true
Maximum Length:30
The result value in text format, such as a grade of A.
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.