Plan Design Rollover API | Administrative - SOAP

The PlanDesignRollover service provides clients plan rollover capabilities for rolling over plans to new plans and for rolling over an employee’s plan to a new plan.  

Service web methods
The following is a list of methods that is provided by the PlanDesignRollover service.
  • RolloverEmployeeForPlan - This method is used to rollover employee information to a new plan in WCA.
  • RolloverEmployeeForPlanDesign - This method is used to rollover employee information to a new plan in WCA.
  • RolloverPlan - This method is used to rollover plan information to a new plan.
  • RolloverPlanDesign - This method is used to rollover plan design information to a new plan.

Service assumptions/business rules
The PlanDesignRollover service makes the following assumptions as well as enforces the following 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.

RolloverEmployeeForPlan

This method is used to rollover employee information to a new plan in WCA.

History
The RolloverEmployeeForPlan methods are listed below:

Request messages
  • RolloverEmployeeForPlanRequest
Response messages
  • RolloverEmployeeForPlanResult

RolloverEmployeeForPlan request/response message
  • The RolloverEmployeeForPlan method requires the following request and response messages (input and output data.)
  • TpaIdstring
    A unique identifer for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
    First Available Version:RolloverEmployeeForPlanRequest
  • EmployerIdstringrequired
    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
    First Available Version:RolloverEmployeeForPlanRequest
  • SourcePlanIdstringrequired
    Plan ID of the source plan that the rollover is coming from.
    First Available Version:RolloverEmployeeForPlanRequest
  • SourcePlanAccountTypeCodestringrequired
    3 digit account type of the source plan that the rollover is coming from. Examples: FSA, DCA, etc.
    First Available Version:RolloverEmployeeForPlanRequest
  • SourcePlanYearStartDatedaterequired
    The source plan’s start date.  YYYYMMDD.
    First Available Version:RolloverEmployeeForPlanRequest
  • SourcePlanYearEndDatedaterequired
    The source plan’s end date.  YYYYMMDD.
    First Available Version:RolloverEmployeeForPlanRequest
  • DestinationPlanIdstringrequired
    Plan ID of the destination plan.
    First Available Version:RolloverEmployeeForPlanRequest
  • DestinationPlanAccountTypeCodestringrequired
    3 digit account type of the destination plan. Examples: FSA, DCA, etc.
    First Available Version:RolloverEmployeeForPlanRequest
  • DestinationPlanYearStartDatedaterequired
    The destination plan’s start date. 
    YYYYMMDD.
    First Available Version:RolloverEmployeeForPlanRequest
  • DestinationPlanYearEndDatedaterequired
    The destination plan’s end date. 
    YYYYMMDD.
    First Available Version:RolloverEmployeeForPlanRequest
  • EdiUserPasswordstringrequired
    The EDI user’s password.  
    First Available Version:RolloverEmployeeForPlanRequest

Response message: Empty message 

Example of RolloverEmployeeForPlan SOAP request message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
      <MBISessionID>string</MBISessionID>
    </MBISessionHeader>
  </soap:Header>
  <soap:Body>     <RolloverEmployee
xmlns="http://www.medibank.com/MBIWebServices/Plan/Messages/RolloverPlanDesign/Request/2004/06/">       <RolloverEmployeeForPlanRequest>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <SourcePlanId>string</SourcePlanId>
        <SourcePlanAccountTypeCode>string</SourcePlanAccountTypeCode>
        <SourcePlanYearStartDate>date</SourcePlanYearStartDate>
        <SourcePlanYearEndDate>date</SourcePlanYearEndDate>
        <DestinationPlanId>string</DestinationPlanId>
        <DestinationPlanAccountTypeCode>string</DestinationPlanAccountTypeCode>
        <DestinationPlanYearStartDate>date</DestinationPlanYearStartDate>
        <DestinationPlanYearEndDate>date</DestinationPlanYearEndDate>
        <EdiUserPassword>string</EdiUserPassword>
      </RolloverEmployeeForPlanRequest>
    </RolloverEmployee>
  </soap:Body>
</soap:Envelope>

Example of RolloverEmployeeForPlan SOAP response message

<xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
  <soap:Body>
    <RolloverEmployeeForPlanResponse
xmlns="http://www.medibank.com/MBIWebServices/RolloverPlanDesign/Messages/RolloverPlanDesign/Response/2004/06/">       <RolloverEmployeeForPlanResult />
    </RolloverEmployeeForPlanResponse>
  </soap:Body>
</soap: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 RolloverEmployeeForPlan web method.

try 
{
 // create new SOAP header for the user’s current session id localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
 // create the proxy object for the service  localhost.RolloverPlanDesignService proxy = new localhost.RolloverPlanDesignService();
     // create a new request object for the method’s parameters
  localhost.RolloverEmployeeForPlanRequest request = new localhost.RolloverEmployeeForPlanRequest ();     
// set the parameters for the web method call     request.EmployerId = "BCBOOOOOO";  request.SourcePlanId = "FSA2008";  request.SourcePlanAccountTypeCode = "FSA";  request.SourcePlanYearStartDate = “2008-01-01”;  request.SourcePlanYearEndDate = “2009-12-31”;  request.DestinationPlanId = “FSA2009”;  request.DestinationPlanAccountTypeCode = “FSA”;   request.DestinationPlanYearStartDate = “2009-01-01”;  request.DestinationPlanYearEndDate = “2009-12-31”;  request.EdiUserPassword = “password0”;          
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls.                 
 sh.MBISessionID = _sessionID;  proxy.MBISessionHeaderValue = sh;
// Call the web method.
            proxy.RolloverEmployee(request);    MessageBox.Show("Finished"); 
}
catch(SoapException se)
{
        // perform needed operations
}
catch(Exception ex)
{
        // perform needed operations
}

 

RolloverEmployeeForPlanDesign

This method is used to rollover employee information to a new plan in WCA.

History

The RolloverEmployeeForPlanDesign methods are listed below:

Request messages
  • RolloverEmployeeForPlanDesignRequest
Response messages
  • RolloverEmployeeForPlanDesignResponse

RolloverEmployeeForPlanDesign request/response messages

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

  • TpaIdstring
    A unique identifer for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • EmployerIdstringrequired
    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • SourcePlanDesignIdstringrequired
    Plan ID of the source plan that the rollover is coming from.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • SourcePlanDesignTypeCodestringrequired
    3 digit account type of the source plan that the rollover is coming from. Examples: FSA, DCA, etc.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • SourcePlanYearStartDatedaterequired
    The source plan’s start date.  YYYYMMDD.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • SourcePlanYearEndDatedaterequired
    The source plan’s end date.  YYYYMMDD.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • SourcePlanGracePeriodEndDateDaterequired
    The source plan’s grace period end date. 
    YYYYMMDD
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • DestinationPlanDesignIdstringrequired
    Plan ID of the destination plan.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • DestinationPlanDesignTypeCodestringrequired
    3 digit account type of the destination plan. Examples: FSA, DCA, etc.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • DestinationPlanYearStartDatedaterequired
    The destination plan’s start date. 
    YYYYMMDD.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • DestinationPlanYearEndDatedaterequired
    The destination plan’s end date. 
    YYYYMMDD.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • DestinationPlanGracePeriodEndDateDaterequired
    The destination plan’s grace period end date. 
    YYYYMMDD.
    First Available Version:RolloverEmployeeForPlanDesignRequest
  • EdiUserPasswordstringrequired
    The EDI user’s password.  
    First Available Version:RolloverEmployeeForPlanDesignRequest

Example of RolloverEmployeeForPlanDesign SOAP request message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
      <MBISessionID>string</MBISessionID>
    </MBISessionHeader>
  </soap:Header>
  <soap:Body>
    <RolloverEmployeeForPlanDesign
xmlns="http://www.medibank.com/MBIWebServices/Plan/Messages/RolloverPlanDesign/Request/2004/06/">       <RolloverEmployeeForPlanDesignRequest>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <SourcePlanDesignId>string</SourcePlanDesignId>
        <SourcePlanDesignTypeCode>string</SourcePlanDesignTypeCode>
        <SourcePlanYearStartDate>date</SourcePlanYearStartDate>
        <SourcePlanYearEndDate>date</SourcePlanYearEndDate>
        <SourcePlanGracePeriodEndDate>date</SourcePlanGracePeriodEndDate>
        <DestinationPlanDesignId>string</DestinationPlanDesignId>
        <DestinationPlanDesignTypeCode>string</DestinationPlanDesignTypeCode>
        <DestinationPlanYearStartDate>date</DestinationPlanYearStartDate>
        <DestinationPlanYearEndDate>date</DestinationPlanYearEndDate>
        <DestinationPlanGracePeriodEndDate>date</DestinationPlanGracePeriodEndDate>
        <EdiUserPassword>string</EdiUserPassword>
      </RolloverEmployeeForPlanDesignRequest>
    </RolloverEmployeeForPlanDesign>
  </soap:Body>
</soap:Envelope>

Example of RolloverEmployeeForPlanDesign SOAP response message:

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  </soap:Header>
  <soap:Body>
    <RolloverEmployeeForPlanDesignResponse
xmlns="http://www.medibank.com/MBIWebServices/RolloverPlanDesign/Messages/RolloverPlanDesign/Response/2004/06/">       <RolloverEmployeeForPlanDesignResult />
    </RolloverEmployeeForPlanDesignResponse>
  </soap:Body>
</soap: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 RolloverEmployeeForPlanDesign web method.

try 
{
 // create new SOAP header for the user’s current session id localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
       // create the proxy object for the service
  localhost.RolloverPlanDesignService proxy = new localhost.RolloverPlanDesignService();
            // create a new request object for the method’s parameters  localhost.RolloverEmployeeForPlanDesignRequest request = new localhost.RolloverEmployeeForPlanDesignRequest
();            
// set the parameters for the web method call                                 request.EmployerId = "BCBOOOOOO";              request.SourcePlanId = "FSA2008";       request.SourcePlanAccountTypeCode = "FSA";  request.SourcePlanYearStartDate = “2008-01-01”;  request.SourcePlanYearEndDate = “2009-12-31”;  request.SourcePlanGracePeriodEndDate = “2010-01-31”;  request.DestinationPlanId = “FSA2009”;  request.DestinationPlanAccountTypeCode = “FSA”;   request.DestinationPlanYearStartDate = “2009-01-01”;  request.DestinationPlanYearEndDate = “2009-12-31”;  request.DestinationPlanGracePeriodEndDate = “2009-12-31”;
       request.EdiUserPassword = “password0”;           
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls.               
 sh.MBISessionID = _sessionID;  proxy.MBISessionHeaderValue = sh; // Call the web method.
      proxy.RolloverEmployeeForPlanDesign(request); 
        MessageBox.Show("Finished"); 
}
catch(SoapException se)
{
        // perform needed operations
}
catch(Exception ex)
{
        // perform needed operations
}

RolloverPlan

This method is used to rollover plan information to a new plan.

History

The RolloverPlan methods are listed below:

Request messages
  • RolloverPlan_2009_04
  • RolloverPlan_2008_07
  • RolloverPlan
Response messages
  • RolloverPlanResponse

RolloverPlan request/response messages

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

  • TpaIdString
    A unique identifer for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
    First Available Version:RolloverPlanRequest
  • EmployerIdStringrequired
    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
    First Available Version:RolloverPlanRequest
  • SourcePlanIdStringrequired
    Plan ID of the source plan that the rollover is coming from.
    First Available Version:RolloverPlanRequest
  • SourcePlanAccountTypeCodeStringrequired
    3 digit account type of the source plan that the rollover is coming from. Examples: FSA, DCA, etc.
    First Available Version:RolloverPlanRequest
  • SourcePlanYearEndDateDaterequired
    The source plan’s end date.  YYYYMMDD.
    First Available Version:RolloverPlanRequest
  • PlanYearStartDateDaterequired
    Plan year start date. 
    YYYY-MMDD.
    First Available Version:RolloverPlanRequest
  • PlanYearEndDateDaterequired
    Plan year end date. 
    YYYY-MMDD.
    First Available Version:RolloverPlanRequest
  • GracePeriodEndDateDaterequired
    Grace period end date. 
    YYYYMM-DD.
    First Available Version:RolloverPlanRequest
  • PlanYearExtendedEndDateDaterequired
    Plan year extended end date. 
    YYYY-MM-DD.
    First Available Version:RolloverPlanRequest
  • SpendingLimitPeriodEnum
    None
    Month
    Year
    First Available Version:RolloverPlanRequest
  • SpendingDepositAmountDecimal
    Spending deposit amount.
    First Available Version:RolloverPlanRequest
  • SpendingTransactionAmountDecimal
    Spending transaction amount.
    First Available Version:RolloverPlanRequest
  • AllowPartialManualTransactionBoolean
    Turn on/off allow partial manual transactions. 
    True/False
    First Available Version:RolloverPlanRequest
    Default Values:FALSE
  • AutoDepositBypassBoolean
    Turn on/off auto deposit bypass. 
    True/False
    First Available Version:RolloverPlanRequest
    Default Values:FALSE
  • PayCycleTypeCodeEnum
    NoAutoDeposit
    Annual
    BiWeekly
    Monthly
    SmiMonthly
    Weekly
    Quarterly
    First Available Version:RolloverPlanRequest
  • ConvenienceFeePayorEnum
    None
    TPA
    Employer
    Employee
    First Available Version:RolloverPlanRequest
  • ConvenienceFeeAmountDecimal
    Enter the convenience fee amount.
    First Available Version:RolloverPlanRequest
  • MaxTransactionAmountDecimal
    The maximum transaction amount allowed.
    First Available Version:RolloverPlanRequest
  • MaxTotalAmountDecimal
    The maximum total amount allowed against the plan.  
    First Available Version:RolloverPlanRequest
  • DefaultPlanOptionsShort
    None = 0
    Plan = 1
    MTC = 2
    LifeEventBalanceManagement = 4
    EnableCoverageTiers = 8
    EnableSpecialDeposit = 16
    ServiceCategory = 32
    ManualClaimPercentCoverage = 64
    EnableDeductible = 128
    First Available Version:RolloverPlanRequest
    Default Values:0
  • HraTypeEnum
    None
    IndividualFamilyAmt
    SingleFundHra
    First Available Version:RolloverPlanRequest
  • MerchantExceptionsBoolean
    Allow merchant exceptions.
    True/False
    First Available Version:RolloverPlanRequest
    Default Values:FALSE
  • TPSSetupBoolean
    Is TPS setup?
    True/False
    First Available Version:RolloverPlanRequest
    Default Values:FALSE
  • CoPayAmountsBoolean
    Allow co-pay amounts.
    True/False
    First Available Version:RolloverPlanRequest
    Default Values:FALSE
  • TerminalExceptionsBoolean
    Allow terminal exceptions.
    True/False
    First Available Version:RolloverPlanRequest
    Default Values:FALSE
  • PlanDesignExceptionsBoolean
    Allow plan design exceptions.
    First Available Version:RolloverPlanRequest
    Default Values:FALSE
  • LifeEventSettingsBoolean
    Are life event settings turned on?
    True/False
    First Available Version:RolloverPlanRequest_ 2008_07
    Default Values:FALSE
  • ServiceCategoryCodeSettingsBoolean
    Turn on/off service category code settings.
    True/False
    First Available Version:RolloverPlanRequest_ 2009_04
    Default Values:FALSE
  • ManualClaimPercentCoverageSettingsBoolean
    Allow manual claim percent coverage settings.
    True/False
    First Available Version:RolloverPlanRequest_ 2008_07
    Default Values:FALSE

Response message: Empty message  

Example of RolloverPlan SOAP request message

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">   <soap:Header>
    <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
      <MBISessionID>string</MBISessionID>
    </MBISessionHeader>
  </soap:Header>
  <soap:Body>
    <RolloverPlan xmlns="http://www.medibank.com/MBIWebServices/Plan/Messages/RolloverPlanDesign/Request/2004/06/">       <RolloverPlanRequest>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <SourcePlanId>string</SourcePlanId>
        <SourcePlanAccountTypeCode>string</SourcePlanAccountTypeCode>
        <SourcePlanYearStartDate>date</SourcePlanYearStartDate>
        <SourcePlanYearEndDate>date</SourcePlanYearEndDate>
        <PlanYearStartDate>date</PlanYearStartDate>
        <PlanYearEndDate>date</PlanYearEndDate>
        <GracePeriodEndDate>date</GracePeriodEndDate>
        <PlanYearExtendedEndDate>date</PlanYearExtendedEndDate>
        <SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Month or Year</SpendingLimitPeriod>
        <SpendingDepositAmount>decimal</SpendingDepositAmount>
        <SpendingTransactionAmount>decimal</SpendingTransactionAmount>
        <AllowPartialManualTransaction>boolean</AllowPartialManualTransaction>
        <AutoDepositBypass>boolean</AutoDepositBypass>
        <PayCycleTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">NoAutoDeposit or Annual or BiWeekly or Monthly or SemiMonthly or Weekly or Quarterly</PayCycleTypeCode>
        <ConvenienceFeePayor xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Tpa or Employer or
Employee</ConvenienceFeePayor>
        <ConvenienceFeeAmount>decimal</ConvenienceFeeAmount>
        <MaxTransactionAmount>decimal</MaxTransactionAmount>
        <MaxTotalAmount>decimal</MaxTotalAmount>
        <DefaultPlanOptions xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Plan or MTC or
LifeEventBalanceManagement or EnableCoverageTiers or EnableSpecialDeposit or ServiceCategory or
ManualClaimPercentCoverage or EnableDeductible</DefaultPlanOptions>
        <HraType xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or IndividualFamilyAmt or SingleFundHra</HraType>
        <MerchantExceptions>boolean</MerchantExceptions>
        <TPSSetup>boolean</TPSSetup>
        <CoPayAmounts>boolean</CoPayAmounts>
        <TerminalExceptions>boolean</TerminalExceptions>
        <PlanDesignExceptions>boolean</PlanDesignExceptions>
      </RolloverPlanRequest>
    </RolloverPlan>
  </soap:Body>
</soap:Envelope>

Example of RolloverPlan SOAP response message

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  <soap:Header>
  <soap:Body>
    <RolloverPlanResponse
xmlns="http://www.medibank.com/MBIWebServices/RolloverPlanDesign/Messages/RolloverPlanDesign/Response/2004/06/">       <RolloverPlanResult />
    </RolloverPlanResponse>
  </soap:Body>
</soap: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 RolloverPlan web method.

try 
{
 // create new SOAP header for the user’s current session id localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
       // create the proxy object for the service
  localhost.RolloverPlanDesignService proxy = new localhost.RolloverPlanDesignService();
     // create a new request object for the method’s parameters
localhost.RolloverPlan_2009_04 request = new localhost.RolloverPlan_2009_04();        
// set the parameters for the web method call                                 request.EmployerId = "BCBOOOOOO";              request.SourcePlanId = "FSA2008";       request.SourcePlanAccountTypeCode = "FSA";  request.SourcePlanYearStartDate = “2008-01-01”;  request.SourcePlanYearEndDate = “2009-12-31”;  request.PlanYearStartDate = “2010-01-31”;  request.PlanYearEndDate = “FSA2009”;  request.GracePeriodEndDate = “2009-01-01”;
      request.PlanYearExtendedEndDate = “2009-12-31”;
// Add the session SOAP header so that the service knows who we are. // Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls.                
        sh.MBISessionID = _sessionID;
        proxy.MBISessionHeaderValue = sh;
// Call the web method.
            proxy.RolloverPlan(request);      MessageBox.Show("Finished"); 
}
catch(SoapException se)
{
        // perform needed operations
}
catch(Exception ex)
{
        // perform needed operations
}

 

RolloverPlanDesign

This method is used to rollover plan design information to a new plan in WCA.

History
The RolloverPlanDesign methods are listed below:

Request messages
  • RolloverPlanDesignRequest_2008_07
  • RolloverPlanDesignRequest
Response messages
  • RolloverPlanDesignResponse

RolloverPlanDesign request/response messages

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

 

  • AccountTypeCodeStringrequired
    FSA, DCA, etc.
    First Available Version:RolloverPlanDesignRequest
  • AutoDepositBypassBooleanrequired
    Bypass auto-deposit. 
    True/False
    First Available Version:RolloverPlanDesignRequest
    Default Values:FALSE
  • ConvenienceFeeAmountDecimal
    Convenience fee amount.
    First Available Version:RolloverPlanDesignRequest
  • ConvenienceFeePayorEnum
    None
    TPA
    Employer
    Employee
    First Available Version:RolloverPlanDesignRequest
  • DefaultPlanOptionsEnumrequired
    None = 0
    Plan = 1
    MTC = 2
    LifeEventBalanceManagement = 4
    EnableCoverageTiers = 8
    EnableSpecialDeposit = 16
    ServiceCategory = 32
    ManualClaimPercentCoverage = 64
    EnableDeductible = 128
    First Available Version:RolloverPlanDesignRequest
    Default Values:0
  • DesignTypeCodeStringrequired
    The design type code.
    First Available Version:RolloverPlanDesignRequest
  • AllowPartialManualTransactionBooleanrequired
    Allow partial manual transactions. 
    True/False
    First Available Version:RolloverPlanDesignRequest
    Default Values:FALSE
  • EmployerIdStringrequired
    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
    First Available Version:RolloverPlanDesignRequest
  • GracePeriodEndDateDaterequired
    Grace period end date on the plan. 
    YYYY-MM-DD
    First Available Version:RolloverPlanDesignRequest
  • PlanYearExtendedEndDateDaterequired
    Extended end date on the plan. 
    YYYY-MM-DD
    First Available Version:RolloverPlanDesignRequest
  • SpendingLimitPeriodEnum
    None
    Month
    Year
    First Available Version:RolloverPlanDesignRequest
  • SpendingLimitAtEnum
    PlanDesign
    BenefitPlan
    First Available Version:RolloverPlanDesignRequest
  • SpendingDepositAmountDecimal
    Spending deposit amount
    First Available Version:RolloverPlanDesignRequest
  • SpendingTransactionAmountDecimal
    Spending transaction amount
    First Available Version:RolloverPlanDesignRequest
  • BenefitPlanMaxTotalAmountDecimal
    The maximum amount for the plan.
    First Available Version:RolloverPlanDesignRequest
  • BenefitPlanMaxTransactionAmountDecimal
    The maximum transaction amount.
    First Available Version:RolloverPlanDesignRequest
  • AllowOnHoldBoolean
    True / False
    First Available Version:RolloverPlanDesignRequest
  • PayCycleTypeCodeEnum
    NoAutoDeposit
    Annual
    BiWeekly
    Monthly
    SemiMonthly
    Weekly
    Quarterly
    First Available Version:RolloverPlanDesignRequest
  • PlanDesignMaxTotalAmo untDecimal
    The plan design maximum amount
    First Available Version:RolloverPlanDesignRequest
  • PlanDesignMaxTransactionAmountDecimal
    The plan design maximum transaction amount.
    First Available Version:RolloverPlanDesignRequest
  • EndDateDaterequired
    Plan end date. 
    YYYY-MM-DD
    First Available Version:RolloverPlanDesignRequest
  • StartDateDaterequired
    Plan start date. 
    YYYY-MM-DD
    First Available Version:RolloverPlanDesignRequest
  • PlanDesignIdStringrequired
    Plan design id. 
    Unique identifier for the plan. 
    First Available Version:RolloverPlanDesignRequest
  • TierIdStringrequired
    Tier Id.  
    First Available Version:RolloverPlanDesignRequest
  • PlanIdStringrequired
    Plan id. 
    Unique identifier for the plan.
    First Available Version:RolloverPlanDesignRequest
  • RequiredDisbursementAmountDecimal
    Required disbursement.
    First Available Version:RolloverPlanDesignRequest
  • TierTypeEnumrequired
    NonSplit
    PercentageSplit
    DollarSplit
    First Available Version:RolloverPlanDesignRequest
  • TpaIdStringrequired
    A unique identifer for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
    First Available Version:RolloverPlanDesignRequest
  • HraTypeEnum
    None
    IndividualFamilyAmt
    SingleFundHra
    First Available Version:RolloverPlanDesignRequest
  • MerchantExceptionsBoolean
    Allow merchant exceptions.
    True/False
    First Available Version:RolloverPlanDesignRequest
    Default Values:FALSE
  • TPSSetupBoolean
    Is TPS setup?
    True/False
    First Available Version:RolloverPlanDesignRequest
    Default Values:FALSE
  • CoPayAmountsBoolean
    Allow co-pay amounts.
    True/False
    First Available Version:RolloverPlanDesignRequest
    Default Values:FALSE
  • TerminalExceptionsBoolean
    Allow terminal exceptions.
    True/False
    First Available Version:RolloverPlanDesignRequest
    Default Values:FALSE
  • PlanDesignExceptionsBoolean
    Allow plan design exceptions.
    True/False
    First Available Version:RolloverPlanDesignRequest
    Default Values:FALSE
  • SourceEndDateDaterequired
    The source plan’s end date.  YYYYMMDD.
    First Available Version:RolloverPlanDesignRequest
  • SourceStartDateDaterequired
    The source plan’s start date.  YYYYMMDD.
    First Available Version:RolloverPlanDesignRequest
  • SourceGracePeriodEndD ateDaterequired
    Source plan grace date. 
    YYYY-MMDD
    First Available Version:RolloverPlanDesignRequest
  • LifeEventSettingsBooleanrequired
    True / False
    First Available Version:RolloverPlanDesignRequest_2008_07
    Default Values:FALSE

Example of RolloverPlanDesign SOAP request message:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
      <MBISessionID>string</MBISessionID>
    </MBISessionHeader>
  </soap:Header>
  <soap:Body>
    <RolloverPlanDesignRequest_2008_07
xmlns="http://www.medibank.com/MBIWebServices/Plan/Messages/RolloverPlanDesign/Request/2008/07/">       <RolloverPlanDesignRequest>
        <AccountTypeCode>string</AccountTypeCode>
        <AutoDepositBypass>boolean</AutoDepositBypass>
        <ConvenienceFeeAmount>decimal</ConvenienceFeeAmount>
        <ConvenienceFeePayor xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Tpa or Employer or
Employee</ConvenienceFeePayor>
        <DefaultPlanOptions>short</DefaultPlanOptions>
        <DesignTypeCode>string</DesignTypeCode>
        <AllowPartialManualTransaction>boolean</AllowPartialManualTransaction>
        <EmployerId>string</EmployerId>
        <GracePeriodEndDate>date</GracePeriodEndDate>
        <PlanYearExtendedEndDate>date</PlanYearExtendedEndDate>
        <SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Month or
Year</SpendingLimitPeriod>
        <SpendingLimitAt xmlns="http://www.medibank.com/MBIWebServices/Enums/">PlanDesign or BenefitPlan</SpendingLimitAt>
        <SpendingDepositAmount>decimal</SpendingDepositAmount>
        <SpendingTransactionAmount>decimal</SpendingTransactionAmount>
        <BenefitPlanMaxTotalAmount>decimal</BenefitPlanMaxTotalAmount>
        <BenefitPlanMaxTransactionAmount>decimal</BenefitPlanMaxTransactionAmount>
        <AllowOnHold xmlns="http://www.medibank.com/MBIWebServices/Enums/">boolean</AllowOnHold>
        <PayCycleTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">NoAutoDeposit or Annual or BiWeekly or Monthly or SemiMonthly or Weekly or Quarterly</PayCycleTypeCode>         <PlanDesignMaxTotalAmount>decimal</PlanDesignMaxTotalAmount>
        <PlanDesignMaxTransactionAmount>decimal</PlanDesignMaxTransactionAmount>
        <EndDate>date</EndDate>
        <StartDate>date</StartDate>
        <PlanDesignId>string</PlanDesignId>
        <TierId>string</TierId>
        <PlanId>string</PlanId>
        <RequiredDisbursementAmount>decimal</RequiredDisbursementAmount>
        <TierType xmlns="http://www.medibank.com/MBIWebServices/Enums/">NonSplit or PercentageSplit or DollarSplit</TierType>
        <TpaId>string</TpaId>
        <HraType xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or IndividualFamilyAmt or
