Benefit Plan Rollover API | Administrative - SOAP

The BenefitPlanRollover service allows you to add, update, delete, and retrieve rollover configuration for your plans and employers.

Service web methods

• AddBenefitPlanRolloverSetting - This method is used to add rollover configuration for a plan.
• UpdateBenefitPlanRolloverSetting - This method is used to update rollover configuration for a plan.
• DeleteBenefitPlanRolloverSetting - This method is used to delete rollover configuration for a plan.
• GetBenefitPlanRolloverSetting - This method is used to retrieve rollover configuration for a specific plan.
• GetBenefitPlanRolloverSettings - This method is used to retrieve rollover configuration for all plans under a specific employer.

Service assumptions and business rules

• Clients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus and the administrator.
• Clients shall format SOAP messages in a document/literal format over HTTPS.
• Clients shall have already created a valid user ID and password.
• Clients shall have a valid session ID after being authenticated by the system. The session ID needs to be passed in the proper manner as described in the account manager service guide.
• If the administrator uses the same user ID and password for all of their clients, the administrator is responsible for managing the security of the data.
• Clients should validate data before submitting a request to this service. This facilitates better performance and accurate processing on both systems.
• Clients shall not attempt to use this Service for batch processing of large amounts of data. The service is designed for synchronous calls that send or retrieve small chunks of data. If batch processing is required, then the EDI process should be used.
• If any method fails, the service returns a SOAP fault describing the problem.

AddBenefitPlanRolloverSetting

This method is used to add rollover configuration for a plan.

History

The AddBenefitPlanRolloverSetting methods are listed below:

• AddBenefitPlanRolloverSettingRequest
• AddBenefitPlanRolloverSettingRequest_2014_06

• AddBenefitPlanRolloverSettingResult

AddBenefitPlanRolloverSetting request/response message

• The AddBenefitPlanRolloverSetting method requires the following request and response messages (input and output data.)

Response message:

Example of AddBenefitPlanRolloverSetting SOAP request message:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mbi="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers" xmlns:v1="http://bensoft.metavante.com/WebServices/Contracts/BenefitPlanRollover/2011/04/V1" xmlns:ns="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Request/2011/04/"> 
      <soapenv:Header> 
            <mbiSessionHeader>
                  <mbi:MBISessionID>oiqki3ah52czdxov3a1wn055</mbi:MBISessionID> 
            </>mbiSessionHeader> 
      </soapenv:Header> 
      <soapenv:Body> 
            <v1:AddBenefitPlanRolloverSetting> 
                  <v1:request xsi:type="ns513:AddBenefitPlanRolloverSettingRequest_2016_04" xmlns:ns513="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Request/2016/04/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 
                        <ns:AcctTypeCde>FB2</ns:AcctTypeCde> 
                        <ns:EmprId>DJA675756564</ns:EmprId> 
                        <ns:FundRolloverTypeCde>Primary</ns:FundRolloverTypeCde><ns:PlanId>FB2SRC</ns:PlanId> 
                        <ns:PlanRolloverOptions xsi:nil="true"/> 
                        <ns:PlanYrEndDte>20230912</ns:PlanYrEndDte> 
                        <ns:PlanYrStartDte>20230101</ns:PlanYrStartDte> 
                        <ns:RolloverDte>2023-09-15</ns:RolloverDte> 
                        <ns:TargetAcctTypeCde>FB2</ns:TargetAcctTypeCde> 
                        <ns:TargetPlanId>FB2TAR</ns:TargetPlanId> 
                        <ns:TargetPlanYrEndDte>20240913</ns:TargetPlanYrEndDte> 
                        <ns:TargetPlanYrStartDte>20230913</ns:TargetPlanYrStartDte> 
                        <ns:TpaId>T02497</ns:TpaId> 
                        <ns:TrackingNumber xsi:nil="true"/> 
                        <ns1:MinimumRolloverAmountofFund xsi:nil="true" xmlns:ns1="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Request/2014/06/"/><ns513:MaxRolloverAmtofFunds>AllFunds</ns513:MaxRolloverAmtofFunds> 
                  </v1:request> 
            </v1:AddBenefitPlanRolloverSetting> 
      </soapenv:Body> 
</soapenv:Envelope> 

