Release MR73

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.

add_node

update_node

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.

 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_notification_category_list

update_notification_category_list

Extended method get_notification_list to support fetching notifications by users

Now send_mail, send_sms flag values are inherited from Notification Category settings (inside one category they are the same for all notifications)

Yes

get_notification_category_list

update_notification_category_list

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

add_allowed_location_advanced

Added extra filters to get_allowed_location_list

Added internal method to add allowed locations in raw

get_quick_forms_list

get_quick_form_fields_list

login

ping

reset_password

logout

Dropped backward compatibility crutches for API methods without authorization; now is using strict validation according schema

Affected customers who use SOAP: for methods ping, logout it's needed to send objects with { session_id => $session_id }; for method login it's needed to send { login => $login, password => $password } instead of just $login, $password

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

get_role_info,

get_role_list

create_otp,

verify_otp

Added new methods:

• The create_otp method enables getting the session one-time-password and sending to the recipient
• The verify_otp method verifies one-time-password by current session_id

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_log_info

add_access_policy

update_access_policy

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

get_location_log_list

add__location_log

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.

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

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()

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

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