1. REST API for Oracle Fusion Cloud Student Management
  2. Tasks
  3. Transaction Reference Contexts

Get a transaction reference context

get

/fscmRestApi/resources/11.13.18.05/transactionReferenceContexts/{transactionReferenceContextsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Transaction Reference Contexts resource and used to uniquely identify an instance of Transaction Reference Contexts. The client should not generate the hash key value. Instead, the client should query on the Transaction Reference Contexts collection resource in order to navigate to a specific instance of Transaction Reference Contexts to get the hash key.
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 : transactionReferenceContexts-item-response
Type: object
Show Source
Nested Schema : Admission Applications
Type: array
Title: Admission Applications
The admission applications resource provides financial transaction records about a student's course application.
Show Source
Nested Schema : Carts
Type: array
Title: Carts
The carts resource provides the active cart information for the specific user.
Show Source
Nested Schema : Student Accounts
Type: array
Title: Student Accounts
The student accounts resource provides the account information for the specific user.
Show Source
Nested Schema : transactionReferenceContexts-admissionApplications-item-response
Type: object
Show Source
Nested Schema : Course Selections
Type: array
Title: Course Selections
The course selections resource captures course preference selections for an admissions application.
Show Source
Nested Schema : Object Fees
Type: array
Title: Object Fees
The object fees resource lists all the different fees on the student application.
Show Source
Nested Schema : transactionReferenceContexts-admissionApplications-courseSelections-item-response
Type: object
Show Source
Nested Schema : transactionReferenceContexts-admissionApplications-ObjectFees-item-response
Type: object
Show Source
Nested Schema : transactionReferenceContexts-carts-item-response
Type: object
Show Source
Nested Schema : Miscellaneous Fee Items
Type: array
Title: Miscellaneous Fee Items
The miscellaneous fee items resource provides a list of miscellaneous fee items present in the cart.
Show Source
Nested Schema : Scheduled Course Items
Type: array
Title: Scheduled Course Items
The scheduled course items resource provides a list of scheduled course items present in the cart.
Show Source
Nested Schema : transactionReferenceContexts-carts-miscellaneousFeeItems-item-response
Type: object
Show Source
  • Title: Miscellaneous Fee Cart ID
    Read Only: true
    The unique identifier of the cart detail of the miscellaneous fee item.
  • Title: Currency Code
    Read Only: true
    Maximum Length: 15
    The currency code associated with a miscellaneous fee.
  • Title: Currency Symbol
    Read Only: true
    The currency symbol associated with a miscellaneous fee.
  • Title: Discount Amount
    Read Only: true
    The numeric value of the discount amount given for a miscellaneous item.
  • Title: Fee Attribute Long Description
    Read Only: true
    Maximum Length: 240
    The detailed description for the miscellaneous fee attribute.
  • Title: Fee Attribute Transaction Description
    Read Only: true
    Maximum Length: 100
    The invoices and credit memos description.
  • Title: Fee Category Name
    Read Only: true
    Maximum Length: 50
    The name of the fee category.
  • Title: Amount
    Read Only: true
    The amount that will be charged for the fee. For example, a flat fee amount could be charged regardless of whether the student is an undergraduate or graduate student.
  • Links
Nested Schema : transactionReferenceContexts-carts-scheduledCourseItems-item-response
Type: object
Show Source
Nested Schema : transactionReferenceContexts-studentAccounts-item-response
Type: object
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 : transactionReferenceContexts-studentAccounts-bills-item-response
Type: object
Show Source
Nested Schema : transactionReferenceContexts-studentAccounts-transactionApplications-item-response
Type: object
Show Source
Nested Schema : transactionReferenceContexts-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 : transactionReferenceContexts-studentAccounts-transactions-transactionActivities-item-response
Type: object
Show Source
Links
admissionApplications
Parameters:
  • transactionReferenceContextsUniqID: $request.path.transactionReferenceContextsUniqID
The admission applications resource provides financial transaction records about a student's course application.
carts
Parameters:
  • transactionReferenceContextsUniqID: $request.path.transactionReferenceContextsUniqID
The carts resource provides the active cart information for the specific user.
studentAccounts
Parameters:
  • transactionReferenceContextsUniqID: $request.path.transactionReferenceContextsUniqID
The student accounts resource provides the account information for the specific user.
Back to Top