Update a student credit assignment
patch
/fscmRestApi/resources/11.13.18.05/studentCreditAssignments/{CreditAssignmentId}
Request
Path Parameters
-
CreditAssignmentId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
AssignmentStatusCode: string
Maximum Length:
30
The unique code of the status of the student credit assignment. -
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. -
EligibilityEndDate: string
(date)
The date when the eligibility for waiver by amount ends.
-
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.
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 : studentCreditAssignments-creditCurriculums-item-patch-request
Type:
Show Source
object
-
CurriculumId: integer
(int64)
Unique identifier of the curriculum.
-
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.
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 : 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.
Links
- creditAmountTypeCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_CREDIT_AMOUNT_TYPE%2CApplicationCode%3DHES
The following properties are defined on the LOV link relation:- Source Attribute: AmountTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- creditAssignmentStatusCodesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_CRD_ASSIGN_STAT_CODE
The following properties are defined on the LOV link relation:- Source Attribute: AssignmentStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- creditCurriculums
-
Parameters:
- CreditAssignmentId:
$request.path.CreditAssignmentId
The credit curriculum resource is used to associate a curriculum to a student that's assigned to a sponsorship credit. - CreditAssignmentId:
- creditsLOV
-
Parameters:
- finder:
AssignableCreditFinder
The following properties are defined on the LOV link relation:- Source Attribute: CreditCode; Target Attribute: CreditCode
- Display Attribute: CreditName
- finder: