Release MR70

Added 'get_total' field to the request of the mentioned method.

From now this method returns 'total' in the response only by 'get_total' in the request.

get_sip_call_list

API notifications

get_connection_list,

get_connection_info

Extended get_connection_list and get_connection_info API methods to return vendor_name in the ConnectionInfo structure.

Extended 'get_number_list' method to take 'number_list' input field in the request.

This field can contain an array of objects with 'i_did_number' field.

Such changes enable an API user to fetch a list of DID numbers by their i_did_number.

Extended 'get_number_list' method to take 'format' input field with possible values: csv, xls and xlsx.

In a case when format is present, the method will return a file with did numbers in the appropriate file format.

add_customer_class,

update_customer_class,

get_customer_class_info,

get_customer_class_list

add_service_policy,

update_service_policy,

get_attribute_list

Adjusted the behaviour of the mentioned methods.
From now 'possible_values' of the boolean attributes are [0,1] instead of ['Yes', 'No'].

If affects the values that are returned by get_attribute_list() for boolean value_type.
Also, a boolean attribute value can be equal to 0 or 1 in the requests of add_service_policy() and update_service_policy() methods.

The following fields are no longer mandatory:

• 'name' in TaxPluginInfo;
• 'description', 'code' in TaxTransactionCode.

The following fields are no longer mandatory:

• 'payment_method' in AccountPaymentMethodInfo;
• 'i_account', 'type' in CPConditionInfo;
• 'destination', 'i_dest' in DestinationPrefixInfo;
• 'i_env' in EnvInfo;
• 'description', 'i_oli', 'oli' in OliInfo;
• 'payment_method' in PaymentMethodInfo;
• 'i_tariff', 'name' in TariffInfo;
• 'xdr_type' in CustomerXDRInfo;
• 'name', 'external_id', 'type' in IPTVChannelPackage;
• 'name', 'external_id' in IPTVServicePackage.

The validation of the 'ip_filter' field was adjusted.

From now it's possible to specify a netmask in the field.

Both following formats are supported from now:
192.168.192.0/24 or 192.168.192.0/255.255.255.0

Affected methods: add_customer, update_customer, add_user, update_user

Affected API types: CustomerInfo, UserInfo

get_dialing_rule_info,

get_dialing_rules_list

Extended 'get_destination_list' method to take 'destination_list' input field in the request.

This field can contain an array of objects with 'i_dest' field.

Such changes enable an API user to fetch a list of destinations by their i_dest.

Account

Customer

Added new types for responses from this methods: AccountCustomFieldsInfo and CustomerCustomFieldsInfo. Responses will use Account_Custom_Fields and Customer_Custom_Fields ACL objects respectively

'is_used' and 'object' fields were removed from responces of this methods

*

• Extended get_destination_list() method to return spreadsheet attachment with destinations by 'file_format' input field (Possible values: 'csv', 'xls', 'xlsx').
  
  
• Implemented get_default_destination_list() method that returns spreadsheet attachment with default destination set.
  
  
• Removed unpublished download_destinations() method. The functionality of this method is covered by get_destination_list() and get_default_destination_list() methods from now.

Added the 'i_block_attr' and 'i_parent' fields  to the response, which establish dependencies between IVR options(unique id of a record - parent record)

Added 'with_usage' field to the method request.

Added 'activation_cost' and 'activation_revenue' fields to the DIDNumberInfo structure in the method response.

The fields are returned only in case if 'with_extended_info' attribute is true in the method request.

get_discount_plan_info,

get_discount_plan_list

The mentioned methods are extended to return 'is_complete' field in the DiscountPlanInfo structure.

These methods return the field only if the 'check_complete_status' input method attribute is true.

get_countries_list

*

The 'prefix' field is not mandatory in DIDCountryInfo anymore

The area_name and country_iso fields can be nil in the DIDRequestParameters struct

New input parameters 'entity_name', 'fields' and corresponding output fields were added.

The 'action_type' parameter was extended with 'read' option.

The 'comment' filter and the corresponding output field were removed.

add_user

update_user

get_user_list

add_tariff

update_tariff

get_tariff_info

get_tariff_list

Field 'volume_based' was removed from input parameters and TariffInfo output type

Added the following input filters:

'name', 'i_voice_application', 'description', 'number_pattern', 'with_callbacks'

get_emergency_unit_info

get_emergency_unit_list

add_emergency_unit

update_emergency_unit

delete_emergency_unit

Account

Customer

add_account

update_account

validate_account_info

add_customer

update_customer

validate_customer_info

add_subreseller

Several changes were made to ActiveSessionInfo type:

• field 'on_net' was added;
• types of fields 'hotlined', 'is_disconnectable' were changed to 'int'.

activate_subscriptions
add_account
add_account_advanced (internal)
add_account_with_topup (internal)
add_alias
add_allowed_location
add_auto_payment
add_cp_condition
add_cp_rule
add_followme_number
add_phonebook_record
add_preferable_account
add_subscription
arrange_cp_rules
arrange_followme_numbers
assign_sim_card
assign_ua
assign_ua_advanced (internal)
charge_subscription_fees
delete_account (internal)
delete_alias
delete_auto_payment
delete_cp_condition
delete_payment_method
estimate_call_price
estimate_taxes
generate_accounts
get_account_state
get_alias_list
get_allowed_addons (internal)
get_allowed_location_list
get_auto_payment_info
get_booths (internal)
get_call_barring_options
get_cp_condition_list
get_cp_rule_list
get_custom_fields_schema
get_custom_fields_values
get_full_vd_counter_info
get_member_of_huntgroups_list
get_moh_list_info
get_payment_method_info
get_permitted_sip_proxies_info
get_phonebook_list
get_preferable_account_list
get_service_features
get_service_wallet_xdr_list
get_services_consumption
get_sip_status
get_subscriptions
get_transactions_total_info
get_used_location_list
get_vd_counter_list
make_transaction
move_account
release_sim_card
release_ua
set_account_state
terminate_account
topup_account
update_account
update_account_followme
update_alias
update_auto_payment
update_booth (internal)
update_call_barring_options
update_cp_condition
update_payment_method
update_subscription
vd_topup

activate_subscriptions
add_abbreviated_dialing_number
add_auto_payment
add_batch
add_customer_extension
add_customer_huntgroup
add_customer_site
add_subscription
charge_subscription_fees
close_billing_period
delete_customer
delete_customer_extension
delete_payment_method
estimate_taxes
get_abbreviated_dialing_number_list
get_account_aliases_list
get_accounts_subscriptions (internal)
get_auto_payment_info
get_call_barring_options
get_callqueue_list
get_credit_limit_history
get_custom_fields_schema
get_custom_fields_values
get_custom_xdr_report
get_custom_xdr_report_list
get_customer_billing_periods_history
get_extensions_list
get_full_vd_counter_info
get_huntgroup_list
get_metrics_data
get_moh_list_info
get_number_sequence_info (internal)
get_payment_method_info
get_rt_tickets_list
get_service_features
get_service_wallet_xdr_list
get_services_consumption
get_sites
get_status_history
get_subscriptions
get_taxation_info
get_transactions_total_info
get_vd_counter_list
make_tax_transaction (internal)
make_transaction
modify_spending_limit
suspend_customer
terminate_customer
unsuspend_customer
update_call_barring_options
update_customer
update_customer_advanced (internal)
update_number_sequence (internal)
update_payment_method
update_service_features
update_subscription
update_taxation
vd_topup

get_dest_group_set_list,

get_dest_group_set_info

Adjust the method 'to_date' input filter to search transactions exactly by the datetime provided in the field.

Before these changes, back-end side added 24 hours to the provided datetime timestamp and only that performed search.

Add 'get_total' flag to the 'GetUAProfileListRequest' structure.

'total' field will be returned only if 'get_total' flag is passed.

add_user

update_user

get_user_info

get_user_list

Applied personal data filters to the mentioned methods;

Forbidden update access to the field hide_personal_info by non-superusers;

Forbidden update access to the field hide_personal_info to current user (to avoid shooting in his head)

update_taxation,

get_taxation_info

Extended update_taxation() method to take 'i_tax_transaction_code' and 'estimate_taxes' fields in the method request.

Extended get_taxation_info() method to return 'i_tax_transaction_code' and 'estimate_taxes' fields in the method response.

update_taxation,

get_taxation_info

