Get client holdings

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  $skip	Int	Query-String	Optional number of elements to skip.
  $top	Int	Query-String	Optional number of elements to retrieve.
  AccountGroupKey	AccountGroupKey	Query-String	Account group identifier
  AccountKey	AccountKey	Query-String	Account identifier
  ClientKey	ClientKey	Query-String	Client identifier
  EventId	String	Query-String	Event id
  IncludeSubAccounts	Bool	Query-String	Indicate whether to include events from sub-clients.

• Response Parameters

  View Response Codes

  Name	Type	Description
  AccountDisplayName	String	Account display name
  AccountId	String	Account id
  AccountKey	String	Account key
  Amount	Decimal	Eligible holding
  CashReserved	PriceAndRate	Cash reserved after electing on corresponding option
  ClientId	String	Client Id
  ClientKey	String	Client key
  ClientName	String	Client name
  ElectedAmount	Decimal	The amount of positions that have already been elected on
  ElectionStatus	ElectionStatus	Election status
  EventId	String	Corporate action event Id
  Options	HoldingOption []	List of previously instructed options and their status
  OwnerId	String	Owner Id
  StandingInstructionStatus	StandingInstructionStatus	Indicates if there is a standing instruction created for this holding

  HTTP Code	Description
  200	OK	Request completed successfully.
  400	BadRequest	Error Code Description Request contains invalid parameters. InvalidPagingParameters Invalid paging parameters InvalidRequest Indicates that the request is malformed.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  404	NotFound	Requested resource not found.
  503	ServiceUnavailable	Service Unavailable

  Close

• Request Example

  Request URL

  GET ca/v2/holdings/?$top=99&$skip=99&ClientKey=7m4I|vtYLUnEGg77o9uQhw==&AccountKey=2y0tX0m9ZH7MH8HK38qM9g==&AccountGroupKey=BxS0VWLta8lJ3SBpjGBQjw==&EventId=987468&IncludeSubAccounts=false&ManagementTypes=Client,TradeAdvisory&ModelIds=12,26

• Response Example

  Response body

  {
    "__count": 1,
    "Data": [
      {
        "AccountId": "123INET",
        "Amount": 100.0,
        "CashReserved": {
          "Currency": "USD",
          "Value": 2583.62
        },
        "ClientId": "906869",
        "ClientName": "John",
        "ElectedAmount": 20.0,
        "EventId": "9652429",
        "Options": [
          {
            "ElectedAmount": 20.0,
            "ElectedBy": "John",
            "ElectionType": "Manual",
            "Instruction": {
              "Status": "Accepted"
            },
            "OptionId": "1",
            "Remarks": "Remarks by client..."
          }
        ],
        "OwnerId": "532"
      }
    ]
  }