1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. External Fund Credits

Get all external fund credits

get

/fscmRestApi/resources/11.13.18.05/studentCreditExternalFunds

Request

Query Parameters
  • 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
  • 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 external fund credit that matches the primary key criteria specified.
      Finder Variables
      • CreditId; integer; The unique identifier of the student external fund credit.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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; The unique identifier of the academic business unit.
    • BusinessUnitName; string; The name of the academic business unit.
    • ChargePriorityCode; string; The unique code of the charge priority mapping rule.
    • ChargePriorityId; integer; The unique identifier of the charge priority mapping rule.
    • ChargePriorityName; string; The name of the charge priority mapping rule.
    • CreditCode; string; The unique code to identify the student credit.
    • CreditDescription; string; The description of the student credit.
    • CreditId; integer; The unique identifier of the student credit.
    • CreditName; string; The name of the student credit.
    • CreditReferenceCode; string; The credit reference code of the student credit.
    • CreditReferenceMeaning; string; The name of the credit reference code.
    • CreditSourceCode; string; The unique code of the source of credit.
    • CreditSourceMeaning; string; The name of the source of the credit.
    • CurrencyCode; string; The currency code associated with the student credit.
    • MaximumAmount; number; Maximum amount of the credit.
    • MemoLineId; integer; The identifier of the memo line assigned to a transaction. The memo line designates a revenue account.
    • MemoLineName; string; The name of the memo line assigned to a transaction.
    • Priority; integer; The priority in which a credit is processed.
    • ReceivableActivityId; integer; The identifier of the receivables activity assigned to a transaction.
    • ReceivableActivityName; string; The name of the receivables activity assigned to a transaction.
    • RefundableFlag; boolean; Indicates whether an excess student credit amount can be refunded. If the value is true, the credit is refundable.
    • StatusCode; string; The activation status of the student credit.
    • StatusMeaning; string; The activation status name of the student credit.
    • TransactionTypeId; integer; The transaction type of the student credit setup.
    • TransactionTypeName; string; The name of the transaction type of the student credit setup.
  • 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
  • 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 : studentCreditExternalFunds
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : studentCreditExternalFunds-item-response
Type: object
Show Source
Nested Schema : Period Overrides
Type: array
Title: Period Overrides
The period overrides resource lists all the academic periods that are excluded from the external fund credits.
Show Source
Nested Schema : studentCreditExternalFunds-periodOverrides-item-response
Type: object
Show Source
Back to Top