- Alegeus Developer Portal

Service Web Methods
The following is a list of methods provided by the Employer HRA Plan Service.

AddEmployerHRAPlan – used to add an employer’s plan information.
DeleteEmployerHRAPlan – used to remove information about an employer’s plan.
UpdateEmployerHRAPlan – used to update an employer’s plan.
GetEmployerHRAPlan – used to retrieve an employer’s plan information.
GetEmployerHRAPlans – used to retrieve all employer’s plans information.

Service Assumptions/Business Rules
The Employer HRA Plan Service makes the following assumptions as well as enforce the following business rules.

Clients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus Technologies 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.
The Employer HRA Plan Service is intended to be used only by non-split plan administrators.

AddEmployerHRAPlan

This method is used to add an employer’s plan information.

History
The AddEmployerHRAPlan methods are listed below:

Request Message

AddEmployerHRAPlanRequest_2012_06
AddEmployerHRAPlanRequest

Response Message

AddEmployerHRAPlanResponse

AddEmployerHRAPlan Request/Response Messages
The AddEmployerHRAPlan method requires the following request and response messages (input and output data).
The table below includes the following request messages:

AddEmployerHRAPlanRequest_2012_06
AddEmployerHRAPlanRequest

Response Message: Empty Message

Example of an AddEmployerHRAPlan SOAP request 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>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>kkhhjnze5fuaxz45fkwama55</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<GetEmployerBankAccount
xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Request/2004/06/">
<addEmployerHRAPlanRequest>
<TpaId>T00202</TpaId>
<EmployerId>CYNCYN</EmployerId>
<PlanId>CYNP2</PlanId>
<AccountTypeCode>ACO</AccountTypeCode>
<PlanYearStartDate>2004-01-01</PlanYearStartDate>
<PlanYearEndDate>2004-12-31</PlanYearEndDate>
<GracePeriodEndDate>2004-12-31</GracePeriodEndDate>
<SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</SpendingLimitPeriod>
<SpendingDepositAmount>0</SpendingDepositAmount>
<SpendingTransactionAmount>0</SpendingTransactionAmount>
<PayCycleTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">NoAutoDeposit</PayCycleTypeCode>
<ConvenienceFeePayor xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</ConvenienceFeePayor>
<ConvenienceFeeAmount>0</ConvenienceFeeAmount>
<MaxTransactionAmount>0</MaxTransactionAmount>
<MaxTotalAmount>0</MaxTotalAmount>
<DefaultPlanOptions xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</DefaultPlanOptions>
</addEmployerHRAPlanRequest>
</GetEmployerBankAccount>
</soap:Body>
</soap:Envelope>

Example of an AddEmployerHRAPlan 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>
<AddEmployerHRAPlanResponse
xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Response/2004/06/">
<AddEmployerHRAPlanResult />
</AddEmployerHRAPlanResponse>
</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 AddEmployerHRAPlan web method.

