Update a charge priority mapping
patch
/fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}
Request
Path Parameters
-
ChargePriorityId(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
-
ChargePriorityName: string
Maximum Length:
50
Unique user-defined name of the charge priority. -
DefaultFlag: boolean
Maximum Length:
1
Indicates that the specific charge priority is the default. It can only be set to true if charge priority mapping is active based on the start and end dates. -
EndDate: string
(date)
Date from when the charge priority's validity ends.
-
feeGroupMappingDetails: array
Fee Group Mapping Details
Title:
Fee Group Mapping Details
The fee group mapping details resource is used to associate the fee group with the charge priority mapping. -
feeMappingDetails: array
Fee Mapping Details
Title:
Fee Mapping Details
The fee mapping details resource is used to associate individual fees with the charge priority mapping. -
feeTypeMappingDetails: array
Fee Type Mapping Details
Title:
Fee Type Mapping Details
The fee type mapping details resource is used to associate all fees with the charge priority mapping. -
StartDate: string
(date)
Date from when the charge priority is active.
Nested Schema : Fee Group Mapping Details
Type:
array
Title:
Fee Group Mapping Details
The fee group mapping details resource is used to associate the fee group with the charge priority mapping.
Show Source
Nested Schema : Fee Mapping Details
Type:
array
Title:
Fee Mapping Details
The fee mapping details resource is used to associate individual fees with the charge priority mapping.
Show Source
Nested Schema : Fee Type Mapping Details
Type:
array
Title:
Fee Type Mapping Details
The fee type mapping details resource is used to associate all fees with the charge priority mapping.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
FeeGroupCode: string
Maximum Length:
30
Unique user-defined fee group code. -
FeeGroupId: integer
(int64)
Unique identifier of the fee group.
-
MappingAttributeCode: string
Maximum Length:
30
Unique user-defined fee group mapping attribute code. -
MappingAttributeId: integer
(int64)
Unique identifier of the fee group mapping attribute.
-
Priority: integer
(int64)
Priority of the fee group in the mapping.
Nested Schema : schema
Type:
Show Source
object
-
FeeCode: string
Maximum Length:
30
Unique user-defined fee code. -
FeeId: integer
(int64)
Unique identifier of the fee.
-
MappingAttributeCode: string
Maximum Length:
30
Unique user-defined fee mapping attribute code. -
MappingAttributeId: integer
(int64)
Unique identifier of the fee mapping attribute.
-
Priority: integer
(int64)
Priority of the fee in the mapping.
Nested Schema : schema
Type:
Show Source
object
-
FeeTypeCode: string
Title:
Fee Type Code
Maximum Length:30
Unique user-defined fee type code. -
FeeTypeId: integer
(int64)
Unique identifier of the fee type.
-
MappingAttributeCode: string
Maximum Length:
30
Unique user-defined fee type mapping attribute code. -
MappingAttributeId: integer
(int64)
Unique identifier of the fee type mapping attribute.
-
Priority: integer
(int64)
Priority of the fee type in the mapping.
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 : chargePriorityMappings-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Unique identifier of the business unit.
-
BusinessUnitName: string
Title:
Business Unit
Maximum Length:240
Name of the business unit. -
ChargePriorityCode: string
Maximum Length:
30
Unique user-defined code of the charge priority. -
ChargePriorityId: integer
(int64)
Read Only:
true
Unique identifier of the charge priority. -
ChargePriorityName: string
Maximum Length:
50
Unique user-defined name of the charge priority. -
ChargePriorityTypeCode: string
Maximum Length:
30
Unique code for the charge priority type. A list of accepted values is defined in the lookup type ORA_HES_CHARGE_PRIORITY_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task. -
ChargePriorityTypeMeaning: string
Read Only:
true
Maximum Length:80
Name of the charge priority type. -
DefaultFlag: boolean
Maximum Length:
1
Indicates that the specific charge priority is the default. It can only be set to true if charge priority mapping is active based on the start and end dates. -
EndDate: string
(date)
Date from when the charge priority's validity ends.
-
feeGroupMappingDetails: array
Fee Group Mapping Details
Title:
Fee Group Mapping Details
The fee group mapping details resource is used to associate the fee group with the charge priority mapping. -
feeMappingDetails: array
Fee Mapping Details
Title:
Fee Mapping Details
The fee mapping details resource is used to associate individual fees with the charge priority mapping. -
feeTypeMappingDetails: array
Fee Type Mapping Details
Title:
Fee Type Mapping Details
The fee type mapping details resource is used to associate all fees with the charge priority mapping. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StartDate: string
(date)
Date from when the charge priority is active.
Nested Schema : Fee Group Mapping Details
Type:
array
Title:
Fee Group Mapping Details
The fee group mapping details resource is used to associate the fee group with the charge priority mapping.
Show Source
Nested Schema : Fee Mapping Details
Type:
array
Title:
Fee Mapping Details
The fee mapping details resource is used to associate individual fees with the charge priority mapping.
Show Source
Nested Schema : Fee Type Mapping Details
Type:
array
Title:
Fee Type Mapping Details
The fee type mapping details resource is used to associate all fees with the charge priority mapping.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : chargePriorityMappings-feeGroupMappingDetails-item-response
Type:
Show Source
object
-
FeeGroupCode: string
Maximum Length:
30
Unique user-defined fee group code. -
FeeGroupId: integer
(int64)
Unique identifier of the fee group.
-
FeeGroupMappingDetailId: integer
(int64)
Read Only:
true
Unique primary identifier of the fee group detail that's associated to the charge priority mapping. -
FeeGroupName: string
Read Only:
true
Maximum Length:50
Name of the fee group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingAttributeCode: string
Maximum Length:
30
Unique user-defined fee group mapping attribute code. -
MappingAttributeId: integer
(int64)
Unique identifier of the fee group mapping attribute.
-
MappingAttributeName: string
Read Only:
true
Maximum Length:50
Name of the fee group mapping attribute. -
Priority: integer
(int64)
Priority of the fee group in the mapping.
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.
Nested Schema : chargePriorityMappings-feeMappingDetails-item-response
Type:
Show Source
object
-
FeeCode: string
Maximum Length:
30
Unique user-defined fee code. -
FeeId: integer
(int64)
Unique identifier of the fee.
-
FeeMappingDetailId: integer
(int64)
Read Only:
true
Unique identifier of the fee associated to the charge priority. -
FeeName: string
Read Only:
true
Maximum Length:50
Name of the fee. -
FeeTypeCode: string
Title:
Fee Type Code
Read Only:true
Maximum Length:30
Unique user-defined code of the fee type. -
FeeTypeName: string
Title:
Fee Type Name
Read Only:true
Maximum Length:50
Name of the fee type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingAttributeCode: string
Maximum Length:
30
Unique user-defined fee mapping attribute code. -
MappingAttributeId: integer
(int64)
Unique identifier of the fee mapping attribute.
-
MappingAttributeName: string
Read Only:
true
Maximum Length:50
Name of the fee mapping attribute. -
Priority: integer
(int64)
Priority of the fee in the mapping.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : chargePriorityMappings-feeTypeMappingDetails-item-response
Type:
Show Source
object
-
FeeTypeCode: string
Title:
Fee Type Code
Maximum Length:30
Unique user-defined fee type code. -
FeeTypeId: integer
(int64)
Unique identifier of the fee type.
-
FeeTypeMappingDetailId: integer
(int64)
Read Only:
true
Unique primary identifier of the fee type detail that's associated to the charge priority mapping. -
FeeTypeName: string
Title:
Fee Type Name
Read Only:true
Maximum Length:50
Name of the fee type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingAttributeCode: string
Maximum Length:
30
Unique user-defined fee type mapping attribute code. -
MappingAttributeId: integer
(int64)
Unique identifier of the fee type mapping attribute.
-
MappingAttributeName: string
Read Only:
true
Maximum Length:50
Name of the fee type mapping attribute. -
Priority: integer
(int64)
Priority of the fee type in the mapping.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- chargePriorityTypesLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_CHARGE_PRIORITY_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: ChargePriorityTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- feeGroupMappingDetails
-
Parameters:
- ChargePriorityId:
$request.path.ChargePriorityId
The fee group mapping details resource is used to associate the fee group with the charge priority mapping. - ChargePriorityId:
- feeMappingDetails
-
Operation: /fscmRestApi/resources/11.13.18.05/chargePriorityMappings/{ChargePriorityId}/child/feeMappingDetailsParameters:
- ChargePriorityId:
$request.path.ChargePriorityId
The fee mapping details resource is used to associate individual fees with the charge priority mapping. - ChargePriorityId:
- feeTypeMappingDetails
-
Parameters:
- ChargePriorityId:
$request.path.ChargePriorityId
The fee type mapping details resource is used to associate all fees with the charge priority mapping. - ChargePriorityId:
- studentFinancialSystemConfigurationsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: BusinessUnitName; Target Attribute: Name
- Display Attribute: Name