Skip to content
Longport WhaleLongport Whale
Ref Enums

Scenario Name Data Dictionary

Returns the currently available Scenario Name data dictionary.

Using the values

Read entries from data.values. Request parameters normally use an entry's key, while value is the display label. Values may change with business configuration and should not be hard-coded in clients.

GEThttps://b-api.longbridge.xyz/v1/datasets/refs/billing_scenario_names

Authorization

AuthorizationstringheaderRequired

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

Responses

HTTP 200On success, returns the Scenario Name data-dictionary entries. Each entry contains a key for requests and a display value.
Standard response envelopecodemessagedata
dataobjectdata structure
valuesarray<object>

Dictionary Entries. Returned value: List of dictionary entries.

Child attributes
keystring

Key. Returned value: Dictionary key to send to related APIs; do not send the display text.

valuestring

Value. Returned value: Display text for the dictionary entry.

descstring

Description. Usually empty.

colorstring

Color. Returned value: Color.

pkeystring

Parent Key. Usually empty.

messagestring

Usually empty. This field is independent of the outer message field.

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