cancel_order_m Sample Call and Response
This example shows a call that cancels a non-subscription order before it has been invoiced, based on the cancel_order_m method as defined in plsql_m_r73.yml.
This example covers the two identifying fields the method requires, the account and the order. It does not cover the alternative client-defined account identifier, and it does not cover an order that has already been invoiced, which this method cannot cancel.
Sample call
{
"rest_call": "cancel_order_m",
"output_format": "json",
"client_no": 60123,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"acct_no": 3005567,
"order_no": 9988771
}
The rest_call and output_format fields form the envelope that the REST layer adds to every call; they are not part of the method arguments defined in the yml file. The account is identified with acct_no, the Aria-assigned account identifier, rather than the alternative client-defined identifier, client_acct_id; you use only one of these two fields, never both. The order_no field has no alternative form and is always required. This method accepts no other optional fields beyond the identifiers shown here.
Sample response
{
"error_code": 0,
"error_msg": "OK"
}
An error_code of zero and an error_msg of "OK" indicate that the non-subscription order was cancelled successfully. This method returns no additional output fields beyond the standard error indicators.