Home > Aria Crescendo Documentation > Aria Crescendo core api > set_usage_threshold_m

set_usage_threshold_m

This API sets the Billing-Period-To-Date or Month-To-Date unbilled usage threshold amount on the master plan instance for client level event notifications or master plan instance level event notifications. In addition, the API also allows setting threshold levels.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
Start of mpi_usage_amount_thresholds array
  mpi_usage_amount_thresholds array    
  Field Name Field Type Max Length Description
  brd_arrow.gif master_plan_instance_no long 22 Aria generated unique identifier for the master plan instance.
  OR      
  brd_arrow.gif client_master_plan_instance_id string 100 Client-defined unique identifier for the master plan instance.
Start of amount_threshold_dest_types array
  brd_arrow.gif amount_threshold_dest_types array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gif threshold_dest_type string 1 Returns a string representing the threshold destination type either Stack S or Client C.  
Values Description
S It represents threshold destination type is Stack.
C It represents threshold destination type is Client.
Start of amount_threshold_balance_types array
  brd_arrow.gifbrd_arrow.gif amount_threshold_balance_types array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gif threshold_balance_type string 3 Returns a string representing the threshold balance type either month-to-date or billing-period-to-date.  
Values Description
MTD MTD (Month-To-Date)
PTD PTD (Billing-Period-To-Date)
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gif amount double 22 The threshold amount which, when crossed over or under unbilled usage balance, triggers an email notification or events.
End of amount_threshold_balance_types array
End of amount_threshold_dest_types array
End of mpi_usage_amount_thresholds array
 
Start of instance_usage_unit_thresholds array
  instance_usage_unit_thresholds array    
  Field Name Field Type Max Length Description
  brd_arrow.gif plan_instance_no long 22 Aria generated unique identifier for the plan instance.
  OR      
  brd_arrow.gif client_plan_instance_id string 100 Client-defined unique identifier for the plan instance.
Start of usage_services array
  brd_arrow.gif usage_services array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gif usage_type_no long   The Aria-assigned usage type number to set the threshold unit amount per specific usage type.
  OR      
  brd_arrow.gifbrd_arrow.gif client_usage_type_id string 22 Client-assigned identifier for the type to set the threshold unit amount per specific usage type. Either this field OR "usage_type_no" must be passed into the API to denote which usage type to set the threshold unit.
Start of unit_threshold_dest_types array
  brd_arrow.gifbrd_arrow.gif unit_threshold_dest_types array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gif threshold_dest_type string 1 Returns a string representing the threshold destination type either Stack S or Client C.  
Values Description
S It represents threshold destination type is Stack.
C It represents threshold destination type is Client.
Start of unit_threshold_balance_types array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gif unit_threshold_balance_types array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gif threshold_balance_type string 3 Returns a string representing the threshold balance type either month-to-date or billing-period-to-date.  
Values Description
MTD MTD (Month-To-Date).
PTD PTD (Billing-Period-To-Date).
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gif threshold_reference_units double   The total number of threshold units
Start of notification_levels array
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gif notification_levels array    
  Field Name Field Type Max Length Description
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gif level_no long   Indicates the level no of the threshold value
  brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gif notification_percentage double   No units for the threshold level
End of notification_levels array
End of unit_threshold_balance_types array
End of unit_threshold_dest_types array
End of usage_services array
End of instance_usage_unit_thresholds 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.
Start of optional_transaction_qualifiers array
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  Field Name Field Type Max Length Description
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
End of optional_transaction_qualifiers array
 
  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 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.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.