Flex Account Rollover Settings API| Administrative - SOAP

This service provides users the ability to manage flex account rollover settings and functionality

Service web methods
The following operations are supported:

• AddFlexAccountRolloverSettings - This method is used to add the flex account rollover settings.
• GetFlexAccountRolloverSettings - This method is used to get fund rollover settings for flex accounts.
• UpdateFlexAccountRolloverSettings - This method is used to update any existing flex account rollover settings.

Service assumptions/business rules
The flex account rollover settings service makes the following assumptions and 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.

AddFlexAccountRolloverSettings

This method is used to add the flex account rollover settings.

History
The AddFlexAccountRolloverSettings methods are listed below:

Request messages:

• AddFlexAccountRolloverSettingsRequest

Response messages:

• AddFlexAccountRolloverSettingsResponse

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

The table below includes the following request messages:

• AddFlexAccountRolloverSettingsRequest

Response message: Empty message.

 

Example of AddFlexAccountRolloverSettings 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>
    <AddFlexAccountRolloverRequest
xmlns="http://www.medibank.com/MBIWebServices/Plan/Service/FlexAccountRollover/Request/2008/07/">       <request>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <SourcePlanId>string</SourcePlanId>
        <SourcePlanAccountTypeCode>string</SourcePlanAccountTypeCode>
        <SourcePlanYearStartDate>string</SourcePlanYearStartDate>
        <SourcePlanYearEndDate>string</SourcePlanYearEndDate>
        <FundRolloverDate>string</FundRolloverDate>
<FundRolloverType xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or AllFunds or Cap or Percentage or CapAndPercentage</FundRolloverType>
        <RolloverCapAmount>decimal</RolloverCapAmount>
        <RolloverRate>decimal</RolloverRate>
        <IndividualRolloverCapAmount>decimal</IndividualRolloverCapAmount>
        <IndividualRolloverRate>decimal</IndividualRolloverRate>
        <TargetAccountTypeCode>string</TargetAccountTypeCode>
        <TargetPlanId>string</TargetPlanId>
        <TargetPlanYearStartDate>string</TargetPlanYearStartDate>
        <TargetPlanYearEndDate>string</TargetPlanYearEndDate>
<EmployeeId>string</EmployeeId>
<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>
</request>
</AddFlexAccountRolloverRequest>
</soap:Body>
</soap:Envelope>

Example of AddFlexAccountRolloverSettings 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>
<AddFlexAccountRolloverResponse
xmlns="http://www.medibank.com/MBIWebServices/Plan/Service/FlexAccountRollover/Response/2008/07/">
<AddFlexAccountRolloverSettingsResult />
</AddFlexAccountRolloverResponse>
</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 AddFlexAccountRolloverSettings 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.FlexAccountRolloverSettinsService proxy = new localhost.FlexAccountRolloverSettinsService();
    // create a new request object for the method’s parameters
  localhost.AddFlexAccountRolloverSettings request = new localhost. AddFlexAccountRolloverSettings();
// set the parameters for the web method call
request.TpaId = "T00021";
request.EmployerId = “WWW888;
request.SourcePlanId = “FSA2008”;
request.SourcePlanAccountTypeCode = “FSA”;
request.SourcePlanYearStartDate = “20080101”;
request.SourcePlanYearEndDate = “20081231”;
request.FundRolloverDate = “20090301”;
request.FundRolloverType = FundRolloverType.AllFunds;
request.RolloverCapAmount = 3000.00d;
request.RolloverRate = 85.00d;
request.TargetAccountTypeCode = “FSA”;
request.TargetPlanId = “FSA2009”;
request.TargetPlanYearStartDate = “20090101”;
request.TargetPlanYearEndDate = “20091231”;
request.EmployeeId = “JaneD”;
// 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. AddFlexAccountRolloverSettings(request);
MessageBox.Show("Finished");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}

GetFlexAccountRolloverSettings

This method is used to get fund rollover settings for flex accounts.

History
The GetFlexAccountRolloverSettings methods are listed below:

