TPA Default Plan API | Administrative - SOAP

The administrator default plan service provides functionality for reading, adding, updating, and deleting default plans.

Service web methods

The following is a list of methods that are provided by the administrator default plan service.

DeleteDefaultPlan - used to delete administrator default Plan information.
UpdateDefaultBenefitPlan - used to update administrator default plan information.
AddDefaultBenefitPlan - used to add administrator default benefit plan information.
GetDefaultPlans - used to retrieve administrator default plans.
GetDefaultPlan - used to get administrator default plan information.
GetAccountTypeCodes - used to retrieve available account type codes.

Service assumptions/business rules

The DefaultPlan 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 the DefaultPlan Service. This facilitates better performance and accurate processing on both systems.
Clients shall not attempt to use the DefaultPlan 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.

DeleteDefaultPlan

This method is used to delete the default plan information.

History

The DeleteDefaultPlan methods are listed below:

Request message

DeleteDefaultPlanRequest

Response message

DeleteDefaultPlanResponse

DeleteDefaultPlan request/response messages

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

The table below includes the following request message:

DeleteDefaultPlanRequest

Request Body

TpaID String required

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

First Available Version: DeleteDefaultPlanRequest
AccountType Code String required

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, and so on).

First Available Version: DeleteDefaultPlanRequest

Response message: Empty message Example of a DeleteDefaultPlan SOAP request message:

<?xml version="1.0" encoding="utf8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"
    xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>qe4ahviw4xkhb045kipoid2b</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <DeleteDefaultPlanRequest xmlns="http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Request/2004/06/">
            <deleteDefaultPlanRequest>
                <Id>T00209</Id>
                <AccountTypeCode>ACO</AccountTypeCode>
            </deleteDefaultPlanRequest>
        </DeleteDefaultPlanRequest>
    </soap:Body>
</soap:Envelope>
Example of a DeleteDefaultPlan SOAP response message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />  </soap:Header>
        <soap:Body>
            <DeleteDefaultPlanResponse
                xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerLogicalBankAccount/Response/2004/06/"> < DeleteDefaultPlanResult/>
        </ DeleteDefaultPlanResponse >
    </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 deleting a default plan.

try
{
    // Create the session SOAP header in order to pass the Service
    // the client’s current session id.
    mbiSessionHeader = new DefaultPlanServiceNameSpace.MBISessionHeader();
    // Create proxy object for the service
    proxy = new DefaultPlanServiceNameSpace.DefaultPlanService();
    // Create request message for method call (input parameters)
    request = new DefaultPlanServiceNameSpace.DeleteDefaultPlanRequest();
    request.AccountTypeCode = _AccountTypeCode.Text;
    request.Id = _Id.Text;
    // session ID returned from login method
    mbiSessionHeader.MBISessionID = _sessionId.Text;
    proxy.MBISessionHeaderValue = mbiSessionHeader;
    // Call the method
    response = proxy.AddEmployerLogicalBankAccount(request);
    MessageBox.Show("Finished.");
}
catch(SoapException se)
{
    // perform needed operations
}

UpdateDefaultBenefitPlan

This method is used to update default benefit plan information.

History

The UpdateDefaultBenefitPlan methods are listed below:

Request message

UpdateDefaultBenefitPlan_2013_06
UpdateDefaultBenefitPlan_2008_07
UpdateDefaultBenefitPlan_2007_12
UpdateDefaultBenefitPlanRequest

Response message

UpdateDefaultBenefitPlan request/response messages

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

The table below includes the following request message:

UpdateDefaultBenefitPlan_2008_07
UpdateDefaultBenefitPlan_2007_12
UpdateDefaultBenefitPlanRequest

Request Body

AccountTypeCode String required

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc..)

First Available Version: UpdateDefaultBenefitPlanRequest
ConvenienceFeeAmount Decimal required

Convenience amount charged for each POS transaction Only used if employee is paying the fee

First Available Version: UpdateDefaultBenefitPlanRequest

ConvenienceFeePayor Enumeration required

Who will pay the convenience fee. Valid values are:
None
Administrator
Employer
Employee
Note: "none" indicates that no fee is applied

First Available Version:	UpdateDefaultBenefitPlanRequest
Default Values:	`None`

GracePeriodEndDate Date required

The grace period end date. After this date, a warning displays when transactions are applied to this account type.

First Available Version: UpdateDefaultBenefitPlanRequest
SpendingLimitPeriod Enumeration

Determines if this account type uses spending limits. Spending limits restricts the amount of money that can be deposited into or withdrawn from an account on a monthly or yearly basis.
None
Month
Year

First Available Version: UpdateDefaultBenefitPlanRequest
SpendingDepositAmount Decimal

