Get all charge priority mappings
get
/fscmRestApi/resources/11.13.18.05/chargePriorityMappings
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- PrimaryKey Finds the charge priority mapping that matches the primary key criteria specified.
Finder Variables- ChargePriorityId; integer; The unique identifier of the charge priority mapping.
- PrimaryKey Finds the charge priority mapping that matches 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:- BusinessUnitId; integer; Unique identifier of the business unit.
- BusinessUnitName; string; Name of the business unit.
- ChargePriorityCode; string; Unique user-defined code of the charge priority.
- ChargePriorityId; integer; Unique identifier of the charge priority.
- ChargePriorityName; string; Unique user-defined name of the charge priority.
- ChargePriorityTypeCode; string; 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; Name of the charge priority type.
- DefaultFlag; boolean; 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 from when the charge priority's validity ends.
- StartDate; string; Date from when the charge priority is active.
-
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 : chargePriorityMappings
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 : 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