Proxy#

Resource and endpoints for proxy related operations.

Endpoints:#


GET Proxy/GetList#

Description:

Retrieves a list of proxies.

Query Parameters:

customerIssuerId
integer Required
Nullable
The unique identifier of the customer issuer.

Example Request:

curl --silent --location '{{baseurl}}/api/v1/Proxy/GetList?customerIssuerId=1' \
--header 'Authorization: Bearer <YOUR TOKEN>'

200 Response:

[
  {
    "proxyId": 302100,
    "issuer": "Alaska Air Group, Inc.",
    "security": "Common",
    "totalShares": 492350,
    "totalSharesFormat": "492,350",
    "totalVotedShares": 0,
    "totalVotedSharesFormat": "0",
    "title": "proxy 10",
    "quorum": "10%",
    "recordDate": "8/30/2018",
    "mailingDate": "8/31/2018",
    "meetingDateTime": "10/31/2018 @ 07:00 AM PST",
    "voteCloseDateTime": "11/01/2018 @ 07:00 AM PST",
    "status": "Closed"
  },
  {
    "proxyId": 3029,
    "issuer": "Alaska Air Group, Inc.",
    "security": "Common",
    "totalShares": 6463100,
    "totalSharesFormat": "6,463,100",
    "totalVotedShares": 1500,
    "totalVotedSharesFormat": "1,500",
    "title": "proxy2",
    "quorum": "2%",
    "recordDate": "10/28/2019",
    "mailingDate": "",
    "meetingDateTime": "10/31/2019 @ 07:00 AM PST",
    "voteCloseDateTime": "",
    "status": "Closed"
  }
]

POST Proxy/GenerateProxyDetails#

Description:

Generates details for a specific proxy.

Request Body:

customerProxyId
integer Required
Nullable
Your Customer Proxy Id.
includeNotVotedShares
boolean Required
Non-nullable
true = includes shares that haven't been voted on yet.
false = does not include shares that haven't been voted on yet.
isPDF
boolean Required
Non-nullable
Generates a PDF.
true = generates a downloadable pdf.
false = does not generate a downloadable pdf.

Example Request:

curl --silent --location --request POST '{{baseurl}}/api/v1/Proxy/GenerateProxyDetails' \
--header 'Authorization: Bearer <YOUR TOKEN>' \
--header 'Content-Type: application/json' \
--data '{"example": "data"}'

200 Response:

{
  "downloadUrl": "{{baseurl}}/Api/v1/Report/DownloadReport/CfDJ8G2a_F-j-rtGiUBjbT5isV09BVpVehT24o8YZJjnpIaz-FE8LPFSN4SVvcZxgrpQJaV5E9vCsWrGcytlXYNEV_hJawiszPIEoVJdX0M7Nn69PZOTO6A4ulz7fCnk8wQ5nQuR_gFIR2St2FSOVG3LuZAmUEcstEMuzNbAd9cBEJea/proxy-3029.pdf/CfDJ8G2a_F-j-rtGiUBjbT5isV0GdswlqrZFUtmb0EoHcEuQ2yBeKQnfHvvI12VVFtjOZKA9J_bHW26zD84_eZ3Y84dUNfVfi69veuQ1SPXWEuofzRKX_6pE8_V0qhc02hFs0NAGJWbQR-5URn1jsAzZqCc"
}