Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Vote a Corporate Action

This request returns all corporate action for a given account number.

Request URL

Syntax PUT /restapi/accounts/{accountNumber}/corporateactions/{notificationid}
Example URL https://api.uat.foliofn.com/restapi/accounts/RA7123400B/corporateactions/1369094288662787788

Request Data Fields

Field Description Required
notifid Unique ID for the corporate action client voting for. N
questions An array of questions related to this corporate action. See detail below. Y
type Type of corporate action:
P- Proxy
M- Mandatory
V- Voluntary
Y

Question Data Fields

Field Description Required
questionId Unique ID of the question. Y
questionType Type of question:
C- Actionable Corporate Action such as Tender/Exchange offer.
D- Vote for company Directors
P- Proposed vote to shareholders
S- Say on Pay
Y
answer Vote for the question(Only applicable for questionType P and S). See detail below Y
sharesElected Number of shares you want to elect(Only applicable for questionType C).
Also elected shares should be less than or equal to number of share held by the client
Y
choices An array of the available directors for questionsType 'D'. See detail below. Y

Choice Data Fields

Field Description Required
choiceId Sequential number identifying this director choice. Y
choiceAnswer Vote for the director(Only applicable for questionType C).
Check possibleChoices through GET Corporate Action API
Y

Answers

Question type Answers
Say on Pay 0 - 1 year
1 - 2 year
2 - 3 year
3 - Abstain
Proposal 0 - For
1 - Against
2 - Abstain

Election Of Directors Request Example


PUT restapi/accounts/RA7123400B/corporateactions/5548434742921864079 HTTP 1.1

{
  "notifid" : "5548434742921864079",
  "questions" : [{
      "choices" : [{
               "choiceId" : "0",
               "choiceAnswer" : "0"
            },{
               "choiceId" : "1",
               "choiceAnswer" : "0"
            },{
               "choiceId" : "2",
               "choiceAnswer" : "0"
            },{
               "choiceId" : "3",
               "choiceAnswer" : "0"
            },{
               "choiceId" : "4",
               "choiceAnswer" : "1"
            },{
               "choiceId" : "5",
               "choiceAnswer" : "2"
            },{
               "choiceId" : "6",
               "choiceAnswer" : "2"
            },{
               "choiceId" : "7",
               "choiceAnswer" : "2"
            },{
               "choiceId" : "8",
               "choiceAnswer" : "2"
      }],
      "questionId" : "6341068277339271427",
      "questionType" : "D"
  }],
  "type" : "P"
}


Proposal Request Example


PUT restapi/accounts/RA7123400B/corporateactions/5548434742921864079 HTTP 1.1

{
  "notifid" : "5548434742921864079",
  "questions" : [{
      "questionId" : "1801439852949811460",
      "answer" : "1",
      "questionType" : "P"
  }],
  "type" : "P"
}



Say on Pay Request Example


PUT restapi/accounts/RA7123400B/corporateactions/5548434742921864079 HTTP 1.1

{
  "notifid" : "5548434742921864079",
  "questions" : [{
      "questionId" : "5332261960808280326",
      "answer" : "2",
      "questionType" : "S"
  }],
  "type" : "P"
}



Actionable Corporate Action Request Example


PUT restapi/accounts/RA7123400B/corporateactions/6629298653411699652 HTTP 1.1

{
  "notifid" : "6629298653411699652",
  "questions" : [{
      "questionId" : "4755801208425573319",
      "sharesElected": "1",
      "questionType" : "C"
  },{
      "questionId" : "8070450534170258373",
      "sharesElected": "0.5",
      "questionType" : "C"
  },{
      "questionId" : "8430738504359898054",
      "sharesElected": "0.5",
      "questionType" : "C"
  }],
  "type" : "V"
}



Response Example


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://api.uat.foliofn.com/restapi/accounts/RA7123400B/corporateactions/1369094288662787788
Link: <https://api.uat.foliofn.com/restapi/accounts/RA7123400B/corporateactions/1369094288662787788;; rel="PUT"; type="application/json"; title="voteCorpAction"
Content-Type: application/json
Transfer-Encoding: chunked
Date: Fri, 21 Feb 2014 18:23:54 GMT

Change Log

03/24/2017

  1. New Documentation.

Getting Started

REST APIs

Resources