EmployerPlanService


Click here for a complete list of operations.

GetEmployerPlan

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/2009_04/EmployerPlanService.asmx HTTP/1.1
Host: www.mbibeta.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.medibank.com/MBIWebServices/Employer/Services/EmployerPlan/2009/04/GetEmployerPlan"

<?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>
    <GetEmployerPlan_2007_12 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerPlan/Request/2007/12/">
      <getEmployerPlanRequest>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <PlanId>string</PlanId>
        <AccountTypeCode>string</AccountTypeCode>
        <PlanYearStartDate>date</PlanYearStartDate>
        <PlanYearEndDate>date</PlanYearEndDate>
        <VerboseMode>boolean</VerboseMode>
        <QueryIias>boolean</QueryIias>
      </getEmployerPlanRequest>
    </GetEmployerPlan_2007_12>
  </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>
    <GetEmployerPlanResponse_2009_04 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerPlan/Response/2009/04/">
      <GetEmployerPlanResult>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <PlanId>string</PlanId>
        <AccountTypeCode>string</AccountTypeCode>
        <PlanYearStartDate>string</PlanYearStartDate>
        <PlanYearEndDate>string</PlanYearEndDate>
        <GracePeriodEndDate>string</GracePeriodEndDate>
        <PlanYearExtendedEndDate>string</PlanYearExtendedEndDate>
        <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>
        <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>
        <PlanOptions>short</PlanOptions>
        <ProductPartnerAccountFee>short</ProductPartnerAccountFee>
        <ProductPartnerSetupFee>short</ProductPartnerSetupFee>
        <ProductPartnerIssueCheckbooks>boolean</ProductPartnerIssueCheckbooks>
        <ProductPartnerEmployerId>string</ProductPartnerEmployerId>
        <ProductPartnerAdministratorId>string</ProductPartnerAdministratorId>
        <ProductPartnerProductId>string</ProductPartnerProductId>
        <IiasSettings xmlns="http://www.medibank.com/MBIWebServices/Enums/">NotUsed or Disabled or HealthEligibleTotal or Specific</IiasSettings>
        <IiasOptions xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Rx or Vision or Dental</IiasOptions>
        <CoverageTierTypeId>string</CoverageTierTypeId>
        <DefaultCoverageTierId>string</DefaultCoverageTierId>
        <LifeEventCalcMethods xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or AnnualDisbursements or MaximumBenefits or QleTrackingOnly</LifeEventCalcMethods>
        <ManualClaimPercentCoverage>decimal</ManualClaimPercentCoverage>
        <IndividualBalanceMax>decimal</IndividualBalanceMax>
        <RolloverBalanceMax>decimal</RolloverBalanceMax>
        <DefaultDepositCalendarId>string</DefaultDepositCalendarId>
        <FixedEmployerFundingCalendarId>string</FixedEmployerFundingCalendarId>
        <FixedEmployerFundingAmount>double</FixedEmployerFundingAmount>
        <FixedEmployerFundingAmountIndividual>double</FixedEmployerFundingAmountIndividual>
        <ExtDeductible>short</ExtDeductible>
        <AllowClaimsCrossover>short</AllowClaimsCrossover>
        <ClaimsCrossoverParticipantDefault>short</ClaimsCrossoverParticipantDefault>
        <AnnualElectMin>decimal</AnnualElectMin>
        <AnnualElectMax>decimal</AnnualElectMax>
        <EnforceEmployeeContributionLimit>boolean</EnforceEmployeeContributionLimit>
      </GetEmployerPlanResult>
    </GetEmployerPlanResponse_2009_04>
  </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/2009_04/EmployerPlanService.asmx HTTP/1.1
Host: www.mbibeta.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>
    <GetEmployerPlan_2007_12 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerPlan/Request/2007/12/">
      <getEmployerPlanRequest>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <PlanId>string</PlanId>
        <AccountTypeCode>string</AccountTypeCode>
        <PlanYearStartDate>date</PlanYearStartDate>
        <PlanYearEndDate>date</PlanYearEndDate>
        <VerboseMode>boolean</VerboseMode>
        <QueryIias>boolean</QueryIias>
      </getEmployerPlanRequest>
    </GetEmployerPlan_2007_12>
  </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>
    <GetEmployerPlanResponse_2009_04 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerPlan/Response/2009/04/">
      <GetEmployerPlanResult>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <PlanId>string</PlanId>
        <AccountTypeCode>string</AccountTypeCode>
        <PlanYearStartDate>string</PlanYearStartDate>
        <PlanYearEndDate>string</PlanYearEndDate>
        <GracePeriodEndDate>string</GracePeriodEndDate>
        <PlanYearExtendedEndDate>string</PlanYearExtendedEndDate>
        <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>
        <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>
        <PlanOptions>short</PlanOptions>
        <ProductPartnerAccountFee>short</ProductPartnerAccountFee>
        <ProductPartnerSetupFee>short</ProductPartnerSetupFee>
        <ProductPartnerIssueCheckbooks>boolean</ProductPartnerIssueCheckbooks>
        <ProductPartnerEmployerId>string</ProductPartnerEmployerId>
        <ProductPartnerAdministratorId>string</ProductPartnerAdministratorId>
        <ProductPartnerProductId>string</ProductPartnerProductId>
        <IiasSettings xmlns="http://www.medibank.com/MBIWebServices/Enums/">NotUsed or Disabled or HealthEligibleTotal or Specific</IiasSettings>
        <IiasOptions xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Rx or Vision or Dental</IiasOptions>
        <CoverageTierTypeId>string</CoverageTierTypeId>
        <DefaultCoverageTierId>string</DefaultCoverageTierId>
        <LifeEventCalcMethods xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or AnnualDisbursements or MaximumBenefits or QleTrackingOnly</LifeEventCalcMethods>
        <ManualClaimPercentCoverage>decimal</ManualClaimPercentCoverage>
        <IndividualBalanceMax>decimal</IndividualBalanceMax>
        <RolloverBalanceMax>decimal</RolloverBalanceMax>
        <DefaultDepositCalendarId>string</DefaultDepositCalendarId>
        <FixedEmployerFundingCalendarId>string</FixedEmployerFundingCalendarId>
        <FixedEmployerFundingAmount>double</FixedEmployerFundingAmount>
        <FixedEmployerFundingAmountIndividual>double</FixedEmployerFundingAmountIndividual>
        <ExtDeductible>short</ExtDeductible>
        <AllowClaimsCrossover>short</AllowClaimsCrossover>
        <ClaimsCrossoverParticipantDefault>short</ClaimsCrossoverParticipantDefault>
        <AnnualElectMin>decimal</AnnualElectMin>
        <AnnualElectMax>decimal</AnnualElectMax>
        <EnforceEmployeeContributionLimit>boolean</EnforceEmployeeContributionLimit>
      </GetEmployerPlanResult>
    </GetEmployerPlanResponse_2009_04>
  </soap12:Body>
</soap12:Envelope>