Maximum amount to be deposited, during the spending Limit period.

First Available Version: UpdateDefaultBenefitPlanRequest
SpendingTransactionAmount Decimal

Maximum amount to be withdrawn, during the spending limit period.

First Available Version: UpdateDefaultBenefitPlanRequest

PayCycleTypeCode Enumeration required

Pay cycle type for auto deposits:
NoAutoDeposit
Annual
BiWeekly
Monthly
SemiMonthly
Weekly

First Available Version:	UpdateDefaultBenefitPlanRequest
Default Values:	`NoAutoDeposit`

MaxTransactionAmount Decimal required

Maximum amount per transaction

First Available Version: UpdateDefaultBenefitPlanRequest
MaxTotalAmount Decimal required

Maximum amount to be paid during the accounts date range.

First Available Version: UpdateDefaultBenefitPlanRequest
PlanYearStartDate Date required

Date the account type starts

First Available Version: UpdateDefaultBenefitPlanRequest
PlanYearEndDate Date required

Date the account type ends.

First Available Version: UpdateDefaultBenefitPlanRequest
PlanDesignId String

Plan design id. Some possible values: DCAP, EDUC, HLTH, etc..

First Available Version: UpdateDefaultBenefitPlanRequest
TpaID String

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

First Available Version: UpdateDefaultBenefitPlanRequest

IiasSettings Enumeration

Indicates if and how IIAS is used for this plan. Valid options are:
0 = IIAS disabled (Default)
1 = IIAS Enabled for HET
2 = IIAS and Specific healthcare amount
4= IIAS Walgreens
8 = IIAS SIGIS
By making this selection to enable IIAS, Iyou are agreeing to the terms and conditions of the IIAS terms of use.

First Available Version:

UpdateDefaultBenefitPlanRequest_2007_12

IiasOptions Enumerati on

If IIAS Enabled = 0, then send IIAS Options = 0
If IIAS Enabled = 1, then 0 indicates HET
If IIAS Enabled = 2, then send the following IIAS Options value of 1 = RX
Note: The IIAS Options field is used by the administrator when not using HET. Rx and OTC are the only supported options at this time.
The options are:
0 = No, Healthcare Specific(Default)
1 = Rx

First Available Version:

UpdateDefaultBenefitPlanRequest_2007_12

DefaultDepositCalendarId String

This is the calendar id of the auto-deposit calendar.

First Available Version:

UpdateDefaultBenefitPlanRequest_2008_07

HidePlanFromParticipant Boolean

This setting dictates whether an account on this plan will show to the participant in WCP/WCM or if it will be returned on Participant API responses
0 (false) - accounts on this plan will be shown in WCP/WCM and be returned on Participant API responses
1 (true) - accounts on this plan will not be shown in WCP/WCM and will not be returned on Participant API responses

First Available Version:	UpdateDefaultBenefitPlanRequest_2013_06
Default Values:	`FALSE`

Response Message: Empty Message

Example of an UpdateDefaultBenefitPlan SOAP request message:

<?xml version="1.0" encoding="utf8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">  <soap:Header>
    <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
        <MBISessionID>qe4ahviw4xkhb045kipoid2b</MBISessionID>   </MBISessionHeader>
    </soap:Header>  <soap:Body>
    <UpdateDefaultBenefitPlan xmlns= "http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Request/2004/06/" >    <updateDefaultBenefitPlanRequest>
    <AccountTypeCode>ACO</AccountTypeCode>
    <GracePeriodEndDate>2005-12-31</GracePeriodEndDate>
    <SpendingDepositAmount>0</SpendingDepositAmount>
    <SpendingTransactionAmount>0</SpendingTransactionAmount>
    <MaxTransactionAmount>0</MaxTransactionAmount>
    <MaxTotalAmount>0</MaxTotalAmount>
    <PlanYearStartDate>2005-01-01</PlanYearStartDate>
    <PlanYearEndDate>2005-12-31</PlanYearEndDate>
    < PayCycleTypeCode>Annual</ PayCycleTypeCode>
    <Id>T00209</Id>
</updateDefaultBenefitPlanRequest>
</UpdateDefaultBenefitPlan>
</soap:Body>
</soap:Envelope>

Example of an UpdateDefaultBenefitPlan SOAP response message:

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
    <UpdateDefaultBenefitPlanResponse
        xmlns="http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Response/2004/06/ ">
        <UpdateDefaultBenefitPlanResult/>
    </UpdateDefaultBenefitPlanResponse >
</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 updating a default plan design using the UpdateDefaultBenefitPlan web method.