Example of AddBenefitPlanRolloverSetting SOAP response message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
     <s:Header>
          <ActivityId CorrelationId="ed929667-813c-4439-818e-c0af5b8f5047" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
          <MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
               <MessageId>urn:uuid:ae4ca028-b00a-4c93-8113-a837f032a895</MessageId>
          </MBIMessageIdHeader>
     </s:Header>
     <s:Body>
          <GetBenefitPlanRolloverSettingResponse xmlns="http://bensoft.metavante.com/WebServices/Contracts/BenefitPlanRollover/2011/04/V1">
               <GetBenefitPlanRolloverSettingResult i:type="b:GetBenefitPlanRolloverSettingResponse_2014_06" xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Response/2011/04/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Response/2014/06/">
                      <a:AcctTypeCde>FSL</a:AcctTypeCde>
                      <a:EmprId>9HR2345</a:EmprId>
                      <a:FundRolloverTypeCde>Primary</a:FundRolloverTypeCde>
                      <a:IndividualBalanceMax>-1</a:IndividualBalanceMax>
                      <a:IndividualRolloverAmt>-1.0000</a:IndividualRolloverAmt>
                      <a:IndividualRolloverRate>-1.00</a:IndividualRolloverRate>
                      <a:PlanId>CAPSOURCE</a:PlanId>
                      <a:PlanYrEndDte>20220707</a:PlanYrEndDte>
                      <a:PlanYrStartDte>20220701</a:PlanYrStartDte>
                      <a:RolloverAmt>-1.0000</a:RolloverAmt>
                      <a:RolloverBalanceMax>-1</a:RolloverBalanceMax>
                      <a:RolloverDte>7/8/2022 12:00:00 AM</a:RolloverDte>
                      <a:RolloverEligibilityDateType>TargetPlanStartDate</a:RolloverEligibilityDateType>
                      <a:RolloverLastAutoDepositDateType>TargetPlanStartDate</a:RolloverLastAutoDepositDateType>
                      <a:RolloverRate>-1.00</a:RolloverRate>
                      <a:TargetAcctTypeCde>FSL</a:TargetAcctTypeCde>
                      <a:TargetPlanId>CAPTRAGET</a:TargetPlanId>
                      <a:TargetPlanKey>324</a:TargetPlanKey>
                      <a:TargetPlanYrEndDte>20220731</a:TargetPlanYrEndDte>
                      <a:TargetPlanYrStartDte>20220708</a:TargetPlanYrStartDte>
                      <a:TpaId>T02888</a:TpaId>
                      <b:MinimumRolloverAmountofFund>-1.0000</b:MinimumRolloverAmountofFund>
              </<GetBenefitPlanRolloverSettingResult>
      </<GetBenefitPlanRolloverSettingResponse>
   </s:Body>
</<s:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when calling the AddBenefitPlanRolloverSetting web method.

try
{
     // Create the session SOAP header in order to pass the Service
     // the client’s current session id.
     mbiSessionHeader = new BenefitPlanRolloverServiceNameSpace.MBISessionHeader();
     // Create proxy object for the service
     proxy = new BenefitPlanRolloverServiceNameSpace.BenefitPlanRolloverService();
     // Create request message for method call (input parameters)
     request = new BenefitPlanRolloverServiceNameSpace.AddBenefitPlanRolloverSettingRequest_2016_04();
     // Set the input parameters
     request.AccountTypeCode = _AccountTypeCode.Text;
     request.EmprId = _EmprId.Text;
     request.PlanId = _PlanId.Text;

     if(_PlanYrStartDte.Text.Length > 0)
     {
          request.PlanYrStartDte = Convert.ToDateTime(_PlanYrStartDte.Text);
     }

     if(_PlanYrEndDte.Text.Length > 0)
     {
          request.PlanYrEndDte = Convert.ToDateTime(_PlanYrEndDte.Text);
     }

     request.TpaId = _TpaId.Text;
     request.TargetAcctTypeCde = _TargetAcctTypeCde.Text;
     request.TargetPlanId = _TargetPlanId.Text;

     if(_TargetPlanYrStartDte.Text.Length > 0)
     {
          request.TargetPlanYrStartDte = _TargetPlanYrStartDte.Text;
     }

     if(_TargetPlanYrEndDte.Text.Length > 0)
     {
          request.TargetPlanYrEndDte = _TargetPlanYrEndDte.Text;
     }

     request.FundRolloverTypeCde = (FundRolloverMethods)_FundRolloverTypeCde.Text;

     if(_RolloverDte.Text.Length > 0)
     {
          request.RolloverDte = Convert.ToDateTime(_RolloverDte.Text);
     }

     request.PlanRolloverOptions = Convert.ToInt32(_PlanRolloverOptions.Text);
     request.RolloverEligDteType = (RolloverEligibilityDateType)_RolloverEligDteType.Text;
     request.AutoDepositStartDteType = (RolloverLastAutoDepositDateType)_AutoDepositStartDteType.Text;
     request.RolloverAmt = Convert.ToDecimal(_RolloverAmt.Text);
     request.RolloverRate = Convert.ToDecimal(_RolloverRate.Text);
     request.IndividualRolloverAmt = Convert.ToDecimal(_IndividualRolloverAmt.Text);
     request.IndividualRolloverRate = Convert.ToDecimal(_IndividualRolloverRate.Text);
     request.TrackingNumber = _TrackingNumber.Text;
     request.MinimumRolloverAmountofFund = Convert.ToDecimal(_MinimumRolloverAmountofFund.Text);
     request.MaxRolloverAmtofFunds = (MaxRolloverAmtofFunds)_MaxRolloverAmtofFunds.Text;
     // session ID returned from login method
     mbiSessionHeader.MBISessionID = _sessionId.Text;
     proxy.MBISessionHeaderValue = mbiSessionHeader;
     // Call the method
     response = proxy.AddBenefitPlanRolloverSetting(request);
     MessageBox.Show("Finished.");
}
catch(SoapException se)
     MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
     MessageBox.Show("EXCEPTION:" + ex.Message);
}

UpdateBenefitPlanRolloverSetting

This method is used to update rollover configuration for a plan.

History

The UpdateBenefitPlanRolloverSetting methods are listed below:

• UpdateBenefitPlanRolloverSettingRequest
• UpdateBenefitPlanRolloverSettingRequest_2014_06

• UpdateBenefitPlanRolloverSettingResponse

UpdateBenefitPlanRolloverSetting request/response message

The UpdateBenefitPlanRolloverSetting method requires the following request and response messages (input and output data.)

Response message:

Example of UpdateBenefitPlanRolloverSetting SOAP request message:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mbi="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers" xmlns:v1="http://bensoft.metavante.com/WebServices/Contracts/BenefitPlanRollover/2011/04/V1" xmlns:ns="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Request/2011/04/">
   <soapenv:Header>
      <mbiSessionHeader>
         <!--Optional:-->
         <mbi:MBISessionID>r3adzpndwjsqeqnuaqkmnkpn</mbi:MBISessionID>
      </mbiSessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <v1:UpdateBenefitPlanRolloverSetting>
         <!--Optional:-->
         <v1:request xsi:type="ns40:UpdateBenefitPlanRolloverSettingRequest_2016_04" xmlns:ns40="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Request/2016/04/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ns:AcctTypeCde>FB2</ns:AcctTypeCde>
            <!--Optional:-->
            <ns:EmprId>SHAEMPGP</ns:EmprId>
            <!--Optional:-->
            <ns:FundRolloverTypeCde>Primary</ns:FundRolloverTypeCde>
            <!--Optional:-->
            <!--Optional:-->
            <ns:PlanId>SRCPL01</ns:PlanId>
            <!--Optional:-->
            <ns:PlanYrEndDte>20230930</ns:PlanYrEndDte>
            <ns:PlanYrStartDte>20230901</ns:PlanYrStartDte>
            <!--Optional:-->
            <!--Optional:-->
            <ns:RolloverDte>2023-10-06</ns:RolloverDte>
            <!--Optional:-->
            <!--Optional:-->
            <ns:TargetAcctTypeCde>FB2</ns:TargetAcctTypeCde>
            <ns:TargetPlanId>TRG01PL</ns:TargetPlanId>
            <ns:TargetPlanYrEndDte>20231031</ns:TargetPlanYrEndDte>
            <ns:TargetPlanYrStartDte>20231001</ns:TargetPlanYrStartDte>
            <ns:TpaId>T02198</ns:TpaId>
            <!--Optional:-->
            <ns:TrackingNumber xsi:nil="true"/>
            <!--Optional:-->
            <ns1:MinimumRolloverAmountofFund xmlns:ns1="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Request/2014/06/">1</ns1:MinimumRolloverAmountofFund>
            <!--Optional:-->
         </v1:request>
      </v1:UpdateBenefitPlanRolloverSetting>
   </soapenv:Body>
</soapenv:Envelope>

Example of UpdateBenefitPlanRolloverSetting SOAP response message:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="916fe779-1fac-4e2c-ac1d-7d5f7ced5f4d" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
      <MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
         <MessageId>urn:uuid:1e980bdf-ab02-4974-bf4e-916c05214a65</MessageId>
      </MBIMessageIdHeader>
      <mbiWarningsHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
         <MBIWarnings xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">
            <MBIWarningsHeader.MBIWarning>
               <Code>990873
               <Message>Grace period date should not be provided when fund rollover enabled.</Message>
            </<MBIWarningsHeader.MBIWarning>
            <MBIWarningsHeader.MBIWarning i:nil="true"/>
         </<MBIWarnings>
      </mbiWarningsHeader>
   </s:Header>
   <s:Body>
      <UpdateBenefitPlanRolloverSettingResponse xmlns="http://bensoft.metavante.com/WebServices/Contracts/BenefitPlanRollover/2011/04/V1">
         <UpdateBenefitPlanRolloverSettingResult xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Response/2011/04/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:ErrorCode>0</a:ErrorCode>
            <a:ErrorDescription>OK</a:ErrorDescription>
            <a:TrackingNumber i:nil="true"/>
         </<UpdateBenefitPlanRolloverSettingResult>
      </<UpdateBenefitPlanRolloverSettingResponse>
   </<s:Body>
</s:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when calling the UpdateBenefitPlanRolloverSetting web method.

