Get a fee group

get

/fscmRestApi/resources/11.13.18.05/feeGroups/{FeeGroupId}

Request

Path Parameters
  • 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=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : feeGroups-item-response
Type: object
Show Source
Nested Schema : All Fees
Type: array
Title: All Fees
All fees that are part of the fee groups.
Show Source
Nested Schema : Fee Criteria
Type: array
Title: Fee Criteria
Criteria that determines fee attribute values that are used to dynamically retrieve fees into a list.
Show Source
Nested Schema : Fee Details
Type: array
Title: Fee Details
The fee details resource is used to associate the fees with the fee group.
Show Source
Nested Schema : Grouping Structures
Type: array
Title: Grouping Structures
Fee group structures define the method in which fees are grouped in a list.
Show Source
Nested Schema : Fee Lists
Type: array
Title: Fee Lists
Fees added to a list.
Show Source
Nested Schema : Tag Assignments
Type: array
Title: Tag Assignments
Tags assigned to a fee list.
Show Source
Nested Schema : feeGroups-allFees-item-response
Type: object
Show Source
Nested Schema : feeGroups-feeCriterias-item-response
Type: object
Show Source
Nested Schema : feeGroups-feeDetails-item-response
Type: object
Show Source
  • Title: Fee Code
    Maximum Length: 30
    Unique user-defined fee code.
  • Title: Fee Description
    Read Only: true
    Maximum Length: 240
    Description of the fee.
  • Title: Fee Detail ID
    Read Only: true
    Unique identifier of the fee detail.
  • Title: Fee ID
    Unique identifier of the fee associated with the fee group.
  • Title: Fee Name
    Read Only: true
    Maximum Length: 50
    Name of the fee.
  • Title: Fee Type Code
    Read Only: true
    Maximum Length: 30
    Unique code of the fee attribute type. A list of accepted values is defined in the lookup type ORA_HES_FEE_ATTRIBUTE_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
  • Title: Fee Type Name
    Read Only: true
    Maximum Length: 50
    Name of the fee type.
  • Links
Nested Schema : feeGroups-feeGroupStructures-item-response
Type: object
Show Source
Nested Schema : Structure Details
Type: array
Title: Structure Details
Details about the fee group structure, such as name and description.
Show Source
Nested Schema : feeGroups-feeGroupStructures-structureDetails-item-response
Type: object
Show Source
Nested Schema : feeGroups-feeLists-item-response
Type: object
Show Source
Nested Schema : feeGroups-tagAssignments-item-response
Type: object
Show Source
Back to Top