Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria6 core api > discard_usage

discard_usage

If usage recorded in the Aria system was incorrect in some way, this API allows that usage to be discarded. Usage is still contained within the Aria system, but is not billable and will return with excluded reason codes if usage is fetched. Fetching usage from Aria prior to calling this API is not required, as it accepts either Aria-defined usage codes or client-defined usage codes.

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.
usage_record_no long array The system-defined usage record ID of the usage to be discarded
OR
client_record_id string array 50 If the above is not available, the client-defined record ID for the usage to be discarded
exclusion_reason_cd long 4 The exclude reason code, defining why these usage records are being removed
exclusion_comment string 300 Optional comment on the reason behind this API call
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.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
failed_records hash
usage_record_no long The system-defined usage record ID of the usage which was excluded
client_record_id string The client-defined usage record ID of the usage which was excluded, if available
record_error_code long For each record, an error code may be returned to indicate the usage was not properly excluded
record_error_msg string For each record, an error message may be returned to indicate the usage was not properly excluded

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.