Skip to content
Longport WhaleLongport Whale
Contract Amendments

Contract Amendment List

Queries Contract Amendment List 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.

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

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

AuthorizationstringheaderRequired

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
origin_contract_nostring

Filters results by Origin contract no.

new_contract_nostring

Filters results by New contract no.

audit_statestring

Filters results by Audit State.

Allowed values:

  • 1 - Review
  • 2 - Success
  • 3 - Rejected

1 · Review2 · Success3 · Rejected

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Contract Amendment List 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
created_atstring

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

origin_contract_nostring

Returned value: Origin contract no.

offset_contract_nostring

Returned value: Offset contract no.

new_contract_nostring

Returned value: New contract no.

audit_statestring

Returned value: State.

audit_state_valstring

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

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