GET v1/BondPortfolios/All

Retrieves all bond portfolios associated to the logged in user.

Request Information

Parameters

Name Type Description Additional information
request BondPortfoliosGetAllRequest Container for the BondPortfoliosGetAllRequest input parameters. See parameter details below.

Define this parameter in the request URI.

Parameter Information

Parameter Name: request

Property Type Description
InsiteId String Optional - Insite Id.
SdkVersion String If the client is using the SDK, the version number will be passed along with the request. This field is optional.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "portfolios": [
    {
      "id": 1,
      "name": "sample string 2",
      "bondCount": 3,
      "sharedByUser": {
        "firstName": "sample string 1",
        "lastName": "sample string 2"
      },
      "userId": 4
    },
    {
      "id": 1,
      "name": "sample string 2",
      "bondCount": 3,
      "sharedByUser": {
        "firstName": "sample string 1",
        "lastName": "sample string 2"
      },
      "userId": 4
    },
    {
      "id": 1,
      "name": "sample string 2",
      "bondCount": 3,
      "sharedByUser": {
        "firstName": "sample string 1",
        "lastName": "sample string 2"
      },
      "userId": 4
    }
  ],
  "requiresSubscription": false,
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "insiteId": "sample string 1",
    "sdkVersion": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<BondPortfoliosGetAllResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </ErrorMessages>
  <ErrorOccurred>false</ErrorOccurred>
  <Request>
    <SdkVersion>sample string 2</SdkVersion>
    <InsiteId>sample string 1</InsiteId>
  </Request>
  <Portfolios>
    <BondPortfolio>
      <BondCount>3</BondCount>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <SharedByUser>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
      </SharedByUser>
      <UserId>4</UserId>
    </BondPortfolio>
    <BondPortfolio>
      <BondCount>3</BondCount>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <SharedByUser>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
      </SharedByUser>
      <UserId>4</UserId>
    </BondPortfolio>
    <BondPortfolio>
      <BondCount>3</BondCount>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <SharedByUser>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
      </SharedByUser>
      <UserId>4</UserId>
    </BondPortfolio>
  </Portfolios>
  <RequiresSubscription>false</RequiresSubscription>
</BondPortfoliosGetAllResponse>