Extended update_taxation() method to take 'i_tax_transaction_code' and 'estimate_taxes' fields in the method request.

Extended get_taxation_info() method to return 'i_tax_transaction_code' and 'estimate_taxes' fields in the method response.

The 'search' filter of the mentioned method was adjusted.

From now '%' and '_' symbols in this filter won't be escaped on the method level.

If you need the previous behaviour - please escape these symbols manually before sending them in a request.

1. From now the 'i_online_payment_processor' field is always taking into account in the 'merchant_account' input object (before these changes the field was ignored if '"remittance":1' was present in the request)
2. Removed 'remittance' field from the method request,

From now the method automatically determines whether the adding processor is remittance by 'i_online_payment_processor' field in the 'merchant_account' input object.

get_xdr_list
get_tsransactions_total_info

get_number_list,

get_number_info,

get_number_list_statistics

The metioned method were reconsidered to correctly return DID numbers if called from reseller realm.

Before these changes, a reseller could see only DID numbers that were in the i_do_batch that is managed by the reseller.

From now, for the reseller realm, the methods return the following categories of DID numbers:

1. Assigned directly to the reseller that called the methods or to his subresellers;
2. Assigned to a DID pricing batch that is managed by the reseller who called the methods or to the DID pricing batch that is managed by his subresellers;
3. Located in the DID pool, in case if the reseller has a pricing batch assigned to him (i_do_batch).
   

get_rate_list,

search_rate_list

• country field, from 'country' to 'i_dest',
• description field from 'description' to 'i_dest',
• destination field from 'destination' to 'i_dest',
• destination_group field from 'destination_group' to 'i_dest',
• effective_now field from 'effective_now' to 'effective_from',
• network field from 'network' to 'i_dest',
• unit field from 'unit' to 'i_tariff',
• rate_unit field from 'rate_unit' to 'i_tariff',

• editable,
• effective_immediately,
• i_rate.

YT:BA-14752

Adjusted mentioned method to return rates with hidden == 'Y' by default.

The related get_rate_list() method already returns hidden rated by default.

add_customer

update_customer

*

add_user

update_user

*

update_cp_condition

delete_cp_condition

Added the 'check_available_dids' optional argument to the request of the mentioned method.

The field has the following description:

If 'gen_method' is set to 'D' and the field is set to '1', the method will check available numbers and fall with an error if the number of available numbers is less than the value in the 'gen_amount' field

Removed ACL attribute from the 'i_dest' field in the RepresentativeXDRInfo structure.

The field is used to determine the transaction type of an XDR. There is no sense to restrict access to the field by ACL permissions.

Customer

Account

get_customer_xdrs

get_xdr_list

get_ui_config_list,

update_ui_config_list

The method was extended to return the following additional fields in the AuthzRuleInfo structure if the with_extended_info input field is equal to 1: account_id, connection_description and node_name.

Added a new 'autogenerated' filter to be possible in the method request.

The filter is used to search autogenerated or manually created authentication rules.

get_roaming_profile_list,

get_roaming_profile_info,

add_roaming_profile

Extend 'get_roaming_profile_list' method with 'with_contries' argument. The list of countries for each profile will be returned if the argument is set to 'Y'.

add_roaming_profile, get_roaming_profile_list, get_roaming_profile_info methods were extended with 'default_restriction_level' argument which allows to specify default restriction level for countries while creating new roaming profile.

get_resale_map_list

add_resale_tariff_mappings

Methods enabled for Admin realm.

'get_resale_map_list' extended with filter by 'i_tariff_buy'

Add a method that returns previously saved file with errors.

For now, the method can be used to return extended errors of previously failed upload*() API methods.

get_subscriptions

add_subscription

update_subscription

close_subscription

delete_subscription

activate_subscriptions

The method-level ACL check was adjusted to take the realm and ownership information into account.

In the 'reseller' realm the 'Subcustomers.Customer_Subscriptions' access object is used when working with subscriptions of subcustomers, 'Subresellers.Customer_Subscriptions' - when working with subscriptions of subresellers and 'Callshops.Customer_Subscriptions' - when working with subscriptions of callshops.

Reconsidered behaviour of upload API methods so that they fail with an error if at least one record is not processed correctly.

The following methods were affected:

• EmergencyUnit.upload_emergency_units()
• Destination.upload()
• Destination.upload_dest_group_set()
• DID.upload_did_numbers()

Removed 'result_list' field from the responses of:

• EmergencyUnit.upload_emergency_units()
• DID.upload_did_numbers()

From now all mentioned methods started to store spreadsheet files with errors in case if at least one record is not processed correctly. The uuid of the stored file is returned in faultdetails field of the API fault. The file with errors can be fetched from the system by Generic.get_api_error_file() API method.

YT:BA-17993

Reconsidered behaviour of API methods for processing the batch of entities so that they fail with error if at least one record is not processed correctly.

The following methods were affected:

• CDR.revert_xdr_list()
• DID.update_number_list()
• DID.delete_number_list()
• Invoice.regenerate_invoice_list()

These methods stopped to return errors in response hashes.

From now if at least one record is not processed correctly, the methods fail with 500 code, return faultstring, faultcode and detailed info with error messages per-failed record in the 'faultdetails' field.

The mentioned method was extended to take xls and xlsx attachment.

Reconsidered behaviour of the method so that it fails with an error if at least one record is not processed correctly.

add_owner_batch

get_owner_batch_list

get_owner_batch_info

Filter 'i_customer' was marked as 'mandatory'. Filter 'from_date' is now mandatory only if 'to_date' is not provided (and visa versa).

The implicit default (current time) is not used for 'to_date' anymore.

A null value for the 'i_time_zone' field was allowed ( null stands for "Auto" ).

The default value of 'i_time_zone' field was removed on Custom Report creation.

A null value of 'i_time_zone' field was allowed in the method response.

Added the 'get_total' input argument to be possible in the request of the mentioned method.

The default value of the field is 1 (needed to keep backward compatibility).

 get_representative_list

 get_representative_info

Extended RepresentativeInfo with field commission_plan_effective_from

 get_customer_list

 get_customer_info

Extended CustomerInfo with field commission_plan_effective_from

get_fraud_traffic_profile_list

get_constraint_list

Added filter by name to get_fraud_traffic_profile_list

Added filter by accumulation_period and i_dest_group to get_constraint_list

add_custom_field

update_custom_field

Added the following methods in the mentioned service:

• get_fraud_traffic_profile_info();
• add_fraud_traffic_profile();
• update_fraud_traffic_profile();
• delete_fraud_traffic_profile();

Added the following fileds to be possible in the get_fraud_traffic_profile_list() request:

i_dest_group_set, limit, offset, get_total, check_usage

get_owner_batch_info

get_owner_batch_list

Added 'check_usage' field to the requests of the mentioned methods.

'used' field will be returned in the response if 'check_usage' is true.

Request is extended with 'topup_amount', 'topup_fee', 'topup_expiry_time' filters

get_metric_charge_methods_list

get_measured_metrics_list

get_subscriptions

get_service_and_rating_list

Added filter by 'i_subscription' to the request of 'get_subscriptions' method.

Added filter by 'i_service', 'i_node' and 'cld' to the request of 'get_service_and_rating_list' method.

Made 'activation_date' field to be not mandatory in the mentioned method request.

The current date is taken in case if the 'activation_date' field is not present in the method request.

add_sim_card,

update_sim_card

Removed obsolete field 'i_spend_plan' from the GetSpendingPlanCounterRequest request.

'i_customer' now mandatory for the GetSpendingPlanCounterRequest

add_roaming_profile

update_roaming_profile

get_inventory_options

update_inventory_options

get_inventory_option_info

Added i_customer to input parameters of get_inventory_options and update_inventory_options

Added method get_inventory_option_info

get_connection_type_list

get_connection_type_info

Added filter name to get_connection_type_list

Added method get_connection_type_info

get_allowed_location_list

Added extra filters to get_allowed_location_list

get_quick_forms_list

get_quick_form_fields_list

update_sim_card,

update_sim_card_list

Extended update_sim_card() method to update managed_by of the cards that are not assigned to account.

Implemented update_sim_card_list() that can process several sim cards using one request.

get_ua_profile_info

get_ua_profile_list

add_default_cb_option

get_default_cb_option_info

get_product_property_history_list

add_product_property_history

get_billing_period_history_list

add_billing_period_history

get_billing_period_totals_list

add_billing_period_totals

Added get_billing_period_history_list() and add_billing_period_history() methods for Customer_BPHistory management.

Added get_billing_period_totals_list() and add_billing_period_totals() methods for Customer_BPTotals management.

UA

Account

get_ua_info

get_ua_list

assign_ua

UAInfo structure was extended with the 'i_service_type' and 'allowed_services' fields. These fields will be returned for devices that require specifying the type of service that will be provisioned via the port.

AssignUARequest extended with the 'ports_config_list' attribute.

Account

Customer

get_custom_fields_values

update_custom_fields_values

Output of the method get_custom_fields_values for Account and Customer services was extended with additional fields: 'i_custom_field', 'i_custom_field_value'.

Input of the method update_custom_fields_values for Account and Customer services was extended with parameter 'i_custom_field' which enables an API user to update custom field by i_custom_field as well as by name. Either i_custom_field or name is required.

add_tax_transaction_code

get_tax_transaction_code_info

get_tax_transaction_code_list

get_did_provider_list

get_did_provider_info

get_prompt_file

get_callqueue_prompt_file

get_callqueue_moh_file

get_status_info

get_type_info

Added 'available_to_customer' input filter for the mentioned method.
If the filter is sent with the ID of a customer, the method will return only DID numbers that are assignable to this customer (including already assigned; to return only free numbers also send usage == 'F' flag).

get_spending_plan_counter_list

Implemented 'get_spending_plan_counter_list' method which enables an API user to retrieve the list of the spending plan counters

Added the following filters to the method request:

account_id, status, porting_number, due_date_from, due_date_to.

Fixed type of the due_date field of the PortingRequestInfo XSD structure.

The field contains 'datetime' data type, but on the XSD level there was a 'date' data type. Data type was corrected.

Yes

get_service_type_info,

get_service_type_list

Extended the get_service_type_info() method to return INTERNAL service type .

Extended the get_service_type_info() method to return INTERNAL and DID service types by the 'with_internal' flag in the request.

The 'effective_from' filter was extended with 'upcoming' and 'outdated' filters.

Added a session ID header field to the message meta info.

Added a list of billing session ID of related sessions.

Added 'get_simple_info' flag that allows to fetch the simplified list of rates without info from other tables.

Customer

Account

Added the following filters for the mentioned method:

i_service, i_dest_group, threshold_type, i_vd_type, is_usage_period_set

terminate_account

update_account

delete_alias

update_alias

get_account_info

get_alias_list

The 'check_did' flag is added to the GetAliasListRequest structure.

The 'i_did_number' field is added to the responses of the mentioned methods. It is present in the response of the 'get_account_info' method by default if the account has a did number assigned. To obtain this field in the response of the 'get_alias_list' method it is needed to pass the 'check_did' flag.

Account

Customer

Added the 'with_thresholds' flag to give an opportunity to retrieve a list of thresholds for the specified discount

Account

Customer

get_number_list,

get_number_info

1. Added 'external' field to every DIDNumberInfo XSD structure in the methods' responses.
2. Added 'external' input filter for the get_number_list()

1. Added new SOAP types: 'TemplateBodyInfo', 'TemplateComponentInfo', 'TemplateMediaAttributeInfo' and 'TemplateDataFieldInfo;
2. The SOAP type 'TemplateInfo' extended with the fields 'i_time_zone', 'tz' and 'body_list';
3. Added new methods for managing templates:
- get_template_info
- add_external_invoice_template
- upload_external_invoice_template_body
- upload_external_invoice_template_image
- delete_external_invoice_template_image
- add_tariff_download_template
- update_template
- delete_template
- get_template_component_list
- get_template_media_attribute_list
- update_template_media_attribute_list
- get_template_data_field_list
- update_template_data_field_list

get_ua_info

get_ua_list

get_payment_method_info

get_taxation_info

get_transaction_actions_list

get_payment_methods_for_owner

get_countries_list

get_subdivisions_list

Account

Customer

Extend method with new filters: companyname, country, state, note, bcc, midinit, zip, tax_id

get_custom_report_query_list

get_custom_report_query_info

Extend filters with:

• midinit
• lastname
• cont2
• country
• state
• zip
• companyname
• note

modify_request

create_portin_request

get_request_list