GET v1/Portfolios

Description

Retrieve list of Portfolios satisfying the input search criteria.

Base Url

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

Rest Call Syntax


GET Reference/v1/Portfolios

Execute API

GET Reference/v1/Portfolios

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

AbbreviationExactMatch

This value will allow a portfolio search by Abbreviation Name Exact Match

string

AbbreviationStartsWith

This value will allow a portfolio search by Abbreviation Name Starts With

string

BaseCurrencyCode

This value will allow a portfolio search by Base Currency Code

string

ClosingDate

This value will allow a portfolio search by the Closing Date

date

IsAgentPortfolio

This flag will allow the return of agent portfolios in the search results

IsDeleted

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

MarkitEntityId

This value will allow a portfolio search by the Markit Entity Id

string

PageNumber

Specified Page number to search

integer

PageSize

Specified Page size to search

integer

PortfolioNameExactMatch

This value will allow a portfolio search by Portfolio Name Exact Match

string

PortfolioNameStartsWith

This value will allow a portfolio search by Portfolio Name Starts With

string



Response Information



PagedList Of PortfolioListItem

Name

Description

Type

Additional Information

Items

Collection of PortfolioListItem

Links

Collection of Link

PagingInformation



Response Body Formats



application/json, text/json

Sample: 
{
  "items": [
    {
      "id": 1,
      "isDeleted": true,
      "portfolioName": "sample string 3",
      "markitEntityId": "sample string 4",
      "abbreviation": "sample string 5",
      "baseCurrencyCode": "sample string 6",
      "closingDate": "2025-11-08T05:34:09.2234604-05:00",
      "isAgentPortfolio": true,
      "adjustCapitalizedPIKOnUnsettledTradeUpdates": true,
      "enableTradeHistory": true,
      "contactId": 1,
      "contact": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "constantYieldType": "StraightLine",
      "dataFeedId": 1,
      "dealType": "sample string 11",
      "defaultCashLedgerAccountId": 1,
      "institutionId": 1,
      "institution": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "isErisaFund": true,
      "isThirdPartyFund": true,
      "usePortfolioExchangeRates": true,
      "allocationsUseParentTradeInfo": true,
      "issuerId": 16,
      "issuer": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "ledgerMapTypeId": 1,
      "notes": "sample string 17",
      "dataImportSource": "None",
      "portfolioType": "None",
      "signature1": "sample string 18",
      "signature2": "sample string 19",
      "signature3": "sample string 20",
      "signature4": "sample string 21",
      "countryId": 1,
      "country": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "custodianId": 22,
      "paydownUnsettledTradeUpdateDefault": "NoChange",
      "stampNewTrade": true,
      "tradeSettlementIntegrationPortfolioId": "sample string 24",
      "tradeSettlementIntegrationPortfolioName": "sample string 25",
      "sendToMEI": "sample string 26",
      "allowNegativePositionOnATradeDateBasis": true,
      "isActive": true,
      "addDate": "2025-11-08T05:34:09.2234604-05:00",
      "addId": "sample string 30",
      "addNode": "sample string 31",
      "lastChangeDate": "2025-11-08T05:34:09.2234604-05:00",
      "lastChangeId": "sample string 33",
      "lastChangeNode": "sample string 34",
      "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"
        }
      ],
      "companyId": 1
    },
    {
      "id": 1,
      "isDeleted": true,
      "portfolioName": "sample string 3",
      "markitEntityId": "sample string 4",
      "abbreviation": "sample string 5",
      "baseCurrencyCode": "sample string 6",
      "closingDate": "2025-11-08T05:34:09.2234604-05:00",
      "isAgentPortfolio": true,
      "adjustCapitalizedPIKOnUnsettledTradeUpdates": true,
      "enableTradeHistory": true,
      "contactId": 1,
      "contact": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "constantYieldType": "StraightLine",
      "dataFeedId": 1,
      "dealType": "sample string 11",
      "defaultCashLedgerAccountId": 1,
      "institutionId": 1,
      "institution": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "isErisaFund": true,
      "isThirdPartyFund": true,
      "usePortfolioExchangeRates": true,
      "allocationsUseParentTradeInfo": true,
      "issuerId": 16,
      "issuer": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "ledgerMapTypeId": 1,
      "notes": "sample string 17",
      "dataImportSource": "None",
      "portfolioType": "None",
      "signature1": "sample string 18",
      "signature2": "sample string 19",
      "signature3": "sample string 20",
      "signature4": "sample string 21",
      "countryId": 1,
      "country": {
        "verb": "sample string 1",
        "rel": "sample string 2",
        "uri": "http://webapihelppage3.com"
      },
      "custodianId": 22,
      "paydownUnsettledTradeUpdateDefault": "NoChange",
      "stampNewTrade": true,
      "tradeSettlementIntegrationPortfolioId": "sample string 24",
      "tradeSettlementIntegrationPortfolioName": "sample string 25",
      "sendToMEI": "sample string 26",
      "allowNegativePositionOnATradeDateBasis": true,
      "isActive": true,
      "addDate": "2025-11-08T05:34:09.2234604-05:00",
      "addId": "sample string 30",
      "addNode": "sample string 31",
      "lastChangeDate": "2025-11-08T05:34:09.2234604-05:00",
      "lastChangeId": "sample string 33",
      "lastChangeNode": "sample string 34",
      "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"
        }
      ],
      "companyId": 1
    }
  ],
  "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: 
<PagedListOfPortfolioListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <PortfolioListItem>
      <Abbreviation>sample string 5</Abbreviation>
      <AddDate>2025-11-08T05:34:09.2234604-05:00</AddDate>
      <AddId>sample string 30</AddId>
      <AddNode>sample string 31</AddNode>
      <AdjustCapitalizedPIKOnUnsettledTradeUpdates>true</AdjustCapitalizedPIKOnUnsettledTradeUpdates>
      <AllocationsUseParentTradeInfo>true</AllocationsUseParentTradeInfo>
      <AllowNegativePositionOnATradeDateBasis>true</AllowNegativePositionOnATradeDateBasis>
      <BaseCurrencyCode>sample string 6</BaseCurrencyCode>
      <ClosingDate>2025-11-08T05:34:09.2234604-05:00</ClosingDate>
      <CompanyId>1</CompanyId>
      <ConstantYieldType>StraightLine</ConstantYieldType>
      <Contact>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Contact>
      <ContactId>1</ContactId>
      <Country>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Country>
      <CountryId>1</CountryId>
      <CustodianId>22</CustodianId>
      <DataFeedId>1</DataFeedId>
      <DataImportSource>None</DataImportSource>
      <DealType>sample string 11</DealType>
      <DefaultCashLedgerAccountId>1</DefaultCashLedgerAccountId>
      <EnableTradeHistory>true</EnableTradeHistory>
      <Id>1</Id>
      <Institution>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Institution>
      <InstitutionId>1</InstitutionId>
      <IsActive>true</IsActive>
      <IsAgentPortfolio>true</IsAgentPortfolio>
      <IsDeleted>true</IsDeleted>
      <IsErisaFund>true</IsErisaFund>
      <IsThirdPartyFund>true</IsThirdPartyFund>
      <Issuer>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Issuer>
      <IssuerId>16</IssuerId>
      <LastChangeDate>2025-11-08T05:34:09.2234604-05:00</LastChangeDate>
      <LastChangeId>sample string 33</LastChangeId>
      <LastChangeNode>sample string 34</LastChangeNode>
      <LedgerMapTypeId>1</LedgerMapTypeId>
      <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>
      <MarkitEntityId>sample string 4</MarkitEntityId>
      <Notes>sample string 17</Notes>
      <PaydownUnsettledTradeUpdateDefault>NoChange</PaydownUnsettledTradeUpdateDefault>
      <PortfolioName>sample string 3</PortfolioName>
      <PortfolioType>None</PortfolioType>
      <SendToMEI>sample string 26</SendToMEI>
      <Signature1>sample string 18</Signature1>
      <Signature2>sample string 19</Signature2>
      <Signature3>sample string 20</Signature3>
      <Signature4>sample string 21</Signature4>
      <StampNewTrade>true</StampNewTrade>
      <TradeSettlementIntegrationPortfolioId>sample string 24</TradeSettlementIntegrationPortfolioId>
      <TradeSettlementIntegrationPortfolioName>sample string 25</TradeSettlementIntegrationPortfolioName>
      <UsePortfolioExchangeRates>true</UsePortfolioExchangeRates>
    </PortfolioListItem>
    <PortfolioListItem>
      <Abbreviation>sample string 5</Abbreviation>
      <AddDate>2025-11-08T05:34:09.2234604-05:00</AddDate>
      <AddId>sample string 30</AddId>
      <AddNode>sample string 31</AddNode>
      <AdjustCapitalizedPIKOnUnsettledTradeUpdates>true</AdjustCapitalizedPIKOnUnsettledTradeUpdates>
      <AllocationsUseParentTradeInfo>true</AllocationsUseParentTradeInfo>
      <AllowNegativePositionOnATradeDateBasis>true</AllowNegativePositionOnATradeDateBasis>
      <BaseCurrencyCode>sample string 6</BaseCurrencyCode>
      <ClosingDate>2025-11-08T05:34:09.2234604-05:00</ClosingDate>
      <CompanyId>1</CompanyId>
      <ConstantYieldType>StraightLine</ConstantYieldType>
      <Contact>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Contact>
      <ContactId>1</ContactId>
      <Country>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Country>
      <CountryId>1</CountryId>
      <CustodianId>22</CustodianId>
      <DataFeedId>1</DataFeedId>
      <DataImportSource>None</DataImportSource>
      <DealType>sample string 11</DealType>
      <DefaultCashLedgerAccountId>1</DefaultCashLedgerAccountId>
      <EnableTradeHistory>true</EnableTradeHistory>
      <Id>1</Id>
      <Institution>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Institution>
      <InstitutionId>1</InstitutionId>
      <IsActive>true</IsActive>
      <IsAgentPortfolio>true</IsAgentPortfolio>
      <IsDeleted>true</IsDeleted>
      <IsErisaFund>true</IsErisaFund>
      <IsThirdPartyFund>true</IsThirdPartyFund>
      <Issuer>
        <Rel>sample string 2</Rel>
        <Uri>http://webapihelppage3.com/</Uri>
        <Verb>sample string 1</Verb>
      </Issuer>
      <IssuerId>16</IssuerId>
      <LastChangeDate>2025-11-08T05:34:09.2234604-05:00</LastChangeDate>
      <LastChangeId>sample string 33</LastChangeId>
      <LastChangeNode>sample string 34</LastChangeNode>
      <LedgerMapTypeId>1</LedgerMapTypeId>
      <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>
      <MarkitEntityId>sample string 4</MarkitEntityId>
      <Notes>sample string 17</Notes>
      <PaydownUnsettledTradeUpdateDefault>NoChange</PaydownUnsettledTradeUpdateDefault>
      <PortfolioName>sample string 3</PortfolioName>
      <PortfolioType>None</PortfolioType>
      <SendToMEI>sample string 26</SendToMEI>
      <Signature1>sample string 18</Signature1>
      <Signature2>sample string 19</Signature2>
      <Signature3>sample string 20</Signature3>
      <Signature4>sample string 21</Signature4>
      <StampNewTrade>true</StampNewTrade>
      <TradeSettlementIntegrationPortfolioId>sample string 24</TradeSettlementIntegrationPortfolioId>
      <TradeSettlementIntegrationPortfolioName>sample string 25</TradeSettlementIntegrationPortfolioName>
      <UsePortfolioExchangeRates>true</UsePortfolioExchangeRates>
    </PortfolioListItem>
  </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>
</PagedListOfPortfolioListItem>


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.