GET api/bfg/v1/holdings/top-stocks?personId={personId}&endDate={endDate}

Top stocks held as-of end date (<c>SH_GetTopStockHeldByEndDate</c>).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
personId

integer

Required

endDate

date

Required

Body Parameters

None.

Response Information

Resource Description

GetTopStockHeldByEndDateResponse
NameDescriptionTypeAdditional information
Stocks

Collection of TopStockHeldItem

None.

Response Formats

application/json, text/json

Sample:
{
  "Stocks": [
    {
      "SecurityID": 1,
      "SecurityCode": "sample string 2",
      "StocksHeld": 3.0,
      "ShortName": "sample string 4"
    },
    {
      "SecurityID": 1,
      "SecurityCode": "sample string 2",
      "StocksHeld": 3.0,
      "ShortName": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<GetTopStockHeldByEndDateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Holding">
  <Stocks>
    <TopStockHeldItem>
      <SecurityCode>sample string 2</SecurityCode>
      <SecurityID>1</SecurityID>
      <ShortName>sample string 4</ShortName>
      <StocksHeld>3</StocksHeld>
    </TopStockHeldItem>
    <TopStockHeldItem>
      <SecurityCode>sample string 2</SecurityCode>
      <SecurityID>1</SecurityID>
      <ShortName>sample string 4</ShortName>
      <StocksHeld>3</StocksHeld>
    </TopStockHeldItem>
  </Stocks>
</GetTopStockHeldByEndDateResponse>