EmployerPlanService Web Service

EmployerPlanService

Click here for a complete list of operations.

AddEmployerPlan

This method is used to add an employer's plan information to 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/2006_05/EmployerPlanService.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/EmployerPlan/2006/05/AddEmployerPlan"

<?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>
    <AddEmployerPlan_2006_05 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerPlan/Request/2006/05/">
      <addEmployerPlanRequest_2006_05>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <PlanId>string</PlanId>
        <AccountTypeCode>string</AccountTypeCode>
        <PlanYearStartDate>date</PlanYearStartDate>
        <PlanYearEndDate>date</PlanYearEndDate>
        <GracePeriodEndDate>date</GracePeriodEndDate>
        <PlanYearExtendedEndDate>date</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>
        <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>
        <RolloverPlan>boolean</RolloverPlan>
        <RolloverPlanAttributes xmlns="http://www.medibank.com/MBIWebServices/Enums/">All or MerchantTypeCodes or PlanDesignExceptiosn or MerchantExceptions or TerminalExceptions or CopayAmountsForAuto</RolloverPlanAttributes>
        <ProductPartnerAccountFee>short</ProductPartnerAccountFee>
        <ProductPartnerSetupFee>short</ProductPartnerSetupFee>
        <ProductPartnerIssueCheckbooks>boolean</ProductPartnerIssueCheckbooks>
        <ProductPartnerEmployerId>string</ProductPartnerEmployerId>
        <ProductPartnerAdministratorId>string</ProductPartnerAdministratorId>
        <ProductPartnerProductId>string</ProductPartnerProductId>
      </addEmployerPlanRequest_2006_05>
    </AddEmployerPlan_2006_05>
  </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>
    <AddEmployerPlanResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerPlan/Response/2004/06/">
      <AddEmployerPlanResult />
    </AddEmployerPlanResponse>
  </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/2006_05/EmployerPlanService.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>
    <AddEmployerPlan_2006_05 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerPlan/Request/2006/05/">
      <addEmployerPlanRequest_2006_05>
        <TpaId>string</TpaId>
        <EmployerId>string</EmployerId>
        <PlanId>string</PlanId>
        <AccountTypeCode>string</AccountTypeCode>
        <PlanYearStartDate>date</PlanYearStartDate>
        <PlanYearEndDate>date</PlanYearEndDate>
        <GracePeriodEndDate>date</GracePeriodEndDate>
        <PlanYearExtendedEndDate>date</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>
        <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>
        <RolloverPlan>boolean</RolloverPlan>
        <RolloverPlanAttributes xmlns="http://www.medibank.com/MBIWebServices/Enums/">All or MerchantTypeCodes or PlanDesignExceptiosn or MerchantExceptions or TerminalExceptions or CopayAmountsForAuto</RolloverPlanAttributes>
        <ProductPartnerAccountFee>short</ProductPartnerAccountFee>
        <ProductPartnerSetupFee>short</ProductPartnerSetupFee>
        <ProductPartnerIssueCheckbooks>boolean</ProductPartnerIssueCheckbooks>
        <ProductPartnerEmployerId>string</ProductPartnerEmployerId>
        <ProductPartnerAdministratorId>string</ProductPartnerAdministratorId>
        <ProductPartnerProductId>string</ProductPartnerProductId>
      </addEmployerPlanRequest_2006_05>
    </AddEmployerPlan_2006_05>
  </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>
    <AddEmployerPlanResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/EmployerPlan/Response/2004/06/">
      <AddEmployerPlanResult />
    </AddEmployerPlanResponse>
  </soap12:Body>
</soap12:Envelope>