Skip to content
Longport WhaleLongport Whale
Remarks template

Remarks template

Queries Remarks template data. Combine business filters in filters, and use page and page_size to control pagination.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.query_lookup

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
idstring

Filters results by ID.

config_value_multi_langstring

Filters results by Remarks.

updated_atobject

Filters results by Updated At.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

lookup_categorystring

Filters results by Remarks User.

Values
setting_remark_deposit
Deposit
setting_remark_withdrawal
Withdrawal
setting_remark_securitiesdeposit
Securities Deposit
setting_remark_securitieswithdrawal
Securities Withdrawal
setting_remark_accountadjustment
Account Adjustment
setting_remark_withdrawal_reject
Withdrawal rejection
setting_remark_deposit_reject
Deposit rejection
setting_remark_withdrawal_card_reject
Refuse Add Bank Card
setting_remark_fund
Fund
setting_remark_otc_derivatives
OTC Derivatives
setting_remark_deposit_matching
Deposit Matching
pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Remarks template 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

Returned value: Unique identifier of the current record.

lookup_categorystring

Returned value: Remarks User.

lookup_category_valstring

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

value_enstring

Returned value: Remarks - English.

value_cnstring

Returned value: Remarks - Simplified Chinese.

value_hkstring

Returned value: Remarks - Traditional Chinese.

prioritystring

Returned value: Priority.

created_atstring

Returned value: Created At. 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

Export

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

POSThttps://b-api.lbkrs.com/v1/datasets/atm_remark_templates/download
atm.query_lookup
Export optionsExport recordsDownload result
Whale Docs