notification report · Whale Docs

POSThttps://b-api.longbridge.xyz/v1/datasets/corp_action_notification_report

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

ann_idstring

Ann ID

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

choices_quantity_totalstring

Eligible Qty

user_totalstring

Eligible Client

backend_totalstring

Selected Via BO (Client Count)

app_totalstring

Selected Via APP (Client Count)

ca_codestring

Announcement NO.

origin_counter_idstring

Origin Counter ID

in_side_election_tostring

Elect. Period To

election_tostring

选择结束日期（CCASS）

totalintegerrequired

Total

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

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/corp_action_notification_report' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "choices_quantity_total": "string",
        "user_total": "string",
        "backend_total": "string",
        "app_total": "string",
        "ca_code": "string",
        "origin_counter_id": "string",
        "in_side_election_to": "string",
        "election_to": "string"
      }
    ],
    "total": 1
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.longbridge.xyz/v1/datasets/corp_action_notification_report/download

Export options Export records Download result