try
{
// Create the session SOAP header in order to pass the Service
// the client’s current session id.
mbiSessionHeader = new EmployerHRAPlanServiceNameSpace.MBISessionHeader();
// Create proxy object for the service
proxy = new EmployerHRAPlanServiceNameSpace.EmployerHRAPlanService();
// Create request message for method call (input parameters)
request = new EmployerHRAPlanServiceNameSpace.AddEmployerHRAPlanRequest();
// Set the input parameters
request.TpaId = _TpaId.Text;
request.EmployerId = _EmployerId.Text;
request.PlanId = _PlanId.Text;
request.AccountTypeCode = _AccountTypeCode.Text;
request.AllowPartialManualTransaction = Convert.ToBoolean(_AllowPartialManualTransaction.Text);
request.AutoDepositBypass = Convert.ToBoolean(_AutoDepositBypass.Text);
request.ConvenienceFeeAmount = Convert.ToDecimal(_ConvenienceFeeAmount.Text);
request.ConvenienceFeePayor =
(EmployerHRAPlanServiceNameSpace.ConvenienceFeePayor)Enum.Parse(typeof(EmployerHRAPlanServiceNameSpace.Conv
enienceFeePayor),_ConvenienceFeePayor.Text,true);
request.DefaultPlanOptions =
(EmployerHRAPlanServiceNameSpace.DefaultPlanOptions)Enum.Parse(typeof(EmployerHRAPlanServiceNameSpace.DefaultP
lanOptions),_DefaultPlanOptions.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 =
(EmployerHRAPlanServiceNameSpace.PayCycleType)Enum.Parse(typeof(EmployerHRAPlanServiceNameSpace.PayCycleTyp
e),_PayCycleTypeCode.Text,true);
if(_PlanYearStartDate.Text.Length > 0)
{
request.PlanYearStartDate = Convert.ToDateTime(_PlanYearStartDate.Text);
}
if(_PlanYearEndDate.Text.Length > 0)
{
request.PlanYearEndDate = Convert.ToDateTime(_PlanYearEndDate.Text);
}
request.SpendingDepositAmount = Convert.ToDecimal(_SpendingDepositAmount.Text);
request.SpendingLimitPeriod =
(EmployerHRAPlanServiceNameSpace.IntervalType)Enum.Parse(typeof(EmployerHRAPlanServiceNameSpace.IntervalType),_
SpendingLimitPeriod.Text,true);
request.SpendingTransactionAmount = Convert.ToDecimal(_SpendingTransactionAmount.Text);
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.AddEmployerHRAPlan(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}

UpdateEmployerHRAPlan

This method is used to update information about an employer’s plan.

History
The UpdateEmployerHRAPlan methods are listed below:
Request Message

UpdateEmployerHRAPlanRequest_2012_06
UpdateEmployerHRAPlanRequest

Response Message

UpdateEmployerHRAPlanResponse

UpdateEmployerHRAPlan Request/Response Messages
The UpdateEmployerHRAPlan method requires the following request and response messages (input and output data).
The table below includes the following request message:

UpdateEmployerHRAPlanRequest_2012_06
UpdateEmployerHRAPlanRequest

Response Message: Empty Message

Example of an UpdateEmployerHRAPlan SOAP request 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>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>kkhhjnze5fuaxz45fkwama55</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<UpdateEmployerHRAPlan
xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Request/2004/06/">
<updateEmployerHRAPlanRequest>
<TpaId>T00202</TpaId>
<EmployerId>CYNCYN</EmployerId>
<PlanId>CYNP1</PlanId>
<AccountTypeCode>ACO</AccountTypeCode>
<PlanYearStartDate>2004-01-01</PlanYearStartDate>
<PlanYearEndDate>2004-12-31</PlanYearEndDate>
<GracePeriodEndDate>2004-12-31</GracePeriodEndDate>
<SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</SpendingLimitPeriod>
<SpendingDepositAmount>-1.0000</SpendingDepositAmount>
<SpendingTransactionAmount>-1.0000</SpendingTransactionAmount>
<PayCycleTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">NoAutoDeposit</PayCycleTypeCode>
<ConvenienceFeePayor xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</ConvenienceFeePayor>
<ConvenienceFeeAmount>0</ConvenienceFeeAmount>
<MaxTransactionAmount>100.0000</MaxTransactionAmount>
<MaxTotalAmount>100.0000</MaxTotalAmount>
<DefaultPlanOptions xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</DefaultPlanOptions>
</updateEmployerHRAPlanRequest>
</UpdateEmployerHRAPlan>
</soap:Body>
</soap:Envelope>

Example of an UpdateEmployerHRAPlan 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>
<UpdateEmployerHRAPlanResponse
xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Response/2004/06/">
<UpdateEmployerHRAPlanResult />
</UpdateEmployerHRAPlanResponse>
</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 UpdateEmployerHRAPlan web method.

try
{
// Create the session SOAP header in order to pass the Service
// the client’s current session id.
mbiSessionHeader = new EmployerHRAPlanServiceNameSpace.MBISessionHeader();
// Create proxy object for the service
proxy = new EmployerHRAPlanServiceNameSpace.EmployerHRAPlanService();
// Create request message for method call (input parameters)
request = new EmployerHRAPlanServiceNameSpace.UpdateEmployerHRAPlanRequest();
// Set the input parameters
request.AccountTypeCode = _AccountTypeCode.Text;
request.AllowPartialManualTransaction = Convert.ToBoolean(_AllowPartialManualTransaction.Text);
request.AutoDepositBypass = Convert.ToBoolean(_AutoDepositBypass.Text);
request.ConvenienceFeeAmount = Convert.ToDecimal(_ConvenienceFeeAmount.Text);
request.ConvenienceFeePayor =
(EmployerHRAPlanServiceNameSpace.ConvenienceFeePayor)Enum.Parse(typeof(EmployerHRAPlanServiceNameSpace.Conv
enienceFeePayor),_ConvenienceFeePayor.Text,true);
request.DefaultPlanOptions =
(EmployerHRAPlanServiceNameSpace.DefaultPlanOptions)Enum.Parse(typeof(EmployerHRAPlanServiceNameSpace.DefaultP
lanOptions),_DefaultPlanOptions.Text);
request.EmployerId = _EmployerId.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 =
(EmployerHRAPlanServiceNameSpace.PayCycleType)Enum.Parse(typeof(EmployerHRAPlanServiceNameSpace.PayCycleTyp
e),_PayCycleTypeCode.Text,true);
request.PlanId = _PlanId.Text;
if(_PlanYearEndDate.Text.Length > 0)
{
request.PlanYearEndDate = Convert.ToDateTime(_PlanYearEndDate.Text);
}
if(_PlanYearStartDate.Text.Length > 0)
{
request.PlanYearStartDate = Convert.ToDateTime(_PlanYearStartDate.Text);
}
request.SpendingDepositAmount = Convert.ToDecimal(_SpendingDepositAmount.Text);
request.SpendingLimitPeriod =
(EmployerHRAPlanServiceNameSpace.IntervalType)Enum.Parse(typeof(EmployerHRAPlanServiceNameSpace.IntervalType),_
SpendingLimitPeriod.Text,true);
request.SpendingTransactionAmount = Convert.ToDecimal(_SpendingTransactionAmount.Text);
request.TpaId = _TpaId.Text;
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.DeleteEmployerHRAPlan(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}

DeleteEmployerHRAPlan

This method deletes an existing Employer HRA Plan.

History
The DeleteEmployerHRAPlan methods are listed below:

Request Message

DeleteEmployerHRAPlanRequest

Response Message

DeleteEmployerHRAPlanResponse

DeleteEmployerHRAPlan Request/Response Messages
The DeleteEmployerHRAPlan method requires the following request and response messages (input and output data).
The table below includes the following request message:

DeleteEmployerHRAPlanRequest

Response Message: Empty Message

Example of a DeleteEmployerHRAPlan SOAP request 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>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>kkhhjnze5fuaxz45fkwama55</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<DeleteEmployerHRAPlan
xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Request/2004/06/">
<deleteEmployerHRAPlanRequest>
<TpaId>T00202</TpaId>
<EmployerId>CYNCYN</EmployerId>
<PlanId>CYNP1</PlanId>
<AccountTypeCode>ACO</AccountTypeCode>
<PlanYearStartDate>2004-01-01</PlanYearStartDate>
<PlanYearEndDate>2004-12-31</PlanYearEndDate>
</deleteEmployerHRAPlanRequest>
</DeleteEmployerHRAPlan>
</soap:Body>
</soap:Envelope>

Example of a DeleteEmployer 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>
<DeleteEmployerHRAPlanResponse
xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Response/2004/06/">
<DeleteEmployerHRAPlanResult />
</DeleteEmployerHRAPlanResponse>
</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 DeleteEmployerHRAPlan web method.

try
{
// Create the session SOAP header in order to pass the Service
// the client’s current session id.
mbiSessionHeader = new EmployerHRAPlanServiceNameSpace.MBISessionHeader();
// Create proxy object for the service
proxy = new EmployerHRAPlanServiceNameSpace.EmployerHRAPlanService();
// Create request message for method call (input parameters)
request = new EmployerHRAPlanServiceNameSpace.DeleteEmployerHRAPlanRequest();
// Set the input parameters
request.AccountTypeCode = _AccountTypeCode.Text;
request.EmployerId = _EmployerId.Text;
request.PlanId = _PlanId.Text;
if(_PlanYearEndDate.Text.Length > 0)
{
request.PlanYearEndDate = Convert.ToDateTime(_PlanYearEndDate.Text);
}
if(_PlanYearStartDate.Text.Length > 0)
{
request.PlanYearStartDate = Convert.ToDateTime(_PlanYearStartDate.Text);
}
request.TpaId = _TpaId.Text;
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.DeleteEmployerHRAPlan(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}

GetEmployerHRAPlan

This method is used to retrieve an employer’s plan information.

History

The GetEmployerHRAPlan methods are listed below:

Request Message

GetEmployerHRAPlanRequest

Response Message

GetEmployerHRAPlanResponse_2012_06
GetEmployerHRAPlanResponse

GetEmployerHRAPlan Request/Response Messages
The GetEmployerHRAPlan method requires the following request and response messages (input and output data).
The table below includes the following request message:

GetEmployerHRAPlanRequest

The table below includes the following response message:

GetEmployerHRAPlanResponse

Example of a GetEmployerHRAPlan SOAP request 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>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>kkhhjnze5fuaxz45fkwama55</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<GetEmployerHRAPlan
xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Request/2004/06/">
<getEmployerHRAPlanRequest>
<TpaId>T00202</TpaId>
<EmployerId>CYNCYN</EmployerId>
<PlanId>CYNP1</PlanId>
<AccountTypeCode>ACO</AccountTypeCode>
<PlanYearStartDate>2004-01-01</PlanYearStartDate>
<PlanYearEndDate>2004-12-31</PlanYearEndDate>
</getEmployerHRAPlanRequest>
</GetEmployerHRAPlan>
</soap:Body>
</soap:Envelope>

Example of a GetEmployerHRAPlan 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>
<GetEmployerHRAPlanResponse
xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Response/2004/06/">
<GetEmployerHRAPlanResult>
<TpaId>T00202</TpaId>
<EmployerId>CYNCYN</EmployerId>
<PlanId>CYNP1</PlanId>
<AccountTypeCode>ACO</AccountTypeCode>
<PlanYearStartDate>20040101</PlanYearStartDate>
<PlanYearEndDate>20041231</PlanYearEndDate>
<GracePeriodEndDate>20041231</GracePeriodEndDate>
<SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</SpendingLimitPeriod>
<SpendingDepositAmount>-1.0000</SpendingDepositAmount>
<SpendingTransactionAmount>-1.0000</SpendingTransactionAmount>
<AllowPartialManualTransaction>false</AllowPartialManualTransaction>
<AutoDepositBypass>false</AutoDepositBypass>
<PayCycleTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">NoAutoDeposit</PayCycleTypeCode>
<ConvenienceFeePayor xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</ConvenienceFeePayor>
<ConvenienceFeeAmount>0</ConvenienceFeeAmount>
<MaxTransactionAmount>100.0000</MaxTransactionAmount>
<MaxTotalAmount>100.0000</MaxTotalAmount>
<DefaultPlanOptions xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</DefaultPlanOptions>
</GetEmployerHRAPlanResult>
</GetEmployerHRAPlanResponse>
</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 GetEmployerHRAPlan web method.

try
{
_dataset.Tables["EmployerHRAPlan"].Clear();
// Create the session SOAP header in order to pass the Service
// the client’s current session id.
mbiSessionHeader = new EmployerHRAPlanServiceNameSpace.MBISessionHeader();
// Create proxy object for the service
proxy = new EmployerHRAPlanServiceNameSpace.EmployerHRAPlanService();
// Create request message for method call (input parameters)
request = new EmployerHRAPlanServiceNameSpace.GetEmployerHRAPlanRequest();
// Set the input parameters
request.AccountTypeCode = _AccountTypeCode.Text;
request.EmployerId = _EmployerId.Text;
request.PlanId = _PlanId.Text;
if(_PlanYearEndDate.Text.Length > 0)
{
request.PlanYearEndDate = Convert.ToDateTime(_PlanYearEndDate.Text);
}
if(_PlanYearStartDate.Text.Length > 0)
{
request.PlanYearStartDate = Convert.ToDateTime(_PlanYearStartDate.Text);
}
request.TpaId = _TpaId.Text;
// session ID returned from logon method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.GetEmployerHRAPlan(request);
}
catch(SoapException se)
{
MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
MessageBox.Show("EXCEPTION:" + ex.Message);
}

GetEmployerHRAPlans

This method is used to retrieve all the employer’s plans.

History
The GetEmployerHRAPlans methods are listed below

Request Message

GetEmployerHRAPlansRequest

Response Message

GetEmployerHRAPlansResponse_2012_06
GetEmployerHRAPlansResponse

GetEmployerHRAPlans Request/Response Messages
The GetEmployerHRAPlans method requires the following request and response messages (input and output data).
The table below includes the following request message:

GetEmployerHRAPlansRequest

The table below includes the following response message:

GetEmployerHRAPlansResponse

Example of a GetEmployerHRAPlans SOAP request 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>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>alcfwq55w34yl555c4vxlyv4</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<GetEmployerHRAPlans
xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Request/2004/06/">
<getEmployerHRAPlansRequest>
<TpaId>T00238</TpaId>
<EmployerId>CYNCYN</EmployerId>
<PlanYear>All</PlanYear>
</getEmployerHRAPlansRequest>
</GetEmployerHRAPlans>
</soap:Body>
</soap:Envelope>

Example of a GetEmployerHRAPlans 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>
<GetEmployerHRAPlansResponse
xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Response/2004/06/">
<GetEmployerHRAPlansResult>
<GetEmployerHRAPlansResponse>
<TpaId>T00238</TpaId>
<EmployerId>CYNCYN</EmployerId>
<PlanId>CYN</PlanId>
<AccountTypeCode>ACO</AccountTypeCode>
<PlanYearStartDate>20031006</PlanYearStartDate>
<PlanYearEndDate>20051118</PlanYearEndDate>
<SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</SpendingLimitPeriod>
<SpendingDepositAmount>-1.0000</SpendingDepositAmount>
<SpendingTransactionAmount>-1.0000</SpendingTransactionAmount>
<AllowPartialManualTransaction>false</AllowPartialManualTransaction>
<AutoDepositBypass>false</AutoDepositBypass>
<PayCycleTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Monthly</PayCycleTypeCode>
<ConvenienceFeePayor xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</ConvenienceFeePayor>
<ConvenienceFeeAmount>0</ConvenienceFeeAmount>
<MaxTransactionAmount>1000.0000</MaxTransactionAmount>
<MaxTotalAmount>1000.0000</MaxTotalAmount>
<DefaultPlanOptions>false</DefaultPlanOptions>
</GetEmployerHRAPlansResponse>
</GetEmployerHRAPlansResult>
</GetEmployerHRAPlansResponse>
</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
GetEmployerHRAPlans web method.


try
{
_dataset.Tables[0].Clear();
proxy = new WebServiceTestHarness.EmployerHRAPlanServiceNameSpace.EmployerHRAPlanService();
request = new WebServiceTestHarness.EmployerHRAPlanServiceNameSpace.GetEmployerHRAPlansRequest();
mbiSessionHeader = new WebServiceTestHarness.EmployerHRAPlanServiceNameSpace.MBISessionHeader();
mbiSessionHeader.MBISessionID = _sessionId;
proxy.MBISessionHeaderValue = mbiSessionHeader;
proxy.Url = proxy.Url.Replace(Formatter.DEFAULT_SERVER, _server);
proxy.Url = proxy.Url.Replace(Formatter.DEFAULT_PROTOCOL, _protocol);
request.EmployerId = _EmployerId.Text;
request.PlanYear = (EmployerHRAPlanServiceNameSpace.PlanYear)
Enum.Parse(typeof(EmployerHRAPlanServiceNameSpace.PlanYear),_PlanYear.Text,true);
request.TpaId = _TpaId.Text;
response = proxy.GetEmployerHRAPlans(request);
}
catch(SoapException se)
{
MessageBox.Show(Formatter.FormatSoapException(se));
}
catch(Exception ex)
{
MessageBox.Show("EXCEPTION:" + ex.Message);
}

Employer HRA Plan API | Administrative - SOAP

AddEmployerHRAPlan

UpdateEmployerHRAPlan

DeleteEmployerHRAPlan

GetEmployerHRAPlan

GetEmployerHRAPlans