EmployerService Web Service

EmployerService

Click here for a complete list of operations.

GetEmployer

This method is used to retrieve an employer's 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/EmployerService.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/Employer/2008/07/GetEmployer"

<?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>
    <GetEmployer xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Request/2004/06/">
      <getEmployerRequest>
        <EmployerId>string</EmployerId>
        <TpaId>string</TpaId>
        <VerboseMode>boolean</VerboseMode>
      </getEmployerRequest>
    </GetEmployer>
  </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>
    <GetEmployerResponse_2007_12 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Response/2007/12/">
      <GetEmployerResult>
        <ActiveFirstUse>boolean</ActiveFirstUse>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <CardExpirationMonths>int</CardExpirationMonths>
        <CardIssueAddressIndicator xmlns="http://www.medibank.com/MBIWebServices/Enums/">Cardholder or Employer or Tpa or MBI or EmployerAlternate or AdminAlternate</CardIssueAddressIndicator>
        <CardReissueLeadDays>int</CardReissueLeadDays>
        <CardOffered xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or FlexCard or FlexCardOptional</CardOffered>
        <CardSecondLine>string</CardSecondLine>
        <CheckProcessMethod xmlns="http://www.medibank.com/MBIWebServices/Enums/">All or None or File or Print</CheckProcessMethod>
        <City>string</City>
        <CopayAutoReview>boolean</CopayAutoReview>
        <Country>string</Country>
        <DirectDepositMethod xmlns="http://www.medibank.com/MBIWebServices/Enums/">All or None or File</DirectDepositMethod>
        <EmailAddress>string</EmailAddress>
        <EmployeeUserDefinedFields>string</EmployeeUserDefinedFields>
        <EmployerForTesting>boolean</EmployerForTesting>
        <EmployerId>string</EmployerId>
        <EmployerName>string</EmployerName>
        <EmployerPhoneNumber>string</EmployerPhoneNumber>
        <EmployerTaxId>string</EmployerTaxId>
        <EmployerStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">New or Active or TempInactive or PermInactive</EmployerStatus>
        <EmployerUserDefinedFields>string</EmployerUserDefinedFields>
        <EmployerUserDefinedFieldsData>string</EmployerUserDefinedFieldsData>
        <EmployerFaxNumber>string</EmployerFaxNumber>
        <ProjectedEnrollees>int</ProjectedEnrollees>
        <RecurringExpenseAutoReview>boolean</RecurringExpenseAutoReview>
        <SetupEmailAddress>string</SetupEmailAddress>
        <State>string</State>
        <TpaId>string</TpaId>
        <ZipCode>string</ZipCode>
        <ThermalPrintName>string</ThermalPrintName>
        <DefaultCardDesign>string</DefaultCardDesign>
        <EmprOptions>long</EmprOptions>
        <ComboCardWaitingPeriod>int</ComboCardWaitingPeriod>
        <AllowSplitAcrossPlanDesign>boolean</AllowSplitAcrossPlanDesign>
        <ThermalLogoId>string</ThermalLogoId>
      </GetEmployerResult>
    </GetEmployerResponse_2007_12>
  </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/EmployerService.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>
    <GetEmployer xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Request/2004/06/">
      <getEmployerRequest>
        <EmployerId>string</EmployerId>
        <TpaId>string</TpaId>
        <VerboseMode>boolean</VerboseMode>
      </getEmployerRequest>
    </GetEmployer>
  </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>
    <GetEmployerResponse_2007_12 xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Response/2007/12/">
      <GetEmployerResult>
        <ActiveFirstUse>boolean</ActiveFirstUse>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <CardExpirationMonths>int</CardExpirationMonths>
        <CardIssueAddressIndicator xmlns="http://www.medibank.com/MBIWebServices/Enums/">Cardholder or Employer or Tpa or MBI or EmployerAlternate or AdminAlternate</CardIssueAddressIndicator>
        <CardReissueLeadDays>int</CardReissueLeadDays>
        <CardOffered xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or FlexCard or FlexCardOptional</CardOffered>
        <CardSecondLine>string</CardSecondLine>
        <CheckProcessMethod xmlns="http://www.medibank.com/MBIWebServices/Enums/">All or None or File or Print</CheckProcessMethod>
        <City>string</City>
        <CopayAutoReview>boolean</CopayAutoReview>
        <Country>string</Country>
        <DirectDepositMethod xmlns="http://www.medibank.com/MBIWebServices/Enums/">All or None or File</DirectDepositMethod>
        <EmailAddress>string</EmailAddress>
        <EmployeeUserDefinedFields>string</EmployeeUserDefinedFields>
        <EmployerForTesting>boolean</EmployerForTesting>
        <EmployerId>string</EmployerId>
        <EmployerName>string</EmployerName>
        <EmployerPhoneNumber>string</EmployerPhoneNumber>
        <EmployerTaxId>string</EmployerTaxId>
        <EmployerStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">New or Active or TempInactive or PermInactive</EmployerStatus>
        <EmployerUserDefinedFields>string</EmployerUserDefinedFields>
        <EmployerUserDefinedFieldsData>string</EmployerUserDefinedFieldsData>
        <EmployerFaxNumber>string</EmployerFaxNumber>
        <ProjectedEnrollees>int</ProjectedEnrollees>
        <RecurringExpenseAutoReview>boolean</RecurringExpenseAutoReview>
        <SetupEmailAddress>string</SetupEmailAddress>
        <State>string</State>
        <TpaId>string</TpaId>
        <ZipCode>string</ZipCode>
        <ThermalPrintName>string</ThermalPrintName>
        <DefaultCardDesign>string</DefaultCardDesign>
        <EmprOptions>long</EmprOptions>
        <ComboCardWaitingPeriod>int</ComboCardWaitingPeriod>
        <AllowSplitAcrossPlanDesign>boolean</AllowSplitAcrossPlanDesign>
        <ThermalLogoId>string</ThermalLogoId>
      </GetEmployerResult>
    </GetEmployerResponse_2007_12>
  </soap12:Body>
</soap12:Envelope>