FindCancelResponse
The base response type of the GET /post-order/v2/cancellation/search method. This response returns information about an order cancellation request.
The order cancellation request(s) returned are the ones that match the filter criteria passed in the query parameter(s) of the request.
Call that uses FindCancelResponse:
Fields
cancellations ( array of CancelSummary ) [0..?]
An array of one or more order cancellation requests that match the request criteria.
This array is returned as empty if no order cancellation requests match the input criteria.
This array is returned as empty if no order cancellation requests match the input criteria.
See the Field Index to learn which calls use cancellations.
paginationOutput ( PaginationOutput ) [0..?]
The result set from this method is paginated because the request can result in a large number of matches. This container consists of metadata related to the current response page.
It contains the page number and the cancellation entries per page, as well as the total amount of response pages and cancellation entries. This container is not returned if no cancellation requests match the input criteria.
It contains the page number and the cancellation entries per page, as well as the total amount of response pages and cancellation entries. This container is not returned if no cancellation requests match the input criteria.
See the Field Index to learn which calls use paginationOutput.
The total number of cancellation requests that match the input criteria. A value of
0 is returned if no cancellation requests match the input criteria.
See the Field Index to learn which calls use total.