Request messages:

• GetFlexAccountRolloverRequest

Response messages:

• GetFlexAccountRolloverResponse

GetFlexAccountRolloverSettings request/response messages

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

The table below includes the following request messages:

• GetFlexAccountRolloverRequest

The table below includes the following request messages:

• GetFlexAccountRolloverResponse

Example of GetFlexAccountRolloverSettings 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>
<GetFlexAccountRolloverRequest
xmlns="http://www.medibank.com/MBIWebServices/Plan/Service/FlexAccountRollover/Request/2008/07/">
<request>
<TpaId>string</TpaId>
<PlanId>string</PlanId>
<EmprId>string</EmprId>
<PlanYrStartDte>string</PlanYrStartDte>
<PlanYrEndDte>string</PlanYrEndDte>
<AcctTypeCde>string</AcctTypeCde>
</request>
</GetFlexAccountRolloverRequest>
</soap:Body>
</soap:Envelope>

Example of GetFlexAccountRolloverSettings 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>
<Response xmlns="http://www.medibank.com/MBIWebServices/Plan/Service/FlexAccountRollover/Response/2008/07/">
<GetFlexAccountRolloverSettingsResult>
<GetFlexAccountRolloverResponse>
<TpaId>string</TpaId>
<EmployerId>string</EmployerId>
<SourceAccountType>string</SourceAccountType>
<SourcePlanId>string</SourcePlanId>
<SourcePlanStartDate>string</SourcePlanStartDate>
<SourcePlanEndDate>string</SourcePlanEndDate>
<TargetAccountType>string</TargetAccountType>
<TargetPlanId>string</TargetPlanId>
<TargetPlanStartDate>string</TargetPlanStartDate>
<TargetPlanEndDate>string</TargetPlanEndDate>
<RolloverDate>string</RolloverDate>
<Rollover_x0020_Amount>decimal</Rollover_x0020_Amount>
<Rollover_x0020_Rate>decimal</Rollover_x0020_Rate>
<Individual_x0020_Rollover_x0020_Amount>decimal</Individual_x0020_Rollover_x0020_Amount>
<Individual_x0020_Rollover_x0020_Rate>decimal</Individual_x0020_Rollover_x0020_Rate>
<Fund_x0020_Rollover_x0020_Type>short</Fund_x0020_Rollover_x0020_Type>
<Employee_x0020_ID>string</Employee_x0020_ID>
</GetFlexAccountRolloverResponse>
<GetFlexAccountRolloverResponse>
<TpaId>string</TpaId>
<EmployerId>string</EmployerId>
<SourceAccountType>string</SourceAccountType>
<SourcePlanId>string</SourcePlanId>
<SourcePlanStartDate>string</SourcePlanStartDate>
<SourcePlanEndDate>string</SourcePlanEndDate>
<TargetAccountType>string</TargetAccountType>
<TargetPlanId>string</TargetPlanId>
<TargetPlanStartDate>string</TargetPlanStartDate>
<TargetPlanEndDate>string</TargetPlanEndDate>
<RolloverDate>string</RolloverDate>
<Rollover_x0020_Amount>decimal</Rollover_x0020_Amount>
<Rollover_x0020_Rate>decimal</Rollover_x0020_Rate>
<Individual_x0020_Rollover_x0020_Amount>decimal</Individual_x0020_Rollover_x0020_Amount>
<Individual_x0020_Rollover_x0020_Rate>decimal</Individual_x0020_Rollover_x0020_Rate>
<Fund_x0020_Rollover_x0020_Type>short</Fund_x0020_Rollover_x0020_Type>
<Employee_x0020_ID>string</Employee_x0020_ID>
</GetFlexAccountRolloverResponse>
</GetFlexAccountRolloverSettingsResult>
</Response>
</soap:Body>
</soap:Envelope>

Example client code

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

GetFlexAccountRolloverSettings method.

try
{
string str = "Nothing found.";
// 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.FlexAccountRolloverSettingsService proxy = new localhost.FlexAccountRolloverSettingsService();
// set the parameters for the web method call
request.TpaId = "T00209";
request.PlanId = “FSA2009”;
request.EmprId = “JCP0001”;
request.PlanYrStartDte = “20090101”;
request.PlanYrEndDte = “20091231”;
request.AcctTypeCde = “FSA”;
// 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.
// Note that the responses variable will have a null value
// if no record were found.
response = proxy.GetFlexAccountRolloverRequest(request);
if(response!=null)
{
// perform needed operations with data
}
else
{
MessageBox.Show(str);
}
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}

UpdateFlexAccountRolloverSettings

This method is used to update the fund rollover settings for Flex accounts.

History

The UpdateFlexAccountRolloverSettings methods are listed below:

Request messages:

• UpdateFlexAccountRolloverRequest

Response messages:

• UpdateFlexAccountRolloverResponse

Method request/response messages

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

The table below includes the following request messages:

• UpdateFlexAccountRolloverRequest

Response message: Empty response.

 

Example of UpdateFlexAccountRolloverSettings 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>
<UpdateFlexAccountRolloverRequest
xmlns="http://www.medibank.com/MBIWebServices/Plan/Service/FlexAccountRollover/Request/2008/07/">
<request>
<TpaId>string</TpaId>
<EmployerId>string</EmployerId>
<SourcePlanId>string</SourcePlanId>
<SourcePlanAccountTypeCode>string</SourcePlanAccountTypeCode>
<SourcePlanYearStartDate>string</SourcePlanYearStartDate>
<SourcePlanYearEndDate>string</SourcePlanYearEndDate>
<FundRolloverDate>string</FundRolloverDate>
<FundRolloverType xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or AllFunds or Cap or Percentage
or CapAndPercentage</FundRolloverType>
<RolloverCapAmount>decimal</RolloverCapAmount>
<RolloverRate>decimal</RolloverRate>
<IndividualRolloverCapAmount>decimal</IndividualRolloverCapAmount>
<IndividualRolloverRate>decimal</IndividualRolloverRate>
<TargetAccountTypeCode>string</TargetAccountTypeCode>
<TargetPlanId>string</TargetPlanId>
<TargetPlanYearStartDate>string</TargetPlanYearStartDate>
<TargetPlanYearEndDate>string</TargetPlanYearEndDate>
<EmployeeId>string</EmployeeId>
</request>
</UpdateFlexAccountRolloverRequest>
</soap:Body>
</soap:Envelope>

Example of UpdateFlexAccountRolloverSettings 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>
<UpdateFlexAccountRolloverResponse
xmlns="http://www.medibank.com/MBIWebServices/Plan/Service/FlexAccountRollover/Response/2008/07/">
<UpdateFlexAccountRolloverSettingsResult />
</UpdateFlexAccountRolloverResponse>
</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 UpdateFlexAccountRolloverSettings 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.FlexAccountRolloverSettinsService proxy = new localhost.FlexAccountRolloverSettinsService();
// create a new request object for the method’s parameters
localhost.UpdateFlexAccountRolloverSettings request = new localhost. UpdateFlexAccountRolloverSettings();
// set the parameters for the web method call
request.TpaId = "T00021";
request.EmployerId = “WWW888;
request.SourcePlanId = “FSA2008”;
request.SourcePlanAccountTypeCode = “FSA”;
request.SourcePlanYearStartDate = “20080101”;
request.SourcePlanYearEndDate = “20081231”;
request.FundRolloverDate = “20090301”;
request.FundRolloverType = FundRolloverType.AllFunds;
request.RolloverCapAmount = 3000.00d;
request.RolloverRate = 85.00d;
request.TargetAccountTypeCode = “FSA”;
request.TargetPlanId = “FSA2009”;
request.TargetPlanYearStartDate = “20090101”;
request.TargetPlanYearEndDate = “20091231”;
request.EmployeeId = “JaneD”;
// 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. AddFlexAccountRolloverSettings(request);
MessageBox.Show("Finished");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}