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
    AccountKey AccountKey Query-String Unique identifier of an Account.
    ClientKey ClientKey Query-String Unique identifier of a Client.
    SortColumn SortColumn Query-String Specify a column to sort on. Default sorting on records is descending by ReceivedDate and ascending by IssuerName.
    SortType SortType Query-String Specify ascending or descending sort. Default sort type will be Ascending.
  • 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 ProxyEvent [] The collection of entities for this feed.
    MaxRows Number The maximum number of rows that can be returned (if applicable).
  • Request Example

    Request URL
    GET /ca/v2/proxyvoting/events?$skip=1&$top=1&AccountKey=D-agw6s4EpEjuiR8O0JaP1==&ClientKey=W-CgwnsUEpETkiR8MPJalA==&SortColumn=Type&SortType=Asc
  • Response Example

    Response body
    {
      "__count": 2,
      "Data": [
        {
          "AccountId": "384930295",
          "AccountKey": "2y0tX0m9ZH7MH8HK38qM9g==",
          "CINS": "A08010AA5",
          "CUSIP": "123456789",
          "CutoffDate": "2020-06-30T00:00:00Z",
          "IsActionable": true,
          "IsinCode": "US0978731104",
          "IssuerName": "American International Group, Inc.",
          "JobNumber": "S75596",
          "Materials": [
            {
              "MaterialType": {
                "Code": "10K",
                "Description": "10-K Report"
              },
              "Url": "https://noaction.com"
            }
          ],
          "ReceivedOn": "2020-06-15T00:00:00Z",
          "Status": "VW",
          "StatusDescription": "Viewed",
          "StatusUpdatedOn": "2020-06-30T00:00:00Z",
          "SubType": "S",
          "SubTypeDescription": "Special meeting",
          "Symbol": "AIGI:xnas",
          "Type": "PX",
          "TypeDescription": "Proxy"
        }
      ]
    }