try
{
    // Create the session SOAP header in order to pass the Service   // the client’s current session id.
    mbiSessionHeader = new DefaultPlanServiceNameSpace.MBISessionHeader();
    // Create proxy object for the service
    proxy = new DefaultPlanServiceNameSpace.DefaultPlanService();
    // Create the request object
    request = new DefaultPlanServiceNameSpace.UpdateDefaultBenefitPlanRequest();                                       request.AccountTypeCode = _AccountTypeCode.Text;
    request.ConvenienceFeeAmount = Convert.ToDecimal(_ConvenienceFeeAmount.Text); request.ConvenienceFeePayor =
        (DefaultPlanServiceNameSpace.ConvenienceFeePayor)Enum.Parse(typeof(DefaultPlanServiceNameSpace.ConvenienceFeeP ayor),_ConvenienceFeePayor.Text);
    if(_GracePeriodEndDate.Text.Length != 0)
    {
        request.GracePeriodEndDate = Convert.ToDateTime(_GracePeriodEndDate.Text);
    }
    request.MaxTotalAmount = Convert.ToDecimal(_MaxTotalAmount.Text);  request.MaxTransactionAmount = Convert.ToDecimal(_MaxTransactionAmount.Text); request.PayCycleTypeCode =
        (DefaultPlanServiceNameSpace.PayCycleType)Enum.Parse(typeof(DefaultPlanServiceNameSpace.PayCycleType),_PayCycleT ypeCode.Text);
    request.PlanYearEndDate = Convert.ToDateTime(_PlanYearEndDate.Text);  request.PlanYearStartDate = Convert.ToDateTime(_PlanYearStartDate.Text);  request.SpendingDepositAmount = Convert.ToDecimal(_SpendingDepositAmount.Text);  request.SpendingLimitPeriod =
        (DefaultPlanServiceNameSpace.IntervalType)Enum.Parse(typeof(DefaultPlanServiceNameSpace.IntervalType),_SpendingLimit
        Period.Text);
    request.SpendingTransactionAmount = Convert.ToDecimal(_SpendingTransactionAmount.Text);  request.Id = _Id.Text;
    mbiSessionHeader.MBISessionID = _sessionId;
    response = proxy.UpdateDefaultBenefitPlan(request);
    MessageBox.Show("Finished");
}
catch(SoapException se)
{
    MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
    MessageBox.Show("EXCEPTION:" + ex.Message);
}

AddDefaultBenefitPlan

This method is used to add a default benefit plan.

History

The AddDefaultBenefitPlan methods are listed below:

Request message

AddDefaultBenefitPlan_2013_06
AddDefaultBenefitPlan_2008_07
AddDefaultBenefitPlan_2007_12
AddDefaultBenefitPlanRequest

Response message

AddDefaultBenefitPlanResponse

AddDefaultBenefitPlan request/response messages

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

The table below includes the following request messages:

AddDefaultBenefitPlan_2008_07
AddDefaultBenefitPlan_2007_12
AddDefaultBenefitPlanRequest

Request Body

AccountTypeCode String required

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc…)

First Available Version: AddDefaultBenefitPlanRequest
ConvenienceFeeAmount Decimal required

Convenience amount charged for each POS transaction. Only used if the employee is paying the fee.

First Available Version: AddDefaultBenefitPlanRequest

ConvenienceFeePayor Enumeration required

Who will pay the convenience fee. Valid values are:
None
Administrator
Employer
Employee
Note: "none" indicates that no fee is applied

First Available Version:	AddDefaultBenefitPlanRequest
Default Values:	`None`

GracePeriodEndDate Date required

The grace period end date. After this date, a warning displays when transactions are applied to this account type.

First Available Version: AddDefaultBenefitPlanRequest

SpendingLimitPeriod Enumeration

Determines if this account type uses spending limits. Spending limits restricts the amount of money that can be deposited into or withdrawn from an account on a monthly or yearly basis.
None
Month
Year

First Available Version:	AddDefaultBenefitPlanRequest
Default Values:	`None`

SpendingDepositAmount Decimal

Maximum amount to be deposited, during the spending Limit period.

First Available Version: AddDefaultBenefitPlanRequest
SpendingTransactionAmount Decimal

Maximum amount to be withdrawn, during the spending limit period.

First Available Version: AddDefaultBenefitPlanRequest

PayCycleTypeCode Enumeration required

Pay cycle type for auto deposits:
NoAutoDeposit
Annual
BiWeekly
Monthly
SemiMonthly
Weekly

First Available Version:	AddDefaultBenefitPlanRequest
Default Values:	`NoAutoDeposit`

MaxTransactionAmount Decimal required

Maximum amount per transaction

First Available Version: AddDefaultBenefitPlanRequest
MaxTotalAmount Decimal required

