Skip to content
Longport WhaleLongport Whale
Corp Action Management

Edit Voting Instruction

Adds, modifies, or deletes the voting instructions and attendance info for a client under a shareholders' meeting (Voting) corporate action.

Request parameters

  • Required: ann_id (corporate-action ID), aaid (account ID), voting_infos (voting instructions).
  • Optional: attendee_info (attendee details).
  • The length of voting_infos must equal the number of proposals returned by the server, and chosen_proxy_serial must be unique across items.
  • attendee_info applies only when attend_type is 1 (proxy voting) or 2 (attending in person); its field values may contain only Latin letters and punctuation.

Risk warning

This operation changes a client's voting instructions and attendance arrangement on their behalf. Confirm the account, proposal mapping, and attendance type before calling.

Result

On success the voting instructions are added/modified/deleted; the outcome is in data. Interpret it together with the business code.

POSThttps://b-api.lbkrs.com/corporate_action/edit/voting/instruction

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_corporate.corporate_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

ann_idstringrequired

Announcement ID identifying the target shareholders' meeting (Voting) corporate action.

aaidintegerrequired

Account ID identifying the target client account whose voting instructions are edited.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

voting_infosarray<object>required

List of voting instructions. The array length must equal the number of proposals returned by the server, and each chosen_proxy_serial must be unique.

Child attributes
chosen_proxy_serialstringrequired

Proxy serial identifying the proposal; matches proxy_serial returned by "Query Voting Info".

voteintegerrequired

Vote cast on this proposal.

Allowed values: 1 Approve, 2 Against, 3 Abstain

Values
0
Unspecified
1
Approve
2
Against
3
Abstention
attendee_infoobject

Attendee details. Only takes effect when attend_type is 1 (proxy voting) or 2 (attend in person); otherwise the server ignores the following fields. Field values may contain English letters and punctuation only.

Child attributes
attend_typeinteger

Way of participating in the shareholders' meeting.

Allowed values: 1 Proxy voting, 2 Attend in person, 3 Attend by proxy

Values
0
Unspecified
1
Proxy Voting
2
Attend In Person
3
Attend By Proxy
attendee_namestring

Attendee's name.

attendee_identification_numberstring

Attendee's identification number.

attendee_addressstring

Attendee's address.

attendee_genderstring

Attendee's gender.

Responses

HTTP 200The request was processed successfully. data carries the result of the edit operation.
Standard response envelopecodemessagedata
datastringdata structure

Result of the edit operation.

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs