GET v1/BankRoutes

Description

Retrieve list of BankRoutes satisfying the input search criteria.

Base Url

https://api-ppc.wsohosting.com/

Rest Call Syntax


GET Reference/v1/BankRoutes

Execute API

GET Reference/v1/BankRoutes

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete



Limitations

There are no limitations specified.



Request Information


Parameters

Name

Description

Type

Additional Information

BankNameStartsWith

Bank name .

string

IdentifierStartsWith

Identifier Starts With

string

IsDeleted

IsDeleted value to search

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer



Response Information



PagedList Of BankRoute

Name

Description

Type

Additional Information

Items

Collection of BankRoute

Links

Collection of Link

PagingInformation



Response Body Formats



application/json, text/json

Sample: 
{
  "items": [
    {
      "id": 1,
      "aba": "sample string 2",
      "bankName": "sample string 3",
      "bic": "sample string 4",
      "sortCode": "sample string 5",
      "isDeleted": true,
      "addId": "sample string 8",
      "addNode": "sample string 9",
      "addDate": "2025-11-08T05:33:17.1810777-05:00",
      "lastChangeId": "sample string 11",
      "lastChangeNode": "sample string 12",
      "lastChangeDate": "2025-11-08T05:33:17.1810777-05:00",
      "links": [
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        },
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        }
      ],
      "udfs": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      }
    },
    {
      "id": 1,
      "aba": "sample string 2",
      "bankName": "sample string 3",
      "bic": "sample string 4",
      "sortCode": "sample string 5",
      "isDeleted": true,
      "addId": "sample string 8",
      "addNode": "sample string 9",
      "addDate": "2025-11-08T05:33:17.1810777-05:00",
      "lastChangeId": "sample string 11",
      "lastChangeNode": "sample string 12",
      "lastChangeDate": "2025-11-08T05:33:17.1810777-05:00",
      "links": [
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        },
        {
          "verb": "sample string 1",
          "rel": "sample string 2",
          "uri": "http://webapihelppage3.com"
        }
      ],
      "udfs": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      }
    }
  ],
  "pagingInformation": {
    "totalItems": 1,
    "totalPages": 2,
    "itemsPerPage": 3,
    "currentPage": 4,
    "startRow": 5,
    "endRow": 6
  },
  "links": [
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    },
    {
      "verb": "sample string 1",
      "rel": "sample string 2",
      "uri": "http://webapihelppage3.com"
    }
  ]
}

application/xml, text/xml

Sample: 
<PagedListOfBankRoute xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <BankRoute>
      <ABA>sample string 2</ABA>
      <AddDate>2025-11-08T05:33:17.1810777-05:00</AddDate>
      <AddId>sample string 8</AddId>
      <AddNode>sample string 9</AddNode>
      <BIC>sample string 4</BIC>
      <BankName>sample string 3</BankName>
      <Id>1</Id>
      <IsDeleted>true</IsDeleted>
      <LastChangeDate>2025-11-08T05:33:17.1810777-05:00</LastChangeDate>
      <LastChangeId>sample string 11</LastChangeId>
      <LastChangeNode>sample string 12</LastChangeNode>
      <Links>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
      </Links>
      <SortCode>sample string 5</SortCode>
      <Udfs>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Udfs>
    </BankRoute>
    <BankRoute>
      <ABA>sample string 2</ABA>
      <AddDate>2025-11-08T05:33:17.1810777-05:00</AddDate>
      <AddId>sample string 8</AddId>
      <AddNode>sample string 9</AddNode>
      <BIC>sample string 4</BIC>
      <BankName>sample string 3</BankName>
      <Id>1</Id>
      <IsDeleted>true</IsDeleted>
      <LastChangeDate>2025-11-08T05:33:17.1810777-05:00</LastChangeDate>
      <LastChangeId>sample string 11</LastChangeId>
      <LastChangeNode>sample string 12</LastChangeNode>
      <Links>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
        <Link>
          <Rel>sample string 2</Rel>
          <Uri>http://webapihelppage3.com/</Uri>
          <Verb>sample string 1</Verb>
        </Link>
      </Links>
      <SortCode>sample string 5</SortCode>
      <Udfs>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Udfs>
    </BankRoute>
  </Items>
  <Links>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
    <Link>
      <Rel>sample string 2</Rel>
      <Uri>http://webapihelppage3.com/</Uri>
      <Verb>sample string 1</Verb>
    </Link>
  </Links>
  <PagingInformation>
    <CurrentPage>4</CurrentPage>
    <EndRow>6</EndRow>
    <ItemsPerPage>3</ItemsPerPage>
    <StartRow>5</StartRow>
    <TotalItems>1</TotalItems>
    <TotalPages>2</TotalPages>
  </PagingInformation>
</PagedListOfBankRoute>


Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.