Maximum amount to be paid during the accounts date range.

First Available Version: AddDefaultBenefitPlanRequest
PlanYearStartDate Date required

Date the account type starts

First Available Version: AddDefaultBenefitPlanRequest
PlanYearEndDate Date required

Date the account type ends.

First Available Version: AddDefaultBenefitPlanRequest
TpaID String required

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

First Available Version: AddDefaultBenefitPlanRequest
IiasSettings Enumeration

Indicates if and how IIAS is used for this plan. Valid options are:
0 = IIAS disabled (Default)
1 = IIAS Enabled for HET
2 = IIAS and Specific healthcare amount
4= IIAS Walgreens
8 = IIAS SIGIS
By making this selection to enable IIAS, Iyou are agreeing to the terms and conditions of the IIAS terms of use.

First Available Version: AddDefaultBenefitPlanRequest_2007_12
IiasOptions Enumeration

If IIAS Enabled = 0, then send IIAS Options = 0
If IIAS Enabled = 1, then 0 indicates HET
If IIAS Enabled = 2, then send the following IIAS Options value of 1 = RX
Note: The IIAS Options field is used by the administrator when not using HET. Rx and OTC are the only supported options at this time.
The options are:
0 = No, Healthcare Specific(Default)
1 = Rx

First Available Version: AddDefaultBenefitPlanRequest_2007_12
DefaultDepositCalendarId String

This is the calendar id of the autodeposit calendar.

First Available Version: AddDefaultBenefitPlanRequest_2008_07

HidePlanFromParticipant Enumeration

First Available Version:	AddDefaultBenefitPlanRequest_2013_06
Default Values:	`FALSE`

Response message: Empty message Example of an AddDefaultBenefitPlan SOAP request message:

<?xml version="1.0" encoding="utf8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">  <soap:Header>
    <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
        <MBISessionID>qe4ahviw4xkhb045kipoid2b</MBISessionID>   </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <AddDefaultBenefitPlanRequest xmlns="http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Request/2004/06/">
            <addDefaultBenefitPlanRequest>
                <AccountTypeCode>ACO</AccountTypeCode>
                <ConvenienceFeeAmount>0</ConvenienceFeeAmount>
                <GracePeriodEndDate>2005-12-31</GracePeriodEndDate>
                <SpendingDepositAmount>0</SpendingDepositAmount>
                <SpendingTransactionAmount>0</SpendingTransactionAmount>
                <MaxTransactionAmount>0</MaxTransactionAmount>
                <MaxTotalAmount>0</MaxTotalAmount>
                <PlanYearStartDate>2005-01-01</PlanYearStartDate>
                <PlanYearEndDate>2005-12-31</PlanYearEndDate>
                <PayCycleTypeCode>Annual</ PayCycleTypeCode>
                <Id>T00209</Id>
            </addDefaultBenefitPlanRequest>
        </AddDefaultBenefitPlanRequest>
    </soap:Body>
</soap:Envelope>

Example of an AddDefaultBenefitPlan SOAP response message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
    </soap:Header>
    <soap:Body>
        <AddDefaultBenefitPlanResponse
            xmlns="http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Response/2004/06/ "> < AddDefaultBenefitPlanResult/>
    </ AddDefaultBenefitPlanResponse >
</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 adding a default benefit plan using the AddDefaultBenefitPlan web method.

try
{
    // Create the session SOAP header in order to pass the Service   // the client’s current session id.
    mbiSessionHeader = new DefaultPlanServiceNameSpace.MBISessionHeader();
    // Create proxy object for the service
    proxy = new DefaultPlanServiceNameSpace.DefaultPlanService();
    // Create the request object
    request = new DefaultPlanServiceNameSpace.AddDefaultBenefitPlanRequest();
    request.AccountTypeCode = _AccountTypeCode.Text;  request.ConvenienceFeeAmount = Convert.ToDecimal(_ConvenienceFeeAmount.Text); request.ConvenienceFeePayor =
        (DefaultPlanServiceNameSpace.ConvenienceFeePayor)Enum.Parse(typeof(DefaultPlanServiceNameSpace.ConvenienceFeeP ayor),_ConvenienceFeePayor.Text);
    if(_GracePeriodEndDate.Text.Length != 0)
    {
        request.GracePeriodEndDate = Convert.ToDateTime(_GracePeriodEndDate.Text);
    }
    request.MaxTotalAmount = Convert.ToDecimal(_MaxTotalAmount.Text);  request.MaxTransactionAmount = Convert.ToDecimal(_MaxTransactionAmount.Text); request.PayCycleTypeCode =
        (DefaultPlanServiceNameSpace.PayCycleType)Enum.Parse(typeof(DefaultPlanServiceNameSpace.PayCycleType),_PayCycleT ypeCode.Text);
    request.PlanYearEndDate = Convert.ToDateTime(_PlanYearEndDate.Text);  request.PlanYearStartDate = Convert.ToDateTime(_PlanYearStartDate.Text);  request.SpendingDepositAmount = Convert.ToDecimal(_SpendingDepositAmount.Text); request.SpendingLimitPeriod =
        (DefaultPlanServiceNameSpace.IntervalType)Enum.Parse(typeof(DefaultPlanServiceNameSpace.IntervalType),_SpendingLimit Period.Text); request.SpendingTransactionAmount = Convert.ToDecimal(_SpendingTransactionAmount.Text);  request.Id = _Id.Text;
    mbiSessionHeader.MBISessionID = _sessionId;
    response = proxy.AddDefaultBenefitPlan(request);
    MessageBox.Show("Finished");
}
catch(SoapException se)
{
    MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
    MessageBox.Show("EXCEPTION:" + ex.Message);
}

GetDefaultPlans

This method is used to return information about the administrator’s default plans.

History

The GetDefaultPlans methods are listed below:

Request message

GetDefaultPlansRequest_2007_12
GetDefaultPlansRequest

Response message

GetDefaultPlansResponse_2008_07
GetDefaultPlansResponse_2007_12
GetDefaultPlansResponse

GetDefaultPlans request/response messages

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

The table below includes the following request messages:

GetDefaultPlans_2007_12
GetDefaultPlansRequest

Request Body

TpaId String required

Unique identifier assigned to each administrator.

First Available Version: GetDefaultPlansRequest

VerboseMode Boolean required

Optional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.

First Available Version:	GetDefaultPlansRequest
Default Values:	`FALSE`

QueryIias Boolean

To see IIAS-specific settings on the plan, set this to True.

First Available Version:	GetDefaultPlansRequest_2007_12
Default Values:	`FALSE`

The table below includes the following response messages:

GetDefaultPlans_2008_07
GetDefaultPlansResponse_2007_12
GetDefaultPlansResponse

Response Body

AccountTypeCode String

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc…)

First Available Version: GetDefaultPlansResponse
ConvenienceFeeAmount Decimal

Convenience amount charged for each POS transaction. Only used if employee is paying the fee.

First Available Version: GetDefaultPlansResponse
ConvenienceFeePayor Enumeration

Who will pay the convenience fee. Valid values are:
None
Administrator
Employer
Employee
Note: "none" indicates that no fee is applied

First Available Version: GetDefaultPlansResponse
SpendingLimitPeriod Enumeration

Determines if this account type uses spending limits. Spending limits restricts the amount of money that can be deposited into or withdrawn from an account on a monthly or yearly basis.
None
Month
Year

First Available Version: GetDefaultPlansResponse
SpendingDepositAmount Decimal

Maximum amount to be deposited, during the spending Limit period.

First Available Version: GetDefaultPlansResponse
SpendingTransactionAmount Decimal

Maximum amount to be withdrawn, during the spending limit period.

First Available Version: GetDefaultPlansResponse
PayCycleTypeCode Enumeration

Pay cycle type for auto deposits:
NoAutoDeposit
Annual
BiWeekly
Monthly
SemiMonthly
Weekly

First Available Version: GetDefaultPlansResponse
MaxTransactionAmount Decimal

Maximum amount per transaction

First Available Version: GetDefaultPlansResponse
MaxTotalAmount Decimal

Maximum amount to be paid during the accounts date range.

First Available Version: GetDefaultPlansResponse
TpaId String

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

First Available Version: GetDefaultPlansResponse
IiasSettings Enumeration

Indicates if and how IIAS is used for this plan. Valid options are:
0 = IIAS disabled (Default)
1 = IIAS Enabled for HET
2 = IIAS and Specific healthcare amount
4= IIAS Walgreens
8 = IIAS SIGIS
By making this selection to enable IIAS, Iyou are agreeing to the terms and conditions of the IIAS terms of use.

First Available Version: GetDefaultPlansResponse_2007_12
IiasOptions Enumeration

If IIAS Enabled = 0, then send IIAS Options = 0
If IIAS Enabled = 1, then 0 indicates HET
If IIAS Enabled = 2, then send the following IIAS Options value of 1 = RX
Note: The IIAS Options field is used by the administrator when not using HET. Rx and OTC are the only supported options at this time.
The options are:
0 = No, Healthcare Specific(Default)
1 = Rx

First Available Version: GetDefaultPlansResponse_2007_12
DefaultDepositCalendarId String

This is the calendar id of the auto-deposit calendar.

