set_usg_mtd_ptd_bal_m Sample Call and Response
This example shows a client resetting the month-to-date unbilled usage balance for a master plan instance to zero, based on the set_usg_mtd_ptd_bal_m method defined in plsql_m_r73.yml.
This example covers resetting the month-to-date balance for one master plan instance identified by its Aria-assigned account and instance numbers. It does not cover the client_acct_id or client_master_plan_instance_id fields, which are client-defined alternatives to acct_no and master_plan_instance_id, and it does not show the billing-period-to-date reset option.
Sample call
{
"rest_call": "set_usg_mtd_ptd_bal_m",
"output_format": "json",
"client_no": 12345,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"acct_no": 700456123,
"master_plan_instance_id": 900321,
"threshold_category": 1
}
The rest_call and output_format fields are added by the REST layer and are not part of the method's own argument list. The acct_no field belongs to a group of alternatives with client_acct_id, and the master_plan_instance_id field belongs to a group of alternatives with client_master_plan_instance_id; this example supplies the Aria-assigned numeric identifier in both cases. The threshold_category field is required and uses a two-value enumeration: zero means the billing-period-to-date balance, and one means the month-to-date balance; this example resets the month-to-date balance.
Sample response
{
"acct_no": 700456123,
"master_plan_instance_id": 900321,
"error_code": 0,
"error_msg": "OK"
}
An error_code value of zero, together with an error_msg value of "OK", indicates that Aria reset the specified unbilled usage balance to zero for the identified master plan instance. A nonzero error_code, paired with a descriptive error_msg, indicates that the reset did not occur, for example because the master_plan_instance_id did not belong to the specified account. This example leaves out the client_acct_id and client_master_plan_instance_id fields from the response, since this example identified the account and instance by their Aria-assigned numbers, and it leaves out the error_details field, since that field is internal to Aria and is not returned to callers.