EmployerService Web Service

EmployerService

Click here for a complete list of operations.

AddEmployer

This method is used to add an employer's 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/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/2004/06/AddEmployer"

<?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>
    <AddEmployer xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Request/2004/06/">
      <addEmployerRequest>
        <ActiveFirstUse>boolean</ActiveFirstUse>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <BucketSplit>boolean</BucketSplit>
        <CardExpirationMonths xmlns="http://www.medibank.com/MBIWebServices/Enums/">Months12 or Months24 or Months36</CardExpirationMonths>
        <CardIssueAddressIndicator xmlns="http://www.medibank.com/MBIWebServices/Enums/">Cardholder or Employer or Tpa or MBI or EmployerAlternate or AdminAlternate</CardIssueAddressIndicator>
        <CardReissueLeadDays xmlns="http://www.medibank.com/MBIWebServices/Enums/">Days15 or Days30 or Days45 or Days60</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>
        <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>
      </addEmployerRequest>
    </AddEmployer>
  </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>
    <MBIWarningsHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
      <MBIWarnings>
        <MBIWarning>
          <Code>string</Code>
          <Message>string</Message>
        </MBIWarning>
        <MBIWarning>
          <Code>string</Code>
          <Message>string</Message>
        </MBIWarning>
      </MBIWarnings>
    </MBIWarningsHeader>
  </soap:Header>
  <soap:Body>
    <AddEmployerResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Response/2004/06/">
      <AddEmployerResult />
    </AddEmployerResponse>
  </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/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>
    <AddEmployer xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Request/2004/06/">
      <addEmployerRequest>
        <ActiveFirstUse>boolean</ActiveFirstUse>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <BucketSplit>boolean</BucketSplit>
        <CardExpirationMonths xmlns="http://www.medibank.com/MBIWebServices/Enums/">Months12 or Months24 or Months36</CardExpirationMonths>
        <CardIssueAddressIndicator xmlns="http://www.medibank.com/MBIWebServices/Enums/">Cardholder or Employer or Tpa or MBI or EmployerAlternate or AdminAlternate</CardIssueAddressIndicator>
        <CardReissueLeadDays xmlns="http://www.medibank.com/MBIWebServices/Enums/">Days15 or Days30 or Days45 or Days60</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>
        <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>
      </addEmployerRequest>
    </AddEmployer>
  </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>
    <MBIWarningsHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
      <MBIWarnings>
        <MBIWarning>
          <Code>string</Code>
          <Message>string</Message>
        </MBIWarning>
        <MBIWarning>
          <Code>string</Code>
          <Message>string</Message>
        </MBIWarning>
      </MBIWarnings>
    </MBIWarningsHeader>
  </soap12:Header>
  <soap12:Body>
    <AddEmployerResponse xmlns="http://www.medibank.com/MBIWebServices/Employer/Messages/Employer/Response/2004/06/">
      <AddEmployerResult />
    </AddEmployerResponse>
  </soap12:Body>
</soap12:Envelope>