EmployerService Web Service

EmployerService

Click here for a complete list of operations.

GetEmployers

This method is used to retrieve an employers' 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/2006_12/EmployerService.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/Employer/2006/12/GetEmployers"

<?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>
    <GetEmployers xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Request/2004/06/">
      <getEmployersRequest>
        <TpaId>string</TpaId>
        <VerboseMode>boolean</VerboseMode>
      </getEmployersRequest>
    </GetEmployers>
  </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>
    <GetEmployersResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Response/2004/06/">
      <GetEmployersResult>
        <GetEmployersResponse>
          <ActiveFirstUse>boolean</ActiveFirstUse>
          <BucketSplit>boolean</BucketSplit>
          <City>string</City>
          <CopayAutoReview>boolean</CopayAutoReview>
          <EmailAddress>string</EmailAddress>
          <EmployerId>string</EmployerId>
          <EmployerName>string</EmployerName>
          <EmployerStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">New or Active or TempInactive or PermInactive</EmployerStatus>
          <RecurringExpenseAutoReview>boolean</RecurringExpenseAutoReview>
          <State>string</State>
          <TpaId>string</TpaId>
        </GetEmployersResponse>
        <GetEmployersResponse>
          <ActiveFirstUse>boolean</ActiveFirstUse>
          <BucketSplit>boolean</BucketSplit>
          <City>string</City>
          <CopayAutoReview>boolean</CopayAutoReview>
          <EmailAddress>string</EmailAddress>
          <EmployerId>string</EmployerId>
          <EmployerName>string</EmployerName>
          <EmployerStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">New or Active or TempInactive or PermInactive</EmployerStatus>
          <RecurringExpenseAutoReview>boolean</RecurringExpenseAutoReview>
          <State>string</State>
          <TpaId>string</TpaId>
        </GetEmployersResponse>
      </GetEmployersResult>
    </GetEmployersResponse>
  </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_12/EmployerService.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>
    <GetEmployers xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Request/2004/06/">
      <getEmployersRequest>
        <TpaId>string</TpaId>
        <VerboseMode>boolean</VerboseMode>
      </getEmployersRequest>
    </GetEmployers>
  </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>
    <GetEmployersResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Response/2004/06/">
      <GetEmployersResult>
        <GetEmployersResponse>
          <ActiveFirstUse>boolean</ActiveFirstUse>
          <BucketSplit>boolean</BucketSplit>
          <City>string</City>
          <CopayAutoReview>boolean</CopayAutoReview>
          <EmailAddress>string</EmailAddress>
          <EmployerId>string</EmployerId>
          <EmployerName>string</EmployerName>
          <EmployerStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">New or Active or TempInactive or PermInactive</EmployerStatus>
          <RecurringExpenseAutoReview>boolean</RecurringExpenseAutoReview>
          <State>string</State>
          <TpaId>string</TpaId>
        </GetEmployersResponse>
        <GetEmployersResponse>
          <ActiveFirstUse>boolean</ActiveFirstUse>
          <BucketSplit>boolean</BucketSplit>
          <City>string</City>
          <CopayAutoReview>boolean</CopayAutoReview>
          <EmailAddress>string</EmailAddress>
          <EmployerId>string</EmployerId>
          <EmployerName>string</EmployerName>
          <EmployerStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">New or Active or TempInactive or PermInactive</EmployerStatus>
          <RecurringExpenseAutoReview>boolean</RecurringExpenseAutoReview>
          <State>string</State>
          <TpaId>string</TpaId>
        </GetEmployersResponse>
      </GetEmployersResult>
    </GetEmployersResponse>
  </soap12:Body>
</soap12:Envelope>