Skip to content
Longport WhaleLongport Whale
File Sending

OB Downstream File Sending

查询「OB 下手文件发送」数据，可通过 filters 组合业务筛选条件，并使用 page、page_size 控制分页。

返回结果

成功时返回匹配的记录列表及分页信息。各过滤字段的用途、可选值和动态数据来源见对应字段说明。

GEThttps://b-api.longbridge.xyz/v1/datasets/ipo_ob_file_downstream_sends

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

Authorizationstringheaderlb_hk_clearing.ob_file_sending_listRequired

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

Query parameters

filtersobject

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

Child attributes
member_idstring

Filters results by Client.

ledger_datestring

Filters results by File Date.

marketstring

Filters results by Market.

Values are dynamic. Call GET /v1/datasets/refs/clearing_file_markets to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

file_codestring

Filters results by File Type.

Values are dynamic. Call GET /v1/datasets/refs/ob_file_types to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

statusstring

Filters results by File Status.

Allowed values:

  • 0 - Unsent
  • 1 - Sending
  • 2 - Sent
  • 3 - Sending Failure
  • 4 - Sent And Updated

0 · Unsent1 · Sending2 · Sent3 · Send Failed4 · Sent And Updated

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 Sending 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
ledger_datestring

Returned value: Biz Date. The date or time format follows the value returned by the API.

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: Name.

org_account_channelstring

Returned value: Company ID.

marketstring

Returned value: Market.

market_valstring

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

file_titlestring

Returned value: File Type.

file_namestring

Returned value: File Name.

statusstring

Returned value: File Status.

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.

created_atstring

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

send_timestring

Returned value: File Sent 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