1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Student Accounts

Get all student accounts

get

/fscmRestApi/resources/11.13.18.05/studentAccounts

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

    • AccountFinder Finds the student account that matches the party ID.
      Finder Variables
      • PartyId; integer; Unique identifier for a student account.
    • PrimaryKey Finds all student accounts matching the primary key criteria specified.
      Finder Variables
      • AccountId; integer; Unique identifier for a student account.
  • 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:
    • AccountId; integer; Unique identifier for the account created for a student.
    • AccountNumber; string; Unique student account number assigned for display purposes.
    • AllowManualPaymentFlag; boolean; Indicates that the manual payment is allowed. The default value is false.
    • BalanceAmount; number; Total amount due on the student account.
    • BankAccountSupportFlag; boolean; Indicates whether the student can make a payment using their bank account details.
    • BusinessUnitId; integer; Unique identifier for a business unit.
    • BusinessUnitName; string; Name of the business unit.
    • CountryCode; string; A short alphabetic code representing the country that's used as the default address.
    • CreditCardSupportFlag; boolean; Indicates whether the student can make a payment using his credit card.
    • CurrencyCode; string; Currency code associated with the business unit.
    • CurrencySymbol; string; Currency symbol associated with the currency code.
    • CustomerAccountSiteUseId; integer; Unique identifier for the customer account site to be used for billing purposes. For example, student's home address instead of the dormitory address.
    • DueAmount; number; Amount due from the student.
    • DueDate; string; The date when the student must pay an amount due.
    • LastPaymentAmount; number; Amount of the last payment received from the student.
    • LastPaymentDate; string; The date when the last payment was received from the student.
    • ManualPaymentInformation; string; The detailed description for the manual payment.
    • PartySiteId; integer; Unique identifier of the party site, matching the customer account site. Primarily used to identify the default credit card address for making a payment.
    • PaymentOptionCode; string; The code of the payment option. Examples are ORA_IBY_CYBERSOURCE or ORA_OTHER_SERVICE_PROVIDER.
    • StudentPartyId; integer; Unique identifier for a student.
  • 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 : studentAccounts
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : studentAccounts-item-response
Type: object
Show Source
Nested Schema : Account Relationships
Type: array
Title: Account Relationships
The account relationships resource is a child of the student accounts resource. It lists the financial accounts that are actively related to this student account.
Show Source
Nested Schema : Bills
Type: array
Title: Bills
The bills resource is a child of the student account resource and provides a list of bill numbers for a student account.
Show Source
Nested Schema : Transaction Applications
Type: array
Title: Transaction Applications
The transaction applications resource is a child of the student accounts resource. It lists all the payments applied to a charge for a student account.
Show Source
Nested Schema : Transactions
Type: array
Title: Transactions
The transactions resource is a child of the student accounts resource and provides a list of charges and payments for a student account.
Show Source
Nested Schema : studentAccounts-accountRelationships-item-response
Type: object
Show Source
Nested Schema : studentAccounts-bills-item-response
Type: object
Show Source
Nested Schema : studentAccounts-transactionApplications-item-response
Type: object
Show Source
Nested Schema : studentAccounts-transactions-item-response
Type: object
Show Source
Nested Schema : Transaction Activities
Type: array
Title: Transaction Activities
The transaction activities resource is a child of the transactions resource. For a charge, it lists the initial charge details and any changes in the amount of the charge, such as a charge reversal, or a discount. For a payment, it lists any refunds emanating from that payment.
Show Source
Nested Schema : studentAccounts-transactions-transactionActivities-item-response
Type: object
Show Source
Back to Top