Update a student credit transaction status.
patch
/fscmRestApi/resources/11.13.18.05/studentCreditPostings/{CreditPostingId}
Request
Path Parameters
-
CreditPostingId(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
-
StatusCode: string
Maximum Length:
30
Status code of the posted transaction.
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 : studentCreditPostings-item-response
Type:
Show Source
object
-
AcademicPeriodId: integer
(int64)
Unique identifier of the reporting academic period associated with the transaction.
-
AcademicPeriodName: string
Maximum Length:
50
Name of the reporting academic period associated with the credit transaction. -
Amount: number
Amount associated with the transaction.
-
CreationDate: string
(date-time)
Read Only:
true
Date when the transaction was created. -
CreditCode: string
Maximum Length:
30
Unique user-defined credit code. -
CreditId: integer
(int64)
Unique identifier of the credit.
-
CreditName: string
Read Only:
true
Maximum Length:50
Name of the credit. -
CreditPostingId: integer
(int64)
Read Only:
true
Unique identifier of the posted transaction. -
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. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
The currency code of the posted transaction. -
CurrencySymbol: string
Read Only:
true
Maximum Length:12
The symbol associated with the currency of the transaction. -
CustomerAccountNumber: string
Read Only:
true
Maximum Length:30
Unique identifier of the student's customer account. -
ExternalReferenceCode: string
Maximum Length:
100
The external reference code of the credit transaction. This can be used to sync credit transactions to Student Financial Planning. -
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. -
PostedDate: string
(date)
Read Only:
true
Date when the transaction was posted. -
StatusCode: string
Maximum Length:
30
Status code of the posted transaction. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
Status of the posted transaction. Valid values are posted, reversed, or error. -
StudentPartyId: integer
(int64)
Unique identifier of the student.
-
StudentPartyName: string
Maximum Length:
360
Name of the student.
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
- periodsLOV
-
Parameters:
- finder:
ByReportingPeriodFinder
The following properties are defined on the LOV link relation:- Source Attribute: AcademicPeriodName; Target Attribute: PeriodName
- Display Attribute: PeriodName
- finder:
- statusesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_TRANSACTION_POSTING%2CApplicationCode%3DHES
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- studentCredits
-
Parameters:
- finder:
CreditPostingFinder
The following properties are defined on the LOV link relation:- Source Attribute: CreditCode; Target Attribute: CreditCode
- Display Attribute: CreditName
- finder: