bulk_port_master_plan_instance_m Sample Call and Response
This example shows a call that moves a master plan instance from one account to another by cancelling it on the source account and creating it on the destination account, based on the bulk_port_master_plan_instance_m method defined in the plsql_m_r73.yml release file.
This example covers porting a single master plan instance between two accounts identified by their Aria-assigned account numbers. It does not cover porting by userid or client-defined identifiers, copying the source account's service destination contact to the destination account, or scheduling the port for asynchronous execution at a later time.
Sample call
{
"rest_call": "bulk_port_master_plan_instance_m",
"output_format": "json",
"client_no": 4001,
"auth_key": "a1b2c3d4e5f6g7h8i9j0",
"port_mpi": [
{
"bulk_input_idx": 1,
"porting_directive": 1,
"source_acct_no": 305567,
"source_master_plan_instance_no": 780234,
"dest_acct_no": 306120,
"dest_billing_group_no": 41002,
"dest_dunning_group_no": 6001,
"allow_copy_pi_service_dest_contact": 0
}
]
}
The port_mpi field is an array, since this bulk method accepts multiple porting requests in one call; this example shows a single entry, though a real call could include many more, each with its own bulk_input_idx. The porting_directive value of 1, meaning "Cancel and Create," is currently the only allowable value defined for this field. The source_acct_no, source_master_plan_instance_no, dest_acct_no, dest_billing_group_no, and dest_dunning_group_no fields are each used instead of their respective client-defined or userid-based alternatives. The allow_copy_pi_service_dest_contact value of 0 means personally identifiable information for service destination contacts is not copied from the source account to the destination account, which is the default behavior; a value of 1 would allow that information to be copied. This example leaves out execute_immediately, alt_bill_day, and offset_months entirely, since those fields are marked nonpublic in the method definition and carry no client-facing action.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"bulk_port_mpi_result": [
{
"bulk_input_idx": 1,
"bulk_error_code": null,
"bulk_error_msg": null,
"mpi_port_queue_id": 55012
}
]
}
An error_code of 0 together with an error_msg of "OK" indicates that the porting request was accepted. The bulk_port_mpi_result array reports one entry per submitted porting request; this example shows the single entry that corresponds to the one submitted request, and a real call with multiple entries in port_mpi would return one result entry for each. A bulk_error_code and bulk_error_msg of null indicate that this specific request was queued without error, and mpi_port_queue_id identifies the queued porting job that will perform the cancel-and-create operation.