EmployeeService Web Service

EmployeeService

Click here for a complete list of operations.

GetEmployee

This method is used to retrieve an employee's demographic and check routing 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/Employee/Services/2008_07/EmployeeService.asmx HTTP/1.1
Host: www.mbiwebservices.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/2008/07/GetEmployee"

<?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>
    <GetEmployee xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Request/2004/06/">
      <getEmployeeRequest>
        <EmployeeSocialSecurityNumber>string</EmployeeSocialSecurityNumber>
        <EmployeeId>string</EmployeeId>
        <EmployerId>string</EmployerId>
        <TpaId>string</TpaId>
        <VerboseMode>boolean</VerboseMode>
      </getEmployeeRequest>
    </GetEmployee>
  </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>
    <GetEmployeeResponse_2008_07 xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Response/2007/12/">
      <GetEmployeeResult>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <BankAccount>string</BankAccount>
        <BankAccountTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Checking or Savings or GeneralLedger</BankAccountTypeCode>
        <BankRoutingNumber>string</BankRoutingNumber>
        <BirthDate>string</BirthDate>
        <City>string</City>
        <Country>string</Country>
        <EmailAddress>string</EmailAddress>
        <EmployeeSocialSecurityNumber>string</EmployeeSocialSecurityNumber>
        <EmployeeId>string</EmployeeId>
        <EmployeeStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">All or New or Active or TempInactive or PermInactive or Terminated or Enrollment</EmployeeStatus>
        <EmployerId>string</EmployerId>
        <FirstName>string</FirstName>
        <Gender xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Male or Female</Gender>
        <LastName>string</LastName>
        <EmployeeMaritalStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Single or Married or Separated or Widowed or Divorced</EmployeeMaritalStatus>
        <MiddleInitial>string</MiddleInitial>
        <NamePrefix>string</NamePrefix>
        <Phone>string</Phone>
        <ReimbursementCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Undefined or None or Check or DirectDeposit or ExternalCheck or ExternalDirectDeposit or Card or Payroll</ReimbursementCode>
        <Remarks>string</Remarks>
        <ShippingAddress1>string</ShippingAddress1>
        <ShippingAddress2>string</ShippingAddress2>
        <ShippingCity>string</ShippingCity>
        <ShippingCountry>string</ShippingCountry>
        <ShippingState>string</ShippingState>
        <ShippingZipCode>string</ShippingZipCode>
        <State>string</State>
        <TpaId>string</TpaId>
        <UserDefinedField>string</UserDefinedField>
        <ZipCode>string</ZipCode>
        <CardDesignId>string</CardDesignId>
        <EligibilityDate>string</EligibilityDate>
        <TerminationDate>string</TerminationDate>
      </GetEmployeeResult>
    </GetEmployeeResponse_2008_07>
  </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/Employee/Services/2008_07/EmployeeService.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>
    <GetEmployee xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Request/2004/06/">
      <getEmployeeRequest>
        <EmployeeSocialSecurityNumber>string</EmployeeSocialSecurityNumber>
        <EmployeeId>string</EmployeeId>
        <EmployerId>string</EmployerId>
        <TpaId>string</TpaId>
        <VerboseMode>boolean</VerboseMode>
      </getEmployeeRequest>
    </GetEmployee>
  </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>
    <GetEmployeeResponse_2008_07 xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Response/2007/12/">
      <GetEmployeeResult>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <BankAccount>string</BankAccount>
        <BankAccountTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Checking or Savings or GeneralLedger</BankAccountTypeCode>
        <BankRoutingNumber>string</BankRoutingNumber>
        <BirthDate>string</BirthDate>
        <City>string</City>
        <Country>string</Country>
        <EmailAddress>string</EmailAddress>
        <EmployeeSocialSecurityNumber>string</EmployeeSocialSecurityNumber>
        <EmployeeId>string</EmployeeId>
        <EmployeeStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">All or New or Active or TempInactive or PermInactive or Terminated or Enrollment</EmployeeStatus>
        <EmployerId>string</EmployerId>
        <FirstName>string</FirstName>
        <Gender xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Male or Female</Gender>
        <LastName>string</LastName>
        <EmployeeMaritalStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">None or Single or Married or Separated or Widowed or Divorced</EmployeeMaritalStatus>
        <MiddleInitial>string</MiddleInitial>
        <NamePrefix>string</NamePrefix>
        <Phone>string</Phone>
        <ReimbursementCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Undefined or None or Check or DirectDeposit or ExternalCheck or ExternalDirectDeposit or Card or Payroll</ReimbursementCode>
        <Remarks>string</Remarks>
        <ShippingAddress1>string</ShippingAddress1>
        <ShippingAddress2>string</ShippingAddress2>
        <ShippingCity>string</ShippingCity>
        <ShippingCountry>string</ShippingCountry>
        <ShippingState>string</ShippingState>
        <ShippingZipCode>string</ShippingZipCode>
        <State>string</State>
        <TpaId>string</TpaId>
        <UserDefinedField>string</UserDefinedField>
        <ZipCode>string</ZipCode>
        <CardDesignId>string</CardDesignId>
        <EligibilityDate>string</EligibilityDate>
        <TerminationDate>string</TerminationDate>
      </GetEmployeeResult>
    </GetEmployeeResponse_2008_07>
  </soap12:Body>
</soap12:Envelope>