try
{
          // Create the session SOAP header in order to pass the Service
          // the client’s current session id.
          mbiSessionHeader = new BenefitPlanRolloverServiceNameSpace.MBISessionHeader();
          // Create proxy object for the service
          proxy = new BenefitPlanRolloverServiceNameSpace.BenefitPlanRolloverService();
          // Create request message for method call (input parameters)
          request = new BenefitPlanRolloverServiceNameSpace.UpdateBenefitPlanRolloverSettingRequest_2016_04();
          // Set the input parameters
          request.AcctTypeCde = _AcctTypeCde.Text;
          request.EmprId = _EmprId.Text;
          request.PlanId = _PlanId.Text;
          if(_PlanYrEndDte.Text.Length > 0)
          {
                          request.PlanYrEndDte = _PlanYrEndDte.Text;
           }
          if(_PlanYrStartDte.Text.Length > 0)
          {
                          request.PlanYrStartDte = _PlanYrStartDte.Text;
          }
          request.TpaId = _TpaId.Text;
          request.TargetAcctTypeCde = _TargetAcctTypeCde.Text;
          request.TargetPlanId = _TargetPlanId.Text;
          if(_TargetPlanYrStartDte.Text.Length > 0)
          {
                          request.TargetPlanYrStartDte = _TargetPlanYrStartDte.Text;
          }
          if(_TargetPlanYrEndDte.Text.Length > 0)
          {
                          request.TargetPlanYrEndDte = _TargetPlanYrEndDte.Text;
          }
          request.FundRolloverTypeCde = (FundRolloverMethods)_FundRolloverTypeCde.Text;
          if(_RolloverDte.Text.Length > 0)
          {
                          request.RolloverDte = Convert.ToDateTime(_RolloverDte.Text);
          }
          request.PlanRolloverOptions = Convert.ToInt32(_PlanRolloverOptions.Text);
          request.RolloverEligDteType = (RolloverEligibilityDateType)_RolloverEligDteType.Text;
          request.AutoDepositStartDteType = (RolloverLastAutoDepositDateType)_AutoDepositStartDteType.Text;
          request.RolloverAmt = Convert.ToDecimal(_RolloverAmt.Text);
          request.RolloverRate = Convert.ToDecimal(_RolloverRate.Text);
          request.IndividualRolloverAmt = Convert.ToDecimal(_IndividualRolloverAmt.Text);
          request.IndividualRolloverRate = Convert.ToDecimal(_IndividualRolloverRate.Text);
          request.TrackingNumber = _TrackingNumber.Text;
          request.MinimumRolloverAmountofFund = Convert.ToDecimal(_MinimumRolloverAmountofFund.Text);
          request.MaxRolloverAmtofFunds = (MaxRolloverAmtofFunds)_MaxRolloverAmtofFunds.Text;
          // session ID returned from login method
          mbiSessionHeader.MBISessionID = _sessionId.Text;
          proxy.MBISessionHeaderValue = mbiSessionHeader;
          // Call the method
          response = proxy.UpdateBenefitPlanRolloverSetting(request);
          MessageBox.Show("Finished.");
}
catch(SoapException se)
{
          MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
          MessageBox.Show("EXCEPTION:" + ex.Message);
}

DeleteBenefitPlanRolloverSetting

This method is used to delete rollover configuration for a plan.

History

The DeleteBenefitPlanRolloverSetting methods are listed below:

• DeleteBenefitPlanRolloverSettingRequest

• DeleteBenefitPlanRolloverSettingResponse

DeleteBenefitPlanRolloverSetting request/response messages

The DeleteBenefitPlanRolloverSetting method requires the following request and response messages (input and output data.)

Response message:

Example of DeleteBenefitPlanRolloverSetting SOAP request message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mbi="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers" xmlns:v1="http://bensoft.metavante.com/WebServices/Contracts/BenefitPlanRollover/2011/04/V1" xmlns:ns="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Request/2011/04/">
   <soapenv:Header>
      <mbiSessionHeader>
         <!--Optional:-->
         <mbi:MBISessionID>bvr4ivlfosuo1xvcckq24t4q</mbi:MBISessionID>
      </mbiSessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <v1:DeleteBenefitPlanRolloverSetting>
         <!--Optional:-->
         <v1:request>
            <ns:AcctTypeCde>FB2</ns:AcctTypeCde>
            <ns:EmprId>9HR2345      </ns:EmprId>
            <ns:FundRolloverTypeCde>Primary</ns:FundRolloverTypeCde>
            <ns:PlanId>FSAP1</ns:PlanId>
            <ns:PlanYrEndDte>20230830</ns:PlanYrEndDte>
            <ns:PlanYrStartDte>20230801</ns:PlanYrStartDte>
            <ns:TpaId>T02888</ns:TpaId>
            <!--Optional:-->
            <ns:TrackingNumber>0</ns:TrackingNumber>
         </v1:request>
      </v1:DeleteBenefitPlanRolloverSetting>
   </soapenv:Body>
</soapenv:Envelope>

Example of DeleteBenefitPlanRolloverSetting SOAP response message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="889eff1d-46f2-4b26-ab33-8f358fff611b" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
      <MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
         <MessageId>urn:uuid:33052fc2-52a2-4f97-bda7-7a5626efd441</MessageId>
      </MBIMessageIdHeader>
   </s:Header>
   <s:Body>
      <DeleteBenefitPlanRolloverSettingResponse xmlns="http://bensoft.metavante.com/WebServices/Contracts/BenefitPlanRollover/2011/04/V1">
         <DeleteBenefitPlanRolloverSettingResult xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Response/2011/04/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:ErrorCode>0</a:ErrorCode>
            <a:ErrorDescription>OK</a:ErrorDescription>
            <a:TrackingNumber>0</a:TrackingNumber>
         </DeleteBenefitPlanRolloverSettingResult>
      </DeleteBenefitPlanRolloverSettingResponse>
   </s:Body>
