Skip to content
Longport WhaleLongport Whale
File Rules

OB Downstream File Rules

Query the OB downstream file-sending rule configuration, used to manage the rules and on/off switches for sending files to each downstream institution.

Request parameters

  • Combine business filters through filters (see the filter field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data comes from OB downstream file-sending rules; each record represents the sending-rule configuration for one downstream institution.

Each record carries the member ID, the customer's Chinese and English names and region, the bound securities accounts, the applicable markets (such as ALL or HK,US), the company ID, the send switch status (open or closed), remarks, and the last operator and update time.

This determines the markets and account scope in which file sending is enabled for each downstream institution, and whether the send switch is currently on.

Returns

On success, returns the list of matching records with pagination. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/ipo_ob_file_downstream_rules

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.ob_file_rule_list

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
member_idstring

Filters results by Client.

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

statusstring

Filters results by File Switch.

Allowed values: 0 Close, 1 Open, 2 Deregister

Values
0
Close
1
Open
2
Deregister
pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated OB Downstream File Rule records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

member_idstring

Returned value: Member Id.

member_id_valstring

Raw value of member_id. The member_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

member_real_namestring

Returned value: Client Name.

org_account_channelstring

Returned value: Company ID.

statusstring

Returned value: File Switch.

status_valstring

Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

remarkstring

Returned value: Remarks.

op_emailstring

Returned value: Operator.

op_email_valstring

Raw value of op_email. The op_email field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Returned value: Creat Time. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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