Get a bank branch
get
/fscmRestApi/resources/11.13.18.05/cashBankBranches/{BranchPartyId}
Request
Path Parameters
-
BranchPartyId(required): integer(int64)
The unique identifier of the bank branch.Default Value:
1
Query Parameters
-
dependency: string
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> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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:
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.
Root Schema : cashBankBranches-item-response
Type:
Show Source
object
-
BankBranchName: string
Title:
Branch Name
Maximum Length:360
The name of the bank branch. -
BankBranchNameAlt: string
Title:
Alternate Branch Name
Maximum Length:360
The alternate name of the bank branch. -
BankBranchType: string
Title:
Bank Branch Type
Maximum Length:255
The type of banking institution to which the bank branch belongs. For example, ABA (American Bankers Association), CHIPS (Clearing House Interbank Payment System), SWIFT (Society for Worldwide Interbank Financial Telecommunication), or Other. -
BankName: string
Maximum Length:
360
The name of the bank associated with the bank branch. -
BankNameAlt: string
Title:
Alternate Bank Name
Maximum Length:360
The alternate name of the bank associated with the bank branch. -
BankNumber: string
Title:
Bank Code
Maximum Length:30
The code of the bank associated with the bank branch. -
BankPartyNumber: string
Read Only:
true
Maximum Length:30
The unique party identification number of the bank. -
BranchNumber: string
Title:
Branch Number
Maximum Length:30
The number of the bank branch. For banks based in Australia and New Zealand, it represents the Bank State Branch. For banks based in the United Kingdom, Ireland, Jersey, Guernsey, and Isle of Man, it represents the Sort Code. For banks based in the United States and Canada, it represents the Routing Number. For banks based in India, it represents the Indian Financial System Code (IFSC Code). -
BranchNumberType: string
Title:
Branch Number Type
Maximum Length:255
The type of the bank branch number. For example, CHIPS Code, CHIPS participant ID, Fed Wire routing number. -
BranchPartyId: integer
(int64)
Title:
Bank Branch ID
Default Value:1
The unique identifier of the bank branch. -
BranchPartyNumber: string
Title:
Branch Party Number
Maximum Length:30
Default Value:1
The unique party identification number of the bank branch. -
CountryName: string
Maximum Length:
80
The name of the country where the bank branch is located. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the bank branch. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the bank branch was created. -
Description: string
Title:
Description
Maximum Length:2000
The description of the bank branch. -
EDIIdNumber: string
Title:
EDI ID Number
Maximum Length:30
The number used by the bank in electronic data interchange. -
EDILocation: string
Title:
EDI Location
Maximum Length:40
The name of the location of the electronic data interchange (EDI) for the bank. -
EFTSWIFTCode: string
Title:
BIC Code
Maximum Length:30
The bank identifier code (BIC) used by SWIFT to identify a bank or a bank branch. The BIC is a universal method of identifying financial institutions to facilitate the automated processing of telecommunication messages in banking and related financial environments. -
EFTUserNumber: string
Title:
EFT Number
Maximum Length:30
The user number of the enterprise's electronic funds transfer (EFT). This number is used for identification and validation in the electronic funds transfer. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the bank branch was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the bank branch. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the bank branch. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RFCIdentifier: string
Title:
RFC Identifier
Maximum Length:255
The code identifier of the Regional Finance Center (RFC). RFC is considered a bank branch of the US Treasury bank and is responsible for the disbursement of public monies on behalf of some federal agencies.
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.
Examples
The following example shows how to retrieve a bank branch by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankBranches/300100188229418
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "BankName" : "REST_CE_Bank_01", "BankNameAlt" : "REST_CE_Bank_01_Alt", "BranchPartyId" : "300100188229418", "BankNumber" : "87698001", ... "links" : [ { "rel" : "self", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankBranches/300100188229418", "name" : "cashBankBranches", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/cashBankBranches/300100188229418", "name" : "cashBankBranches", "kind" : "item" }, ... ] }