Struct CancelByIdRequest 

pub struct CancelByIdRequest {
    pub order_id_type: Option<String>,
    pub order_id: String,
    pub client_order_id: Uuid,
}

POST /api/v1/orders/cancel and /orders/cancel/sync body: the order is named in the body, not in the path (the /orders/{id}/cancel of CancelOrderRequest is the deprecated form).

Examples

use brokapi_bcs_protocol::http::models::CancelByIdRequest;
use uuid::Uuid;

let original = Uuid::nil();
let req = CancelByIdRequest::by_client_order_id(original, Uuid::nil());
let json = serde_json::to_value(&req)?;
assert_eq!(json["orderIdType"], "1");
assert_eq!(json["orderId"], "00000000-0000-0000-0000-000000000000");

Fields

order_id_type: Option<String>

1 = order_id is the clientOrderId of the original order (default), 2 = exchange order id.

order_id: String

The id of the order to cancel, of the kind named by order_id_type. For kind 1 a UUID text, for kind 2 the exchange id in the form YYMMDD-ClassCode-OrderNumber.

client_order_id: Uuid

Id of this request, a new UUID.

Implementations

impl CancelByIdRequest

pub fn by_client_order_id(original: Uuid, request_id: Uuid) -> Self

Builds a cancel for the order whose clientOrderId is original.

request_id is the id of the cancel request itself, a new UUID. The call sets the id kind to 1 (the clientOrderId of the original). To cancel by the exchange id build the struct yourself with order_id_type = Some("2").

Trait Implementations

impl Clone for CancelByIdRequest

fn clone(&self) -> CancelByIdRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CancelByIdRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CancelByIdRequest

fn eq(&self, other: &CancelByIdRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CancelByIdRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CancelByIdRequest