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

 

Home > Aria Crescendo core api > get_acct_service_outage_credit_m

get_acct_service_outage_credit_m

This API retrieves the service outage for an account or master plan instance.

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.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string   This is the client-assigned identifier for the account.
outage_start_date string 22 The date of the beginning of the service outage for which a credit is being calculated.
outage_end_date string 22 The date of the end of the service outage for which a credit is being calculated.
  master_plan_instance_no long 22 The Master Subscription plan instance number.
  OR      
  client_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  outage_start_time string 22 The time the service outage started on the date provided in outage_start_date, in 24-hour format
  outage_end_time string 22 The time the service outage ended on the date provided in outage_end_date, in 24-hour format
  plan_no long array   Plan numbers to use to calculate the credit. Plans passed into this array will be used in a proration calculation to determine the cost of the plans for the exact time of the outage
  OR      
  client_plan_ids_to_get_outage string array 100 Plan ID's used to calculate the credit. Plans passed into this array will be used in a proration calculation to determine the cost of the plans for the exact time of the outage.
  adjust_percent double 22 If a full pro-rated credit is not desired, this adjustment factor will be multiplied against the calculated credit to deliver a final value. Allowable values for this field are numbers between 0 and 100, and represent a percentage
  locale_no long 30 Aria-assigned Locale identifier. This value is unique across all Aria-managed accounts.
  OR      
  locale_name string 100 Name of the locale to which the translations belong.
  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.
acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
service_outage_line_items hash  
plan_no long The unique plan identifier of a plan passed into plans_to_get_outage
plan_name string The name of the plan
service_no long The invoicing service number
service_name string The name of the service
outage_duration double Number of days in outage period
credit_amount double Amount of the outage credit
client_plan_id string Client-defined unique identifier for plan number
client_service_id string Client-defined unique identifier for service number.
out_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
out_master_plan_instance_no long The Master Subscription plan instance number.
out_client_mp_instance_id string Client-defined Master plan Subscription plan instance ID.
total_outage_credit double Sum total of the credit amounts of all the effected service plans
adjusted_outage_credit double Total outage credit adjusted based on the adjustment percentage provided in the input adjust_percent
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.

You must to post a comment.
Last modified
14:39, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.