</s:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when calling the DeleteBenefitPlanRolloverSetting web method.

try
{
         // Create the session SOAP header in order to pass the Service
         // the client’s current session id.
        mbiSessionHeader = new BenefitPlanRolloverServiceNameSpace.MBISessionHeader();
       // Create proxy object for the service
        proxy = new BenefitPlanRolloverServiceNameSpace.BenefitPlanRolloverService();
       // Create request message for method call (input parameters)
                request = new BenefitPlanRolloverServiceNameSpace.DeleteBenefitPlanRolloverSettingRequest();
      // Set the input parameters
                request.AcctTypeCde = _AcctTypeCde.Text;
        request.EmprId = _EmprId.Text;
        request.PlanId = _PlanId.Text;
        if(_PlanYrEndDte.Text.Length > 0)
        {
                  request.PlanYrEndDte = _PlanYrEndDte.Text;
        }
        if(_PlanYrStartDte.Text.Length > 0)
        {
        request.PlanYrStartDte = _PlanYrStartDte.Text;
        }
        request.TpaId = _TpaId.Text;
                request.FundRolloverTypeCde = (FundRolloverMethods)_FundRolloverTypeCde.Text;
                request.TrackingNumber = _TrackingNumber.Text;
      // session ID returned from login method
        mbiSessionHeader.MBISessionID = _sessionId.Text;
        proxy.MBISessionHeaderValue = mbiSessionHeader;
      // Call the method
        response = proxy.DeleteBenefitPlanRolloverSetting(request);
        MessageBox.Show("Finished.");
}
catch(SoapException se)
{
       MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
       MessageBox.Show("EXCEPTION:" + ex.Message);
}

GetBenefitPlanRolloverSetting

This method is used to retrieve rollover configuration for a specific plan.

History

The GetBenefitPlanRolloverSetting methods are listed below:

• GetBenefitPlanRolloverSettingRequest

• GetBenefitPlanRolloverSettingResponse

GetBenefitPlanRolloverSetting request/response messages

The GetBenefitPlanRolloverSetting method requires the following request and response messages (input and output data.)

Response message:

Example of GetBenefitPlanRolloverSetting SOAP request message:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mbi="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers" xmlns:v1="http://bensoft.metavante.com/WebServices/Contracts/BenefitPlanRollover/2011/04/V1" xmlns:ns="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Request/2011/04/">
   <soapenv:Header>
      <mbiSessionHeader>
         <!--Optional:-->
         <mbi:MBISessionID>bvr4ivlfosuo1xvcckq24t4q</mbi:MBISessionID>
      </mbiSessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <v1:GetBenefitPlanRolloverSetting>
         <!--Optional:-->
         <v1:request xsi:type="ns987:GetBenefitPlanRolloverSettingRequest_2014_06" xmlns:ns987="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Request/2014/06/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ns:AcctTypeCde>FSL</ns:AcctTypeCde>
            <ns:EmprId>9HR2345</ns:EmprId>
            <ns:FundRolloverTypeCde>Primary</ns:FundRolloverTypeCde>
            <ns:PlanId>CAPSOURCE </ns:PlanId>
            <ns:PlanYrEndDte>20220707</ns:PlanYrEndDte>
            <ns:PlanYrStartDte>20220701</ns:PlanYrStartDte>
            <ns:TpaId>T02888</ns:TpaId>
         </v1:request>
      </v1:GetBenefitPlanRolloverSetting>
   </soapenv:Body>
</soapenv:Envelope>

Example of GetBenefitPlanRolloverSetting SOAP response message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="ed929667-813c-4439-818e-c0af5b8f5047" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
      <MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
         <MessageId>urn:uuid:ae4ca028-b00a-4c93-8113-a837f032a895</MessageId>
      </MBIMessageIdHeader>
   </s:Header>
   <s:Body>
      <GetBenefitPlanRolloverSettingResponse xmlns="http://bensoft.metavante.com/WebServices/Contracts/BenefitPlanRollover/2011/04/V1">
         <GetBenefitPlanRolloverSettingResult i:type="b:GetBenefitPlanRolloverSettingResponse_2014_06" xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Response/2011/04/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Response/2014/06/">
            <a:AcctTypeCde>FSL</a:AcctTypeCde>
            <a:EmprId>9HR2345</a:EmprId>
            <a:FundRolloverTypeCde>Primary</a:FundRolloverTypeCde>
            <a:IndividualBalanceMax>-1</a:IndividualBalanceMax>
            <a:IndividualRolloverAmt>-1.0000</a:IndividualRolloverAmt>
            <a:IndividualRolloverRate>-1.00</a:IndividualRolloverRate>
            <a:PlanId>CAPSOURCE</a:PlanId>
            <a:PlanYrEndDte>20220707</a:PlanYrEndDte>
            <a:PlanYrStartDte>20220701</a:PlanYrStartDte>
            <a:RolloverAmt>-1.0000</a:RolloverAmt>
            <a:RolloverBalanceMax>-1</a:RolloverBalanceMax>
            <a:RolloverDte>7/8/2022 12:00:00 AM</a:RolloverDte>
            <a:RolloverEligibilityDateType>TargetPlanStartDate</a:RolloverEligibilityDateType>
            <a:RolloverLastAutoDepositDateType>TargetPlanStartDate</a:RolloverLastAutoDepositDateType>
            <a:RolloverRate>-1.00</a:RolloverRate>
            <a:TargetAcctTypeCde>FSL</a:TargetAcctTypeCde>
            <a:TargetPlanId>CAPTRAGET</a:TargetPlanId>
            <a:TargetPlanKey>324</a:TargetPlanKey>
            <a:TargetPlanYrEndDte>20220731</a:TargetPlanYrEndDte>
            <a:TargetPlanYrStartDte>20220708</a:TargetPlanYrStartDte>
            <a:TpaId>T02888</a:TpaId>
            <b:MinimumRolloverAmountofFund>-1.0000</b:MinimumRolloverAmountofFund>
         </GetBenefitPlanRolloverSettingResult>
      </GetBenefitPlanRolloverSettingResponse>
   </s:Body>
