bulk_cancel_order_m
For error messages generated by this API, see bulk_cancel_order_m Error Messages.
Input Arguments
Req |
Field Name |
Field Type |
Max Length |
Description |
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
client_no |
long |
22 |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||||||||||
![]() |
auth_key |
string |
32 |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||||||||||||
Start of account_order array | ||||||||||||||||||||
|
account_order |
array |
|
This is an array of account numbers, order numbers, and/or master plan instance numbers to identify orders being canceled. The array elements for this argument immediately follow and are indicated as elements with a right-arrow icon. |
||||||||||||||||
Field Name | Field Type | Max Length | Description | |||||||||||||||||
![]() |
bulk_input_idx |
long |
8 |
Bulk input value provided to map to API responses. This will be populated in the response whether the cancellation was successful or not. |
||||||||||||||||
![]() |
acct_no |
long |
22 |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
||||||||||||||||
OR | ||||||||||||||||||||
client_acct_id | long | 22 |
Client-defined account identifier. If only the acct_no or client_acct_id is passed in with this array, all eligible orders for this account will be cancelled. |
|||||||||||||||||
|
order_no |
long |
22 |
The unique identifier for an order in the context of a client_no and account_no. |
||||||||||||||||
OR | ||||||||||||||||||||
client_order_id | long | 22 |
Client-defined order identifier. If both the acct_no or client_acct_id is passed in AND order_no or client_order_id is passed in with this array, only this unique eligible order for this account will be cancelled. |
|||||||||||||||||
|
master_plan_instance_no |
long |
22 |
The unique identifier for a master plan instance in the context of a client_no and account_no. |
||||||||||||||||
OR | ||||||||||||||||||||
client_master_plan_instance_id | long | 22 |
Client-defined master plan instance identifier. If both the acct_no or client_acct_id is passed in AND master_plan_instance_no or client_master_plan_instance_id is passed in with this array, all eligible orders for this account’s master plan instance will be cancelled. |
|||||||||||||||||
|
order_status_directive |
enum |
2 |
Defines the eligible orders for cancellation based on status. Allowable values for order_status_directive:
|
||||||||||||||||
End of account_order array |
||||||||||||||||||||
|
alt_caller_id |
string |
30 |
Person or process that submitted the API call. This can be someone's user ID, or the name of an application. |
||||||||||||||||
|
optional_transaction_qualifiers |
array |
|
Array of additional values you can associate with this API call. |
||||||||||||||||
|
qualifier_name |
string |
100 |
Name of the field you want to associate with this API call. |
||||||||||||||||
|
qualifier_value |
string |
100 |
Corresponding value of the field you want to associate with this API call. |
||||||||||||||||
|
application_id |
string |
300 |
The application identifier in which the API is being used in. (Example: “Sales Force”) |
||||||||||||||||
|
application_date |
string |
300 |
The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. |
Output Argument
Field Name |
Field Type |
Description |
---|---|---|
bulk_cancel_order_result |
array |
Bulk cancel order results. Please note that the save/commit happens at bulk_input_idx level. |
bulk_input_idx |
long |
Bulk input value provided in API input. This will be populated whether the cancellation was successful or not. |
order_no |
number |
Order number of the request if successfully cancelled. NULL indicates failure. |
client_order_id |
string |
Client Order Identifier of the request if successfully cancelled. NULL indicates failure. |
bulk_error_code |
long |
Aria-assigned error identifier. NULL indicates no error. |
bulk_error_msg |
string |
Description of any error that occurred. NULL indicates no error. |