First Available Version: GetDefaultPlansResponse_2008_07
HidePlanFromParticipant Boolean

This setting dictates whether an account on this plan will show to the participant in WCP/WCM or if it will be returned on Participant API responses
0 (false) - accounts on this plan will be shown in WCP/WCM and be returned on Participant API responses
1 (true) - accounts on this plan will not be shown in WCP/WCM and will not be returned on Participant API responses

First Available Version: GetDefaultPlansResponse_2013_06

Example of a GetDefaultPlans SOAP request message:

<?xml version="1.0" encoding="utf8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>qe4ahviw4xkhb045kipoid2b</MBISessionID>   </MBISessionHeader>
        </soap:Header>
        <soap:Body>
            <GetDefaultPlansRequest xmlns="http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Request/2004/06/">
                <getDefaultPlansRequest>
                    <Id>T00209</Id>
                </getDefaultPlansRequest>
            </GetDefaultPlansRequest>
        </soap:Body>
    </soap:Envelope>

Example of a GetDefaultPlans SOAP response message:

<?xml version="1.0" encoding="utf8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">  <soap:Header>
    <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
        <MessageId>da19522eaf6f4ffabdf90f3742e2c7db</MessageId>
    </MBIMessageIdHeader>
</soap:Header> <soap:Body>
<GetDefaultPlansResponse xmlns="http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Response/2004/06/">
    <GetDefaultPlansResult>
        <GetDefaultPlansResponse>
            <AccountTypeCode>DCAP</AccountTypeCode>
            <ConvenienceFeeAmount>0</ConvenienceFeeAmount>
            <SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">Month</SpendingLimitPeriod>
            <SpendingDepositAmount>400.0000</SpendingDepositAmount>
            <SpendingTransactionAmount>20.0000</SpendingTransactionAmount>
            <MaxTransactionAmount>5000.0000</MaxTransactionAmount>
            <MaxTotalAmount>1.0000</MaxTotalAmount>
            <Id>T00209</Id>
        </GetDefaultPlansResponse>
    </GetDefaultPlansResult>
</GetDefaultPlansResponse>
</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 retrieving information about the default plan's using the GetDefaultPlans web method.

try
{
    // Create the session SOAP header in order to pass the Service   // the client’s current session id.
    mbiSessionHeader = new DefaultPlanServiceNameSpace.MBISessionHeader();
    // Create proxy object for the service
    proxy = new DefaultPlanServiceNameSpace.DefaultPlanService();
    // Create the request object
    request = new DefaultPlanServiceNameSpace.GetDefaultPlansRequest();                                       request.Id = _Id.Text;
    mbiSessionHeader.MBISessionID = _sessionId;  proxy.MBISessionHeaderValue = mbiSessionHeader;
    response = proxy.GetDefaultPlans(request);
}
catch(SoapException se)
{
    MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
    MessageBox.Show("EXCEPTION:" + ex.Message);
}

GetDefaultPlan

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

The table below includes the following request message:

GetDefaultPlan_2007_12
GetDefaultPlanRequest

Request Body

TpaId String required

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

First Available Version: GetDefaultPlanRequest

AccountTypeCode String required

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc…)

First Available Version:	GetDefaultPlanRequest
Default Values:	`“ ”`

VerboseMode Boolean

Optional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.

First Available Version:	GetDefaultPlanRequest
Default Values:	`FALSE`

QueryIias Boolean

To see IIAS specific settings on the plan, set this to true.

First Available Version:	GetDefaultPlanRequest_2007_12
Default Values:	`FALSE`

The table below includes the following response message:

GetDefaultPlanResponse_2008_07
GetDefaultPlanResponse_2007_12
GetDefaultPlanResponse

Response Body

AccountTypeCode String

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc…)

First Available Version: GetDefaultPlanResponse
ConvenienceFeeAmount Decimal

Convenience amount charged for each POS transaction. Only used if employee is paying the fee.

First Available Version: GetDefaultPlanResponse
ConveneinceFeePayor Enumeration

Who will pay the convenience fee. Valid values are:
None
Administrator
Employer
Employee
Note: "none" indicates that no fee is applied

First Available Version: GetDefaultPlanResponse
GracePeriodEndDate String

The grace period end date. After this date, a warning displays when transactions are applied to this account type.

First Available Version: GetDefaultPlanResponse
SpendingLimitPeriod Enumeratio n

Determines if this account type uses spending limits. Spending limits restrict the amount of money that can be deposited into or withdrawn from an account on a monthly or yearly basis.
None
Month
Year

First Available Version: GetDefaultPlanResponse
SpendingDepositAmount Decimal

Maximum amount to be deposited, during the spending limit period.

