Get all student credit assignments
get
/fscmRestApi/resources/11.13.18.05/studentCreditAssignments
Request
Query Parameters
-
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- AltKey Finds the student credit assignment with the specified alternate key.
Finder Variables- CreditId; integer; The unique identifier of the student credit.
- CreditPeriodId; integer; The unique identifier of the student credit period.
- StudentPartyId; integer; Unique identifier of the student.
- PrimaryKey Finds the student credit that matches the specified primary key.
Finder Variables- CreditAssignmentId; integer; Unique identifier of the student credit.
- AltKey Finds the student credit assignment with the specified alternate key.
-
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:- AcademicPeriodEndDate; string; The date when the academic period ends.
- AcademicPeriodId; integer; Unique identifier of the academic period.
- AcademicPeriodName; string; Name of the academic period.
- AcademicPeriodStartDate; string; The date when the academic period starts.
- AllCurriculumFlag; boolean; Indicates whether the curriculum is derived from the sponsorship credit or from the academic period. If the value is true, the curriculum list comes from the sponsorship credit.
- Amount; number; The amount of the student credit assignment.
- AmountTypeCode; string; The unique code of the amount type.
- AmountTypeMeaning; string; The name of the amount type.
- AssignmentStatusCode; string; The unique code of the status of the student credit assignment.
- AssignmentStatusMeaning; string; The name of the status of the student credit assignment.
- CreationDate; string; Date when the transaction was created.
- CreditAssignmentId; integer; The unique identifier of the student credit assignment.
- CreditCode; string; The unique code to identify the student credit.
- CreditId; integer; The unique identifier of the student credit.
- CreditName; string; The name of the student credit.
- CreditPeriodDescription; string; The description of the student credit period.
- CreditPeriodId; integer; The unique identifier of the student credit period.
- CreditTypeCode; string; Code of the credit type.
- CreditTypeId; integer; Unique identifier of the credit type.
- CreditTypeName; string; Name of the credit type. It can be external funds, waivers, and so on.
- EligibilityEndDate; string; The date when the eligibility for waiver by amount ends.
- LastUpdateDate; string; Date when the transaction was last updated.
- MaximumAmount; number; Maximum amount of the credit.
- OverrideAmountFlag; boolean; Indicates whether the student credit assignment overrides existing setup. If the value is true, the credit attributes will override the default setup.
- StudentEmailAddress; string; The primary email address of the student.
- StudentPartyId; integer; Unique identifier of the student.
- StudentPartyName; string; Name of the student.
-
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 : studentCreditAssignments
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 : studentCreditAssignments-item-response
Type:
Show Source
object
-
AcademicPeriodEndDate: string
(date)
Title:
End Date
Read Only:true
The date when the academic period ends. -
AcademicPeriodId: integer
(int64)
Read Only:
true
Unique identifier of the academic period. -
AcademicPeriodName: string
Title:
Period Name
Read Only:true
Maximum Length:50
Name of the academic period. -
AcademicPeriodStartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the academic period starts. -
AllCurriculumFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the curriculum is derived from the sponsorship credit or from the academic period. If the value is true, the curriculum list comes from the sponsorship credit. -
Amount: number
The amount of the student credit assignment.
-
AmountTypeCode: string
Maximum Length:
255
The unique code of the amount type. -
AmountTypeMeaning: string
Read Only:
true
Maximum Length:80
The name of the amount type. -
AssignmentStatusCode: string
Maximum Length:
30
The unique code of the status of the student credit assignment. -
AssignmentStatusMeaning: string
Read Only:
true
Maximum Length:80
The name of the status of the student credit assignment. -
CreationDate: string
(date-time)
Read Only:
true
Date when the transaction was created. -
CreditAssignmentId: integer
(int64)
Read Only:
true
The unique identifier of the student credit assignment. -
CreditCode: string
Maximum Length:
30
The unique code to identify the student credit. -
creditCurriculums: array
Credit Curriculums
Title:
Credit Curriculums
The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit. -
CreditId: integer
(int64)
The unique identifier of the student credit.
-
CreditName: string
Read Only:
true
Maximum Length:50
The name of the student credit. -
CreditPeriodDescription: string
Read Only:
true
Maximum Length:240
The description of the student credit period. -
CreditPeriodId: integer
(int64)
The unique identifier of the student credit period.
-
CreditTypeCode: string
Read Only:
true
Maximum Length:30
Code of the credit type. -
CreditTypeId: integer
(int64)
Read Only:
true
Unique identifier of the credit type. -
CreditTypeName: string
Read Only:
true
Maximum Length:50
Name of the credit type. It can be external funds, waivers, and so on. -
CustomerAccountNumber: string
Read Only:
true
Maximum Length:255
Unique identifier of the student's customer account. -
EligibilityEndDate: string
(date)
The date when the eligibility for waiver by amount ends.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the transaction was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumAmount: number
Maximum amount of the credit.
-
OverrideAmountFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the student credit assignment overrides existing setup. If the value is true, the credit attributes will override the default setup. -
StudentEmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The primary email address of the student. -
StudentPartyId: integer
(int64)
Unique identifier of the student.
-
StudentPartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the student.
Nested Schema : Credit Curriculums
Type:
array
Title:
Credit Curriculums
The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : studentCreditAssignments-creditCurriculums-item-response
Type:
Show Source
object
-
CreditCurriculumId: integer
(int64)
Unique identifier of the curriculum assigned to the student for a particular credit.
-
CurriculumId: integer
(int64)
Unique identifier of the curriculum.
-
CurriculumName: string
Title:
Name
Read Only:true
Maximum Length:50
Name of the curriculum. -
CurriculumType: string
Title:
Curriculum Item Type
Read Only:true
Maximum Length:30
Full description of the curriculum type. -
CurriculumTypeId: string
Read Only:
true
Unique identifier of the type associated with the curriculum. It can be course, scheduled course, program, or course list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StatusCode: string
Maximum Length:
30
Status of the student's curriculum assignment for a particular credit. Contains these values: active or inactive. The default value is active. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
Full description of the student's curriculum assignment status for a particular credit.
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.