</s:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when calling the GetBenefitPlanRolloverSetting web method.

try
{
            // Create the session SOAP header in order to pass the Service
            // the client’s current session id.
            mbiSessionHeader = new BenefitPlanRolloverServiceNameSpace.MBISessionHeader();
           // Create proxy object for the service
            proxy = new BenefitPlanRolloverServiceNameSpace.BenefitPlanRolloverService();
            // Create request message for method call (input parameters)
            request = new BenefitPlanRolloverServiceNameSpace.GetBenefitPlanRolloverSettingRequest_2014_06();
            // Set the input parameters
             request.AcctTypeCde = _AcctTypeCde.Text;
             request.EmprId = _EmprId.Text;
             request.PlanId = _PlanId.Text;
             if(_PlanYrEndDte.Text.Length > 0)
            {
            request.PlanYrEndDte = _PlanYrEndDte.Text;
            }
            if(_PlanYrStartDte.Text.Length > 0)
            {
                           request.PlanYrStartDte = _PlanYrStartDte.Text;
            }
            request.TpaId = _TpaId.Text;
                                                request.FundRolloverTypeCde = (FundRolloverMethods)_FundRolloverTypeCde.Text;
            // session ID returned from logon method
            mbiSessionHeader.MBISessionID = _sessionId.Text;
            proxy.MBISessionHeaderValue = mbiSessionHeader;
           // Call the method
            response = proxy.GetBenefitPlanRolloverSetting(request);
}
catch(SoapException se)
{
           MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
           MessageBox.Show("EXCEPTION:" + ex.Message);
}

GetBenefitPlanRolloverSettings

This method is used to retrieve rollover configuration for all plans under an employer.

History

The GetBenefitPlanRolloverSetting methods are listed below:

• GetBenefitPlanRolloverSettingsRequest

• GetBenefitPlanRolloverSettingsResponse

GetBenefitPlanRolloversSetting request/response messages

The GetBenefitPlanRolloverSettings method requires the following request and response messages (input and output data.)

Response message:

Example of GetBenefitPlanRolloverSettings SOAP request message:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mbi="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers" xmlns:v1="http://bensoft.metavante.com/WebServices/Contracts/BenefitPlanRollover/2011/04/V1" xmlns:ns="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Request/2011/04/">
   <soapenv:Header>
      <mbiSessionHeader>
         <!--Optional:-->
         <mbi:MBISessionID>bvr4ivlfosuo1xvcckq24t4q</mbi:MBISessionID>
      </mbiSessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <v1:GetBenefitPlanRolloverSettings>
         <!--Optional:-->
         <v1:request>
            <ns:EmprId>9HR2345</ns:EmprId>
            <ns:TpaId>T02888</ns:TpaId>
         </v1:request>
      </v1:GetBenefitPlanRolloverSettings>
   </soapenv:Body>
</soapenv:Envelope>