First Available Version: GetDefaultPlanResponse
SpendingTransactionAmount Decimal

Maximum amount to be withdrawn, during the spending limit period.

First Available Version: GetDefaultPlanResponse
PayCycleTypeCode Enumeratiion

Pay cycle type for auto deposits:
NoAutoDeposit
Annual
BiWeekly
Monthly
SemiMonthly
Weekly

First Available Version: GetDefaultPlanResponse
MaxTransactionAmount Decimal

Maximum amount per transaction.

First Available Version: GetDefaultPlanResponse
MaxTotalAmount Decimal

Maximum amount to be paid during the accounts date range.

First Available Version: GetDefaultPlanResponse
PlanYearStartDate String

Date the account type starts.

First Available Version: GetDefaultPlanResponse
PlanYearEndDate String

Date the account type ends.

First Available Version: GetDefaultPlanResponse
TpaId String

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

First Available Version: GetDefaultPlanResponse
IiasSettings Enumeration

Indicates if and how IIAS is used for this plan. Valid options are:
0 = IIAS disabled (Default)
1 = IIAS Enabled for HET
2 = IIAS and Specific healthcare amount
4= IIAS Walgreens
8 = IIAS SIGIS
By making this selection to enable IIAS, Iyou are agreeing to the terms and conditions of the IIAS terms of use.

First Available Version: GetDefaultPlanResponse
IiasOptions Enumeration

If IIAS Enabled = 0, then send IIAS Options = 0
If IIAS Enabled = 1, then 0 indicates HET
If IIAS Enabled = 2, then send the following IIAS Options value of 1 = RX
Note: The IIAS Options field is used by the administrator when not using HET. Rx and OTC are the only supported options at this time.
The options are:
0 = No, Healthcare Specific(Default)
1 = Rx

First Available Version: GetDefaultPlanResponse
DefaultDepositCalendarId String

This is the calendar id of the auto-deposit calendar.

First Available Version: GetDefaultPlanResponse_2008_07
HidePlanFromParticipant Boolean

This setting dictates whether an account on this plan will show to the participant in WCP/WCM or if it will be returned on Participant API responses
0 (false) - accounts on this plan will be shown in WCP/WCM and be returned on Participant API responses
1 (true) - accounts on this plan will not be shown in WCP/WCM and will not be returned on Participant API responses

First Available Version: GetDefaultPlanResponse_2013_06

Example of a GetDefaultPlan SOAP request message:

<?xml version="1.0" encoding="utf8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Header>
    <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
        <MBISessionID>qe4ahviw4xkhb045kipoid2b</MBISessionID>
    </MBISessionHeader>
</soap:Header> <soap:Body>
<GetDefaultPlanRequest xmlns="http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Request/2004/06/">
    <getDefaultPlanRequest>
        <Id>T00209</Id>
        <AccountTypeCode>ACO</AccountTypeCode>
    </getDefaultPlanRequest>
</GetDefaultPlanRequest>
</soap:Body>
</soap:Envelope>

Example of a GetDefaultPlan SOAP response message

<?xml version="1.0" encoding="utf8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Header>
    <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
        <MessageId>26237082be024d7ab34d32624429c7fb</MessageId>
    </MBIMessageIdHeader>
</soap:Header>
<soap:Body>
    <GetDefaultPlanResponse xmlns="http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Response/2004/06/">   <GetDefaultPlanResult>
    <AccountTypeCode>DCAP</AccountTypeCode>
    <ConvenienceFeeAmount>0</ConvenienceFeeAmount>
    <GracePeriodEndDate>2005-10-29</GracePeriodEndDate>
    <SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">Month</SpendingLimitPeriod>   <SpendingDepositAmount>400.0000</SpendingDepositAmount>
    <SpendingTransactionAmount>20.0000</SpendingTransactionAmount>
    <MaxTransactionAmount>5000.0000</MaxTransactionAmount>
    <MaxTotalAmount>1.0000</MaxTotalAmount>
    <PlanYearStartDate>2004-10-25</PlanYearStartDate>
    <PlanYearEndDate>2005-10-25</PlanYearEndDate>
    <Id>T00209</Id>
</GetDefaultPlanResult>
</GetDefaultPlanResponse>
</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 retrieving a default plan using the GetDefaultPlan web method.

try
{
    // Create the session SOAP header in order to pass the Service   // the client’s current session id.
    mbiSessionHeader = new DefaultPlanServiceNameSpace.MBISessionHeader();
    // Create proxy object for the service
    proxy = new DefaultPlanServiceNameSpace.DefaultPlanService();
    // Create the request object
    request = new DefaultPlanServiceNameSpace.GetDefaultPlanRequest();                                               request.Id = _Id.Text;     request.AccountTypeCode = _AccountTypeCode.Text;
    mbiSessionHeader.MBISessionID = _sessionId;
    proxy.MBISessionHeaderValue = mbiSessionHeader;
    response = proxy.GetDefaultPlan(request);
}
catch(SoapException se)
{
    MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
    MessageBox.Show("EXCEPTION:" + ex.Message);
}

