EmployerHRAPlanService Web Service

EmployerHRAPlanService

Click here for a complete list of operations.

GetEmployerHRAPlans

This method is used to retrieve an employer's plan information from BPS.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /MBIWebServices/Employer/Services/2008_07/EmployerHRAPlanService.asmx HTTP/1.1
Host: www.mbiwebservices.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.medibank.com/MBIWebServices/Employer/Services/EmployerHRAPlan/2008/07/GetEmployerHRAPlans"

<?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>
    <GetEmployerHRAPlans xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Request/2004/06/">
      <getEmployerHRAPlansRequest>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <PlanYear xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or All or Current or Previous or Future or Active or CurrentAndFuture</PlanYear>
        <VerboseMode>boolean</VerboseMode>
      </getEmployerHRAPlansRequest>
    </GetEmployerHRAPlans>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <GetEmployerHRAPlansResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Response/2004/06/">
      <GetEmployerHRAPlansResult>
        <GetEmployerHRAPlansResponse>
          <TpaId>string</TpaId>
          <EmployerId>string</EmployerId>
          <PlanId>string</PlanId>
          <AccountTypeCode>string</AccountTypeCode>
          <PlanYearStartDate>string</PlanYearStartDate>
          <PlanYearEndDate>string</PlanYearEndDate>
          <GracePeriodEndDate>string</GracePeriodEndDate>
          <SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Month or Year or Quarter</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 or HidePlanFromParticpiant</DefaultPlanOptions>
          <HraType xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or IndividualFamilyAmt or SingleFundHra</HraType>
        </GetEmployerHRAPlansResponse>
        <GetEmployerHRAPlansResponse>
          <TpaId>string</TpaId>
          <EmployerId>string</EmployerId>
          <PlanId>string</PlanId>
          <AccountTypeCode>string</AccountTypeCode>
          <PlanYearStartDate>string</PlanYearStartDate>
          <PlanYearEndDate>string</PlanYearEndDate>
          <GracePeriodEndDate>string</GracePeriodEndDate>
          <SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Month or Year or Quarter</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 or HidePlanFromParticpiant</DefaultPlanOptions>
          <HraType xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or IndividualFamilyAmt or SingleFundHra</HraType>
        </GetEmployerHRAPlansResponse>
      </GetEmployerHRAPlansResult>
    </GetEmployerHRAPlansResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /MBIWebServices/Employer/Services/2008_07/EmployerHRAPlanService.asmx HTTP/1.1
Host: www.mbiwebservices.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
      <MBISessionID>string</MBISessionID>
    </MBISessionHeader>
  </soap12:Header>
  <soap12:Body>
    <GetEmployerHRAPlans xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Request/2004/06/">
      <getEmployerHRAPlansRequest>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <PlanYear xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or All or Current or Previous or Future or Active or CurrentAndFuture</PlanYear>
        <VerboseMode>boolean</VerboseMode>
      </getEmployerHRAPlansRequest>
    </GetEmployerHRAPlans>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
      <MessageId>string</MessageId>
    </MBIMessageIdHeader>
  </soap12:Header>
  <soap12:Body>
    <GetEmployerHRAPlansResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerHRAPlan/Response/2004/06/">
      <GetEmployerHRAPlansResult>
        <GetEmployerHRAPlansResponse>
          <TpaId>string</TpaId>
          <EmployerId>string</EmployerId>
          <PlanId>string</PlanId>
          <AccountTypeCode>string</AccountTypeCode>
          <PlanYearStartDate>string</PlanYearStartDate>
          <PlanYearEndDate>string</PlanYearEndDate>
          <GracePeriodEndDate>string</GracePeriodEndDate>
          <SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Month or Year or Quarter</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 or HidePlanFromParticpiant</DefaultPlanOptions>
          <HraType xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or IndividualFamilyAmt or SingleFundHra</HraType>
        </GetEmployerHRAPlansResponse>
        <GetEmployerHRAPlansResponse>
          <TpaId>string</TpaId>
          <EmployerId>string</EmployerId>
          <PlanId>string</PlanId>
          <AccountTypeCode>string</AccountTypeCode>
          <PlanYearStartDate>string</PlanYearStartDate>
          <PlanYearEndDate>string</PlanYearEndDate>
          <GracePeriodEndDate>string</GracePeriodEndDate>
          <SpendingLimitPeriod xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Month or Year or Quarter</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 or HidePlanFromParticpiant</DefaultPlanOptions>
          <HraType xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or IndividualFamilyAmt or SingleFundHra</HraType>
        </GetEmployerHRAPlansResponse>
      </GetEmployerHRAPlansResult>
    </GetEmployerHRAPlansResponse>
  </soap12:Body>
</soap12:Envelope>