Skip to content
Longport WhaleLongport Whale
Corp Action Management

Edit Choices Quantity

Modifies the exercised (chosen) quantity for each event under a specific client registration detail of a corporate action.

Request parameters

  • Required: ann_id (advance-notice ID), register_id (registration-detail ID), details (the detail items to modify).
  • Optional: audit_frontend_resource (caller-provided audit context).
  • Each details item must give the event ID event_id, the detail-item ID id, and the new exercised quantity choices_quantity.

Risk warning

This operation changes a client's exercised (chosen) quantity and affects the corporate action's execution outcome. Confirm the detail items and quantities before calling.

Result

On success the exercised quantity of each detail item is updated; the outcome is in data. Interpret it together with the business code.

POSThttps://b-api.lbkrs.com/v1/edit/choices_quantity

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

Unique identifier of the corporate-action announcement.

register_idstringrequired

Unique identifier of the client register-detail record to modify.

detailsarray<object>required

List of detail items whose exercise quantity is being modified. Each item corresponds to one event.

Child attributes
event_idstringrequired

Unique identifier of the event that the detail item belongs to.

idstringrequired

Unique identifier of the detail item.

choices_quantitystringrequired

New exercise quantity (choices quantity) for the detail item.

audit_frontend_resourceobject

Caller-provided audit context recording the business information associated with this operation. Typically includes the security, announcement number, and client account identifiers.

Child attributes
origin_counter_idstring

Associated security identifier.

ca_codestring

Associated corporate-action announcement number.

aaidstring

Associated client account identifier.

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.

Responses

HTTP 200The request was processed successfully. The result is returned in data.
Standard response envelopecodemessagedata
dataobjectdata structure

Business result; usually an empty object.

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