Skip to content
Longport WhaleLongport Whale
Sub Account View

Sub Account View Detail

Retrieve the full configuration of a single sub-account view by id.

Request parameters

  • Required: id (sub-account view id), supplied as a query parameter.

Result

On success, data contains the full configuration of the sub-account view, including the view basic information view and the group list groups. See the 200 response fields for the meaning of each field.

GEThttps://b-api.longbridge.xyz/corporate_action/sub_position_view/detail

Authorization

AuthorizationstringheaderRequired

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

Parameters

idstringRequired

Sub-account view id, supplied as a query parameter.

Responses

HTTP 200The request was processed successfully. data contains the full configuration of the sub-account view.
Standard response envelopecodemessagedata
dataobjectdata structure

Full configuration of the sub-account view, including the view basic information view and the group list groups.

viewobject

Basic information of the sub-account view.

Child attributes
idstring

Sub-account view id.

view_namestring

View name.

usage_sceneinteger

Usage scenario of the sub-account view.

1 · Rounding Adjustment2 · Refund3 · After-event Adjustment

remarkstring

Remark.

groupsarray<object>

Group list; each item contains a group name and a sub-account scope.

Child attributes
group_namestring

Group name.

sub_position_scopearray<string>

Scope of settlement sub-accounts assigned to the group, a list of sub-account numbers. Each must be an existing sub-account number in the system.

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