Example of GetBenefitPlanRolloverSettings SOAP response message

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <ActivityId CorrelationId="4cdd95de-6a07-418b-aadf-f55be05dd587" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">00000000-0000-0000-0000-000000000000</ActivityId>
      <MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
         <MessageId>urn:uuid:6373d0f2-7baf-4620-980f-7177460c5ab4</MessageId>
      </MBIMessageIdHeader>
   <s:Header>
   <s:Body>
      <GetBenefitPlanRolloverSettingsResponse xmlns="http://bensoft.metavante.com/WebServices/Contracts/BenefitPlanRollover/2011/04/V1">
         <GetBenefitPlanRolloverSettingsResult xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Plan/BenefitPlanRollover/Response/2011/04/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:GetBenefitPlanRolloverSettingsResponse>
               <a:AcctTypeCde>FB2</a:AcctTypeCde>
               <a:EmprId>9HR2345</a:EmprId>
               <a:FundRolloverTypeCde>Primary</a:FundRolloverTypeCde>
               <a:IndividualBalanceMax>-1</a:IndividualBalanceMax>
               <a:IndividualRolloverAmt>-1.0000</a:IndividualRolloverAmt>
               <a:IndividualRolloverRate>-1.00</a:IndividualRolloverRate>
               <a:PlanId>FSAP1</a:PlanId>
               <a:PlanYrEndDte>20230830</a:PlanYrEndDte>
               <a:PlanYrStartDte>20230801</a:PlanYrStartDte>
               <a:RolloverAmt>-1.0000</a:RolloverAmt>
               <a:RolloverBalanceMax>-1</a:RolloverBalanceMax>
               <a:RolloverDte>8/30/2023 12:00:00 AM</a:RolloverDte>
               <a:RolloverEligibilityDateType>TargetPlanStartDate</a:RolloverEligibilityDateType>
               <a:RolloverLastAutoDepositDateType>TargetPlanStartDate</a:RolloverLastAutoDepositDateType>
               <a:RolloverRate>-1.00</a:RolloverRate>
               <a:TargetAcctTypeCde>FBA</a:TargetAcctTypeCde>
               <a:TargetPlanId>FBAT</a:TargetPlanId>
               <a:TargetPlanKey>1865</a:TargetPlanKey>
               <a:TargetPlanYrEndDte>20230930</a:TargetPlanYrEndDte>
               <a:TargetPlanYrStartDte>20230830</a:TargetPlanYrStartDte>
               <a:TpaId>T02888</a:TpaId>
            </a:GetBenefitPlanRolloverSettingsResponse>
            <a:GetBenefitPlanRolloverSettingsResponse>
               <a:AcctTypeCde>FSL</a:AcctTypeCde>
               <a:EmprId>9HR2345</a:EmprId>
               <a:FundRolloverTypeCde>Primary</a:FundRolloverTypeCde>
               <a:IndividualBalanceMax>-1</a:IndividualBalanceMax>
               <a:IndividualRolloverAmt>-1.0000</a:IndividualRolloverAmt>
               <a:IndividualRolloverRate>-1.00</a:IndividualRolloverRate>
               <a:PlanId>CAPSOURCE</a:PlanId>
               <a:PlanYrEndDte>20220707</a:PlanYrEndDte>
               <a:PlanYrStartDte>20220701</a:PlanYrStartDte>
               <a:RolloverAmt>-1.0000</a:RolloverAmt>
               <a:RolloverBalanceMax>-1</a:RolloverBalanceMax>
               <a:RolloverDte>7/8/2022 12:00:00 AM</a:RolloverDte>
               <a:RolloverEligibilityDateType>TargetPlanStartDate</a:RolloverEligibilityDateType>
               <a:RolloverLastAutoDepositDateType>TargetPlanStartDate</a:RolloverLastAutoDepositDateType>
               <a:RolloverRate>-1.00</a:RolloverRate>
               <a:TargetAcctTypeCde>FSL</a:TargetAcctTypeCde>
               <a:TargetPlanId>CAPTRAGET</a:TargetPlanId>
               <a:TargetPlanKey>324</a:TargetPlanKey>
               <a:TargetPlanYrEndDte>20220731</a:TargetPlanYrEndDte>
               <a:TargetPlanYrStartDte>20220708</a:TargetPlanYrStartDte>
               <a:TpaId>T02888</a:TpaId>
            </a:GetBenefitPlanRolloverSettingsResponse>
            <a:GetBenefitPlanRolloverSettingsResponse>
               <a:AcctTypeCde>FSL</a:AcctTypeCde>
               <a:EmprId>9HR2345</a:EmprId>
               <a:FundRolloverTypeCde>Primary</a:FundRolloverTypeCde>
               <a:IndividualBalanceMax>-1</a:IndividualBalanceMax>
               <a:IndividualRolloverAmt>-1.0000</a:IndividualRolloverAmt>
               <a:IndividualRolloverRate>-1.00</a:IndividualRolloverRate>
               <a:PlanId>CAPSOURCE</a:PlanId>
               <a:PlanYrEndDte>20220707</a:PlanYrEndDte>
               <a:PlanYrStartDte>20220701</a:PlanYrStartDte>
               <a:RolloverAmt>-1.0000</a:RolloverAmt>
               <a:RolloverBalanceMax>-1</a:RolloverBalanceMax>
               <a:RolloverDte>7/8/2022 12:00:00 AM</a:RolloverDte>
               <a:RolloverEligibilityDateType>TargetPlanStartDate</a:RolloverEligibilityDateType>
               <a:RolloverLastAutoDepositDateType>TargetPlanStartDate</a:RolloverLastAutoDepositDateType>
               <a:RolloverRate>-1.00</a:RolloverRate>
               <a:TargetAcctTypeCde>FSL</a:TargetAcctTypeCde>
               <a:TargetPlanId>CAPTRAGET</a:TargetPlanId>
               <a:TargetPlanKey>324</a:TargetPlanKey>
               <a:TargetPlanYrEndDte>20220731</a:TargetPlanYrEndDte>
               <a:TargetPlanYrStartDte>20220708</a:TargetPlanYrStartDte>
               <a:TpaId>T02888</a:TpaId>
            </a:GetBenefitPlanRolloverSettingsResponse>
            <a:GetBenefitPlanRolloverSettingsResponse>
               <a:AcctTypeCde>FSL</a:AcctTypeCde>
               <a:EmprId>9HR2345</a:EmprId>
               <a:FundRolloverTypeCde>Primary</a:FundRolloverTypeCde>
               <a:IndividualBalanceMax>-1</a:IndividualBalanceMax>
               <a:IndividualRolloverAmt>-1.0000</a:IndividualRolloverAmt>
               <a:IndividualRolloverRate>-1.00</a:IndividualRolloverRate>
               <a:PlanId>CAPSOURCE</a:PlanId>
               <a:PlanYrEndDte>20220707</a:PlanYrEndDte>
               <a:PlanYrStartDte>20220701</a:PlanYrStartDte>
               <a:RolloverAmt>-1.0000</a:RolloverAmt>
               <a:RolloverBalanceMax>-1</a:RolloverBalanceMax>
               <a:RolloverDte>7/8/2022 12:00:00 AM</a:RolloverDte>
               <a:RolloverEligibilityDateType>TargetPlanStartDate</a:RolloverEligibilityDateType>
               <a:RolloverLastAutoDepositDateType>TargetPlanStartDate</a:RolloverLastAutoDepositDateType>
               <a:RolloverRate>-1.00</a:RolloverRate>
               <a:TargetAcctTypeCde>FSL</a:TargetAcctTypeCde>
               <a:TargetPlanId>CAPTRAGET</a:TargetPlanId>
               <a:TargetPlanKey>324</a:TargetPlanKey>
               <a:TargetPlanYrEndDte>20220731</a:TargetPlanYrEndDte>
               <a:TargetPlanYrStartDte>20220708</a:TargetPlanYrStartDte>
               <a:TpaId>T02888</a:TpaId>
            </a:GetBenefitPlanRolloverSettingsResponse>
            <a:GetBenefitPlanRolloverSettingsResponse>
               <a:AcctTypeCde>FSL</a:AcctTypeCde>
               <a:EmprId>9HR2345</a:EmprId>
               <a:FundRolloverTypeCde>Primary</a:FundRolloverTypeCde>
               <a:IndividualBalanceMax>-1</a:IndividualBalanceMax>
               <a:IndividualRolloverAmt>-1.0000</a:IndividualRolloverAmt>
               <a:IndividualRolloverRate>-1.00</a:IndividualRolloverRate>
               <a:PlanId>CAPSOURCE</a:PlanId>
               <a:PlanYrEndDte>20220707</a:PlanYrEndDte>
               <a:PlanYrStartDte>20220701</a:PlanYrStartDte>
               <a:RolloverAmt>-1.0000</a:RolloverAmt>
               <a:RolloverBalanceMax>-1</a:RolloverBalanceMax>
               <a:RolloverDte>7/8/2022 12:00:00 AM</a:RolloverDte>
               <a:RolloverEligibilityDateType>TargetPlanStartDate</a:RolloverEligibilityDateType>
               <a:RolloverLastAutoDepositDateType>TargetPlanStartDate</a:RolloverLastAutoDepositDateType>
               <a:RolloverRate>-1.00</a:RolloverRate>
               <a:TargetAcctTypeCde>FSL</a:TargetAcctTypeCde>
               <a:TargetPlanId>CAPTRAGET</a:TargetPlanId>
               <a:TargetPlanKey>324</a:TargetPlanKey>
               <a:TargetPlanYrEndDte>20220731</a:TargetPlanYrEndDte>
               <a:TargetPlanYrStartDte>20220708</a:TargetPlanYrStartDte>
               <a:TpaId>T02888</a:TpaId>
            </a:GetBenefitPlanRolloverSettingsResponse>
         </GetBenefitPlanRolloverSettingsResult>
      </GetBenefitPlanRolloverSettingsResponse>
   </s:Body>
</s:Envelope>

Example client code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when calling the GetBenefitPlanRolloverSettings web method.

try
{
     // Create proxy object for the service
     proxy = new WebServiceTestHarness.BenefitPlanRolloverServiceNameSpace.BenefitPlanRolloverService();
     // Create request message for method call (input parameters)
     request = new WebServiceTestHarness.BenefitPlanRolloverServiceNameSpace.GetBenefitPlanRolloverSettingsRequest_2014_06();
     // Create the session SOAP header in order to pass the Service
     // the client’s current session id.
     mbiSessionHeader = new WebServiceTestHarness.BenefitPlanRolloverServiceNameSpace.MBISessionHeader();
     mbiSessionHeader.MBISessionID = _sessionId;
     proxy.MBISessionHeaderValue = mbiSessionHeader;
     request.EmprId = _EmprId.Text;
     request.TpaId = _TpaId.Text;
     response = proxy.GetBenefitPlanRolloverSettings(request);
}
catch(SoapException se)
{
     MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
     MessageBox.Show("EXCEPTION:" + ex.Message);
}