GetAccountTypeCodes

This method is used to retrieve available account type codes.

History

The GetAccountTypeCodes methods are listed below:

Request message

GetAccountTypeCodesRequest

Response message

GetAccountTypeCodesResponse

GetAccountTypeCodes request/response messages

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

The table below includes the following request message:

GetAccountTypeCodesRequest

Request Body

GetAccountTypeCodesRequest TpaId

A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

First Available Version: Y
GetAccountTypeCodesRequest TypeCode

Account Type code:
BenefitPlan
PlanDesign

First Available Version: Y

The table below includes the following response message:

GetAccountTypeCodesResponse

Response Body

AccountTypeCode String

Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc…)

First Available Version: GetAccountTypeCodesResponse

Example of a GetAccountTypeCode SOAP request message:

<?xml version="1.0" encoding="utf8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Header>
    <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
        <MBISessionID>nj1jnh55me0skhj2gzcgja55</MBISessionID>
    </MBISessionHeader>
</soap:Header> <soap:Body>
<GetAccountTypeCodes xmlns="http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Request/2004/06/">    <getAccountTypeCodesRequest>
<Id>T00209</Id>
<TypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">PlanDesign</TypeCode>  </getAccountTypeCodesRequest>
</GetAccountTypeCodes>
</soap:Body>
</soap:Envelope>

Example of a GetAccountTypeCode SOAP response message:

<?xml version="1.0" encoding="utf8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Header>
    <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
        <MessageId>7e8256265a484cc7acc67c99f6a39c62</MessageId>
    </MBIMessageIdHeader>
</soap:Header>
<soap:Body>
    <GetAccountTypeCodes xmlns="http://www.medibank.com/MBIWebServices//Messages/DefaultPlan/Response/2004/06/"> <GetAccountTypeCodesResult>
    <GetAccountTypeCodesResponse>
        <AccountTypeCode>EDUC</AccountTypeCode>
    </GetAccountTypeCodesResponse>
    <GetAccountTypeCodesResponse>
        <AccountTypeCode>PRKG</AccountTypeCode>
    </GetAccountTypeCodesResponse>
    <GetAccountTypeCodesResponse>
        <AccountTypeCode>TRAN</AccountTypeCode>
    </GetAccountTypeCodesResponse>
    <GetAccountTypeCodesResponse>
        <AccountTypeCode>RXOY</AccountTypeCode>
    </GetAccountTypeCodesResponse>
    <GetAccountTypeCodesResponse>
        <AccountTypeCode>PREM</AccountTypeCode>
    </GetAccountTypeCodesResponse>
    <GetAccountTypeCodesResponse>
        <AccountTypeCode>HLT2</AccountTypeCode>
    </GetAccountTypeCodesResponse>
    <GetAccountTypeCodesResponse xsi:nil="true" />
</GetAccountTypeCodesResult>
</GetAccountTypeCodes>
</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 retrieving account type codes using the GetAccountTypeCode web method.

try
{
    // Create the session SOAP header in order to pass the Service   // the client’s current session id.
    mbiSessionHeader = new DefaultPlanServiceNameSpace.MBISessionHeader();
    // Create proxy object for the service
    proxy = new DefaultPlanServiceNameSpace.DefaultPlanService();
    // Create the request object
    request = new DefaultPlanServiceNameSpace.GetAccountTypeCodeRequest();                                               request.Id = _Id.Text;     request.TypeCode =
        (DefaultPlanServiceNameSpace.AcctType)Enum.Parse(typeof(DefaultPlanServiceNameSpace.AcctType),_AccountTypeCode.T ext,false);
    mbiSessionHeader.MBISessionID = _sessionId;  proxy.MBISessionHeaderValue = mbiSessionHeader;
    response = proxy.GetAccountTypeCode(request);
}
catch(SoapException se)
{
    MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
    MessageBox.Show("EXCEPTION:" + ex.Message);
}

TPA Default Plan API | Administrative - SOAP

DeleteDefaultPlan

Request Body

UpdateDefaultBenefitPlan

Request Body

AddDefaultBenefitPlan

Request Body

GetDefaultPlans

Request Body

Response Body

GetDefaultPlan

Request Body

Response Body

GetAccountTypeCodes

Request Body

Response Body

AI Assistant Preview

AI Assistant ^Preview