GET api/villagebank

Get all village banks with associated portfolio group.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/villagebank. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

  • OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns an array of all village banks with associated portfolio group.

Collection of VillageBankDto
NameDescriptionTypeAdditional information
VillageBankId

Unique identifier of village bank.

integer
Name

Village bank name.

string
CUAccountPortfolioGroupId

Account portfolio group to which village bank belongs to.

integer
CUAccountPortfolioId

Account portfolio associated village bank.

integer

Response Formats

application/json, text/json

Sample:
[
  {
    "villageBankId": 1,
    "name": "sample string 1",
    "cuAccountPortfolioGroupId": 1,
    "cuAccountPortfolioId": 1
  },
  {
    "villageBankId": 1,
    "name": "sample string 1",
    "cuAccountPortfolioGroupId": 1,
    "cuAccountPortfolioId": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfVillageBankDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <VillageBankDto>
    <CUAccountPortfolioGroupId>1</CUAccountPortfolioGroupId>
    <CUAccountPortfolioId>1</CUAccountPortfolioId>
    <Name>sample string 1</Name>
    <VillageBankId>1</VillageBankId>
  </VillageBankDto>
  <VillageBankDto>
    <CUAccountPortfolioGroupId>1</CUAccountPortfolioGroupId>
    <CUAccountPortfolioId>1</CUAccountPortfolioId>
    <Name>sample string 1</Name>
    <VillageBankId>1</VillageBankId>
  </VillageBankDto>
</ArrayOfVillageBankDto>