GET v1/Portfolios/{id}/BankAccounts

Description

Retrieve list of portfolioBankAccount defined for portfolio with a WSO ID of {id}.

Base Url

https://api-sim.uat.wsohosting.com/


Rest Call Syntax


GET Reference/v1/Portfolios/{id}/BankAccounts

GET Reference/v1/Portfolios/{id}/BankAccounts

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

id

WSO ID of portfolio

integer

Required

IsDeleted

This flag will allow the return of deleted PortfolioBankAccounts in the search results

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer




Response Information



PagedList Of PortfolioBankAccount

Name

Description

Type

Additional Information

Items

Collection of PortfolioBankAccount

Links

Collection of Link

PagingInformation




Response Body Formats



application/json, text/json

Sample:
{
  "items": [
    {
      "id": 1,
      "portfolioId": 2,
      "bankAccount": "sample string 3",
      "accountNumber": "sample string 4",
      "bankId": 5,
      "iban": "sample string 6",
      "currencyTypeId": 7,
      "isDeleted": true,
      "addDate": "2024-10-08T05:40:24.5531727-05:00",
      "addId": "sample string 11",
      "addNode": "sample string 12",
      "lastChangeDate": "2024-10-08T05:40:24.5531727-05:00",
      "lastChangeId": "sample string 14",
      "lastChangeNode": "sample string 15",
      "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"
      },
      "bank": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      }
    },
    {
      "id": 1,
      "portfolioId": 2,
      "bankAccount": "sample string 3",
      "accountNumber": "sample string 4",
      "bankId": 5,
      "iban": "sample string 6",
      "currencyTypeId": 7,
      "isDeleted": true,
      "addDate": "2024-10-08T05:40:24.5531727-05:00",
      "addId": "sample string 11",
      "addNode": "sample string 12",
      "lastChangeDate": "2024-10-08T05:40:24.5531727-05:00",
      "lastChangeId": "sample string 14",
      "lastChangeNode": "sample string 15",
      "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"
      },
      "bank": {
        "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:
<PagedListOfPortfolioBankAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <PortfolioBankAccount>
      <AccountNumber>sample string 4</AccountNumber>
      <AddDate>2024-10-08T05:40:24.5531727-05:00</AddDate>
      <AddId>sample string 11</AddId>
      <AddNode>sample string 12</AddNode>
      <Bank>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Bank>
      <BankAccount>sample string 3</BankAccount>
      <BankId>5</BankId>
      <CurrencyTypeId>7</CurrencyTypeId>
      <IBAN>sample string 6</IBAN>
      <Id>1</Id>
      <IsDeleted>true</IsDeleted>
      <LastChangeDate>2024-10-08T05:40:24.5531727-05:00</LastChangeDate>
      <LastChangeId>sample string 14</LastChangeId>
      <LastChangeNode>sample string 15</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>
      <PortfolioId>2</PortfolioId>
      <Udfs>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Udfs>
    </PortfolioBankAccount>
    <PortfolioBankAccount>
      <AccountNumber>sample string 4</AccountNumber>
      <AddDate>2024-10-08T05:40:24.5531727-05:00</AddDate>
      <AddId>sample string 11</AddId>
      <AddNode>sample string 12</AddNode>
      <Bank>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Bank>
      <BankAccount>sample string 3</BankAccount>
      <BankId>5</BankId>
      <CurrencyTypeId>7</CurrencyTypeId>
      <IBAN>sample string 6</IBAN>
      <Id>1</Id>
      <IsDeleted>true</IsDeleted>
      <LastChangeDate>2024-10-08T05:40:24.5531727-05:00</LastChangeDate>
      <LastChangeId>sample string 14</LastChangeId>
      <LastChangeNode>sample string 15</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>
      <PortfolioId>2</PortfolioId>
      <Udfs>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Udfs>
    </PortfolioBankAccount>
  </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>
</PagedListOfPortfolioBankAccount>



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.