GET api/FinancialInstitution/GetFinancialInstitutionList?skip={skip}&take={take}&field={field}&reverse={reverse}&includeDeleted={includeDeleted}&CountryID={CountryID}

Request Information

URI Parameters

Name	Type	Additional information
skip	integer	Required
take	integer	Required
field	string	Required
reverse	boolean	Required
includeDeleted	boolean	Required
CountryID	string	Default value is

Body Parameters

None.

Response Information

Resource Description

PaginationOfFinancialInstitution

Name	Type	Additional information
IsAllSuccess	boolean	None.
Items	Collection of FinancialInstitution	None.
UnPaginatedItems	Collection of FinancialInstitution	None.
FullCount	integer	None.
Skip	integer	None.
Take	integer	None.
Properties	Dictionary of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "IsAllSuccess": true,
  "Items": [
    {
      "FinancialInstitutionId": "6ff8758e-c7c3-4a48-a684-918e134ff5fe",
      "FinancialInstitutionName": "sample string 2",
      "FinancialInstitutionCode": "sample string 3",
      "IsDeleted": true,
      "IsTestBank": true,
      "IsInUse": true,
      "FinancialInstitutionCountryCode": "sample string 7",
      "FinancialInstitutionCountryId": "d23d6b36-f138-4c11-96ae-ee9113fea69a",
      "CountryId": "4aa98295-969c-42ba-954c-9325b9ea746b",
      "CountryCode": "sample string 10",
      "CountryName": "sample string 11",
      "CurrencyCode": "sample string 12"
    },
    {
      "FinancialInstitutionId": "6ff8758e-c7c3-4a48-a684-918e134ff5fe",
      "FinancialInstitutionName": "sample string 2",
      "FinancialInstitutionCode": "sample string 3",
      "IsDeleted": true,
      "IsTestBank": true,
      "IsInUse": true,
      "FinancialInstitutionCountryCode": "sample string 7",
      "FinancialInstitutionCountryId": "d23d6b36-f138-4c11-96ae-ee9113fea69a",
      "CountryId": "4aa98295-969c-42ba-954c-9325b9ea746b",
      "CountryCode": "sample string 10",
      "CountryName": "sample string 11",
      "CurrencyCode": "sample string 12"
    }
  ],
  "UnPaginatedItems": [
    {
      "FinancialInstitutionId": "6ff8758e-c7c3-4a48-a684-918e134ff5fe",
      "FinancialInstitutionName": "sample string 2",
      "FinancialInstitutionCode": "sample string 3",
      "IsDeleted": true,
      "IsTestBank": true,
      "IsInUse": true,
      "FinancialInstitutionCountryCode": "sample string 7",
      "FinancialInstitutionCountryId": "d23d6b36-f138-4c11-96ae-ee9113fea69a",
      "CountryId": "4aa98295-969c-42ba-954c-9325b9ea746b",
      "CountryCode": "sample string 10",
      "CountryName": "sample string 11",
      "CurrencyCode": "sample string 12"
    },
    {
      "FinancialInstitutionId": "6ff8758e-c7c3-4a48-a684-918e134ff5fe",
      "FinancialInstitutionName": "sample string 2",
      "FinancialInstitutionCode": "sample string 3",
      "IsDeleted": true,
      "IsTestBank": true,
      "IsInUse": true,
      "FinancialInstitutionCountryCode": "sample string 7",
      "FinancialInstitutionCountryId": "d23d6b36-f138-4c11-96ae-ee9113fea69a",
      "CountryId": "4aa98295-969c-42ba-954c-9325b9ea746b",
      "CountryCode": "sample string 10",
      "CountryName": "sample string 11",
      "CurrencyCode": "sample string 12"
    }
  ],
  "FullCount": 2,
  "Skip": 3,
  "Take": 4,
  "Properties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<PaginationOfFinancialInstitutionvO27xaco xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common">
  <FullCount>2</FullCount>
  <IsAllSuccess>true</IsAllSuccess>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.FinancialInstitution">
    <d2p1:FinancialInstitution>
      <d2p1:CountryCode>sample string 10</d2p1:CountryCode>
      <d2p1:CountryId>4aa98295-969c-42ba-954c-9325b9ea746b</d2p1:CountryId>
      <d2p1:CountryName>sample string 11</d2p1:CountryName>
      <d2p1:CurrencyCode>sample string 12</d2p1:CurrencyCode>
      <d2p1:FinancialInstitutionCode>sample string 3</d2p1:FinancialInstitutionCode>
      <d2p1:FinancialInstitutionCountryCode>sample string 7</d2p1:FinancialInstitutionCountryCode>
      <d2p1:FinancialInstitutionCountryId>d23d6b36-f138-4c11-96ae-ee9113fea69a</d2p1:FinancialInstitutionCountryId>
      <d2p1:FinancialInstitutionId>6ff8758e-c7c3-4a48-a684-918e134ff5fe</d2p1:FinancialInstitutionId>
      <d2p1:FinancialInstitutionName>sample string 2</d2p1:FinancialInstitutionName>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:IsInUse>true</d2p1:IsInUse>
      <d2p1:IsTestBank>true</d2p1:IsTestBank>
    </d2p1:FinancialInstitution>
    <d2p1:FinancialInstitution>
      <d2p1:CountryCode>sample string 10</d2p1:CountryCode>
      <d2p1:CountryId>4aa98295-969c-42ba-954c-9325b9ea746b</d2p1:CountryId>
      <d2p1:CountryName>sample string 11</d2p1:CountryName>
      <d2p1:CurrencyCode>sample string 12</d2p1:CurrencyCode>
      <d2p1:FinancialInstitutionCode>sample string 3</d2p1:FinancialInstitutionCode>
      <d2p1:FinancialInstitutionCountryCode>sample string 7</d2p1:FinancialInstitutionCountryCode>
      <d2p1:FinancialInstitutionCountryId>d23d6b36-f138-4c11-96ae-ee9113fea69a</d2p1:FinancialInstitutionCountryId>
      <d2p1:FinancialInstitutionId>6ff8758e-c7c3-4a48-a684-918e134ff5fe</d2p1:FinancialInstitutionId>
      <d2p1:FinancialInstitutionName>sample string 2</d2p1:FinancialInstitutionName>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:IsInUse>true</d2p1:IsInUse>
      <d2p1:IsTestBank>true</d2p1:IsTestBank>
    </d2p1:FinancialInstitution>
  </Items>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Properties>
  <Skip>3</Skip>
  <Take>4</Take>
  <UnPaginatedItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.FinancialInstitution">
    <d2p1:FinancialInstitution>
      <d2p1:CountryCode>sample string 10</d2p1:CountryCode>
      <d2p1:CountryId>4aa98295-969c-42ba-954c-9325b9ea746b</d2p1:CountryId>
      <d2p1:CountryName>sample string 11</d2p1:CountryName>
      <d2p1:CurrencyCode>sample string 12</d2p1:CurrencyCode>
      <d2p1:FinancialInstitutionCode>sample string 3</d2p1:FinancialInstitutionCode>
      <d2p1:FinancialInstitutionCountryCode>sample string 7</d2p1:FinancialInstitutionCountryCode>
      <d2p1:FinancialInstitutionCountryId>d23d6b36-f138-4c11-96ae-ee9113fea69a</d2p1:FinancialInstitutionCountryId>
      <d2p1:FinancialInstitutionId>6ff8758e-c7c3-4a48-a684-918e134ff5fe</d2p1:FinancialInstitutionId>
      <d2p1:FinancialInstitutionName>sample string 2</d2p1:FinancialInstitutionName>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:IsInUse>true</d2p1:IsInUse>
      <d2p1:IsTestBank>true</d2p1:IsTestBank>
    </d2p1:FinancialInstitution>
    <d2p1:FinancialInstitution>
      <d2p1:CountryCode>sample string 10</d2p1:CountryCode>
      <d2p1:CountryId>4aa98295-969c-42ba-954c-9325b9ea746b</d2p1:CountryId>
      <d2p1:CountryName>sample string 11</d2p1:CountryName>
      <d2p1:CurrencyCode>sample string 12</d2p1:CurrencyCode>
      <d2p1:FinancialInstitutionCode>sample string 3</d2p1:FinancialInstitutionCode>
      <d2p1:FinancialInstitutionCountryCode>sample string 7</d2p1:FinancialInstitutionCountryCode>
      <d2p1:FinancialInstitutionCountryId>d23d6b36-f138-4c11-96ae-ee9113fea69a</d2p1:FinancialInstitutionCountryId>
      <d2p1:FinancialInstitutionId>6ff8758e-c7c3-4a48-a684-918e134ff5fe</d2p1:FinancialInstitutionId>
      <d2p1:FinancialInstitutionName>sample string 2</d2p1:FinancialInstitutionName>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:IsInUse>true</d2p1:IsInUse>
      <d2p1:IsTestBank>true</d2p1:IsTestBank>
    </d2p1:FinancialInstitution>
  </UnPaginatedItems>
</PaginationOfFinancialInstitutionvO27xaco>