delete_surcharge_m Sample Call and Response
This example shows a client deleting two surcharges, identified by their Aria-assigned surcharge numbers, that no longer apply to any billing group. It is based on the delete_surcharge_m method as defined in methods_m_r73.yml, Admin Tools API.
This example includes the only substantive input field the method accepts, surcharge_no, and shows a representative response for the deletion of two surcharges rather than an exhaustive list of every surcharge a client might delete in one call.
Sample call
{
"rest_call": "delete_surcharge_m",
"output_format": "json",
"client_no": 10023,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"surcharge_no": [6001, 6002]
}
The rest_call and output_format fields are not part of the method’s own documented arguments. The REST layer adds them to every call: rest_call names the method being invoked, and output_format requests a JSON response rather than the default WDDX format. Within the method’s own arguments, client_no and auth_key identify and authenticate the client making the call, and surcharge_no is required and carries the Aria-assigned surcharge numbers to delete. The yml models surcharge_no with struct: array and type: long, the same pattern used elsewhere in this family, so this example represents it as a flat JSON array of long values.
Sample response
{
"error_code": 0,
"error_msg": "OK"
}
An error_code of zero, paired with an error_msg of “OK,” indicates that Aria deleted both surcharges successfully. The method’s returns block consists only of these two error indicators, so there is no additional output to show.