SingleFundHra</HraType>
        <MerchantExceptions>boolean</MerchantExceptions>
        <TPSSetup>boolean</TPSSetup>
        <CoPayAmounts>boolean</CoPayAmounts>
        <TerminalExceptions>boolean</TerminalExceptions>
        <PlanDesignExceptions>boolean</PlanDesignExceptions>
        <SourceEndDate>date</SourceEndDate>
        <SourceStartDate>date</SourceStartDate>
        <SourceGracePeriodEndDate>date</SourceGracePeriodEndDate>
        <LifeEventSettings>boolean</LifeEventSettings>
      </RolloverPlanDesignRequest>
    </RolloverPlanDesignRequest_2008_07>
  </soap:Body>

Example of RolloverPlanDesign SOAP response message

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
      <MessageId>string</MessageId>
    </MBIMessageIdHeader>   </soap:Header>   <soap:Body>
    <RolloverPlanDesignResponse
xmlns="http://www.medibank.com/MBIWebServices/RolloverPlanDesign/Messages/RolloverPlanDesign/Response/2004/06/">       <RolloverPlanDesignResult />
    </RolloverPlanDesignResponse>
  </soap:Body>
</soap: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 RolloverPlanDesign web method.

try 
{
 // create new SOAP header for the user’s current session id localhost.MBISessionHeader sh = new localhost.MBISessionHeader();
 // create the proxy object for the service  localhost.PlanDesignRolloverService proxy = new localhost.PlanDesignRolloverService();
     // create a new request object for the method’s parameters
localhost.RolloverPlanDesignRequest_2008_07 request = new localhost.RolloverPlanDesignRequest_2008_07();       
// set the parameters for the web method call     request.AccountTypeCode = "FSA";  request.AutoDepositBypass = true;  request.DefaultPlanOptions = 0;  request.DesignTypeCode = FSA11;  request.AllowPartialManualTransactions = true;  request.EmploerId = “MyEmployer”;  request.GracePeriodEndDate = “2009-01-01”;  request.PlanYearExtendedEndDate = “2009-12-31”;
            request.EndDate = “FSA2009”;  request.StartDate = “2010-01-31”;  request.PlanDesignId = “FSA1”;             request.TierId = “TIER1”;  request.PlanId = “FSA11”;          request.TierType = RolloverPlanDesignService.TierType.NonSplit;
            request.SourceEndDate = “2009-12-31”;  request.SourceStartDate = “2009-01-01”;  request.SourceGracePeriodEndDate = “2010-01-31”;
// Add the session SOAP header so that the service knows who we are.
// Note that we stored the session ID in a member variable after
// logged in to the system for future web method calls.                 
        sh.MBISessionID = _sessionID;
        proxy.MBISessionHeaderValue = sh;
// Call the web method.
       proxy.RolloverPlanDesignRequest(request); 
        MessageBox.Show("Finished"); 
}
catch(SoapException se)
{
        // perform needed operations
}
catch(Exception ex)
{
         // perform needed operations
}