Get client holdings

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  $skip	Integer	Query-String	The number of entries to skip from the beginning of the collection
  $top	Integer	Query-String	The number of entries to return from the beginning of the collection
  AccountGroupKey	AccountGroupKey	Body	Account group identifier.
  Accounts	Account []	Body	Account identifiers.
  ClientKey	ClientKey	Body	Client identifier.
  EventId	String	Body	Event id.
  IncludeSubAccounts	Boolean	Body	Indicate whether to include events from sub-clients.

• Response Parameters

  View Response Codes

  Name	Type	Description
  __count	Number	The total count of items in the feed.
  __next	String	The link for the next page of items in the feed.
  Data	Holding []	The collection of entities for this feed.
  MaxRows	Number	The maximum number of rows that can be returned (if applicable).

  HTTP Code	Description
  200	OK	Request completed successfully.
  201	Created	Created
  400	Bad Request	Error Code Description InvalidPagingParameters Invalid paging parameters
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  404	Not Found	Requested resource not found.
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• Request Example

  Request URL

  POST /ca/v2/holdings?$skip=1&$top=1

  Request Body

  {
    "AccountGroupKey": "BxS0VWLta8lJ3SBpjGBQjw==",
    "Accounts": [
      {
        "AccountKey": "2y0tX0m9ZH7MH8HK38qM9g=="
      }
    ],
    "ClientKey": "7m4I|vtYLUnEGg77o9uQhw==",
    "EventId": "956358",
    "IncludeSubAccounts": true
  }
  

• Response Example

  Response body

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