Employee API | Administrative - SOAP

The Employee Service provides clients employee functionalities such as reading, adding, updating, and deleting employees’ information.

Important Note: In order to facilitate backward compatibility with all Web Services in use prior to June 4, 2005, either Employee (Dependent) Social Security Number (previously used as unique employee/dependent Identifier) or Employee (Dependent) ID (new unique employee/dependent Identifier) may be provided when required to uniquely Identify an employee or dependent. If both are provided, the Employer (Dependent) ID is used as the unique Identifier. When adding or updating employee or dependent demographic information (specifically, the “True” Social Security Number field), the following rules apply:

If only the Employee (Dependent) ID is provided, it is used as the unique Identifier, and the “True” SSN field is not added or updated.
If only the Employee (Dependent) Social Security Number is provided, it is used as the unique Identifier, and the “True” SSN field is not added or updated.
If both the Employee (Dependent) ID and the Employee (Dependent) Social Security Number are provided, the Employee (Dependent) ID is used as the unique Identifier and the Employee (Dependent) Social Security Number is used to add or update the “True” SSN.

Service Web Methods

The following is a list of methods that are provided by the Employee Service.

AddEmployee – used to add an employee’s demographic information and to check routing.
DeleteEmployee – used to remove information about an employee.
GetEmployee – used to retrieve an employee’s demographic information and to check routing.
UpdateEmployee – used to update an employee’s demographic information and to check routing.
SearchEmployees - used to retrieve an employee's demographic information and to check routing.
UpdateEmployeeHumanResourceInfo – used for updating an employee’s non-discriminatory information.
GetEmployeeHumanResourceInfo – used for retrieving an employee’s non-discriminatory information.
AddEmployeeInteraction - This method is used to add new employee interactions.

Service Assumptions/Business Rules

The Employee Service makes the following assumptions as well as enforces the following business rules.

Clients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus Technologies and the administrator.
Clients shall format SOAP messages in a Document/Literal format over HTTPS.
Clients shall have already created a valid user ID and password.
Clients shall have a valid session ID after being authenticated by the system. The session ID needs to be passed in the proper manner as described in the Account Manager Service Guide.
If the administrator uses the same user ID and password for all of their clients, the administrator is responsible for managing the security of the data.
Clients should validate data before submitting a request to this Service. This facilitates better performance and accurate processing on both systems.
Clients shall not attempt to use this service for batch processing of large amounts of data. The service is designed for synchronous calls that send or retrieve small chunks of data. If batch processing is required, then the EDI process should be used.
If any method fails, the service returns a SOAP fault describing the problem.

AddEmployee

This method is used to add an employee’s demographic information and to check routing.

History

The AddEmployee methods are listed below:

Request Message

AddEmployee_2022_10
AddEmployee_2015_02
AddEmployee_2012_06
AddEmployee_2009_04
AddEmployee_2008_07
AddEmployee_2007_12
AddEmployeeRequest

Response Message

AddEmployeeResponse

AddEmployee Request/Response Messages

The AddEmployee method requires the following request and response messages (input and output data).

The table below includes the following request message:

AddEmployee_2009_04
AddEmployee_2008_07
AddEmployee_2007_12
AddEmployeeRequest

Request Body

Address1 String required

First line of the employee’s mailing address.

First Available Version: AddEmployeeRequest

Address2 String

Second line of the employee’s mailing address

First Available Version:	AddEmployeeRequest
Default Values:	`""`

BankAccount String conditionally required

Employee bank account number for direct deposit reimbursements. This field can be included in a direct deposit file exported from the system. Due to NACHA requirements, if using direct deposit do not enter a value greater than 17 characters.
Note: If ReimbursementCode is set to DirectDeposit than this field is required.

First Available Version:	AddEmployeeRequest
Default Values:	`""`

BankAccountTypeCode Enumeration

Possible values include:
0 = None
1 = Checking
2 = Savings
3 = General Ledger
Note: Cannot be None if ReimbursementCode is set to DirectDeposit

First Available Version:	AddEmployeeRequest
Default Values:	`None`

BankRoutingNumber String conditionally required

Employee's bank account routing number for direct deposit reimbursements. This field can be included in a direct deposit file exported from the system.
Note: If ReimbursementCode is set to DirectDeposit than this field is required.

First Available Version:	AddEmployeeRequest
Default Values:	`""`

BirthDate Date

Date of birth for the employee.
Note: Birth Date is not required for creating new employees, but is required prior to an employee enrolling in an HSA.

First Available Version: AddEmployeeRequest
City String required

City associated with employee’s address.

First Available Version: AddEmployeeRequest

Country String required

US is the only valid option. Please contact us if you intend to send to any international address.

First Available Version:	AddEmployeeRequest
Default Values:	`US`

EmailAddress String

Employee’s email address. Email addresses are automatically converted by WCA to all lowercase.

First Available Version: AddEmployeeRequest
EmployeeSocialSecurityNumber String

Employee’s social security number.
HSAs: In general, WCA requires SSN for employees is enrolled in an HSA account. Employee SSN is not required for creating new employees, but is required prior to an employee enrolling in an HSA.
Note: Validation logic prevents duplicate social security numbers from being entered within a family unit. For example, a dependent can't have the same SSN as the employee. Additionally, a dependent can't have the same SSN as another dependent.

First Available Version: AddEmployeeRequest
EmployeeId String required

Unique identifier for the employee

First Available Version: AddEmployeeRequest
EmployerId String required

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

First Available Version: AddEmployeeRequest
FirstName String required

Employee’s first name. Allowable characters are alphanumeric (a-z, A-Z, 0- 9), Special characters - comma (,), period (.), dash (-), ampersand (&), single apostrophe ('), and space ( ).

First Available Version: AddEmployeeRequest

Gender Enumeration

Employee’s gender. Valid values are:
0 = None
1 = Male
2 = Female

First Available Version:	AddEmployeeRequest
Default Values:	`None`

LastName String required

Employee’s last name. Allowable characters are alphanumeric (a-z, A-Z, 0-9), Special characters - comma (,), period (.), dash (-), ampersand (&), single apostrophe ('), and space ( ).

First Available Version: AddEmployeeRequest
Employee MaritalStatus Enumeration

The employee's marital status. Valid values are:
0 - None
1 - Single
2 - Married
3 - Separated
4 - Widowed
5 -Divorced

First Available Version: AddEmployeeRequest
MiddleInitial String

Employee’s middle initial name. Allowable characters are alphanumeric (a-z, A-Z, 0-9), Special characters - comma (,), period (.), dash (-), ampersand (&), single apostrophe ('), and space ( ).

First Available Version: AddEmployeeRequest

NamePrefix String

Title for employee, such as Mr., Mrs., Ms., Dr., or Rev

First Available Version:	AddEmployeeRequest
Default Values:	`""`

Phone String

Employee’s phone number including area code.

First Available Version:	AddEmployeeRequest
Default Values:	`""`

ReimbursementCode Enumeration

Sets the employee's default reimbursement method. Valid values are:
0 - None
1 - Check
2 - DirectDeposit
3 - ExternalCheck
4 - ExternalDirectDeposit
Note: Check printing normally occurs in the administrator’s application and not in WCA.

First Available Version:	AddEmployeeRequest
Default Values:	`None`

Remarks String

Any comments about the employee.
Note: This is field is for information only and is not used in any WCA processing.

First Available Version:	AddEmployeeRequest
Default Values:	`""`

ShippingAddress1 String

Address line 1 of the employee’s card shipping address if different from the mailing address. If included, than ShippingCity, ShippingState, ShippingZipCode, and ShippingCountry must also be included.

First Available Version:	AddEmployeeRequest
Default Values:	`""`

ShippingAddress2 String

Employee’s card shipping address if different from the mailing address

First Available Version:	AddEmployeeRequest
Default Values:	`""`

ShippingCity String conditionally required

Employee’s card shipping address if different from the mailing address. Required if the ShippingAddress1 field is included.

First Available Version:	AddEmployeeRequest
Default Values:	`""`

ShippingCountry String conditionally required

Employee’s card shipping address if different from the mailing address. US is valid option. Please contact us if you intend to send to any international address. Required if the ShippingAddress1 field is included.

First Available Version:	AddEmployeeRequest
Default Values:	`US`

ShippingState String conditionally required

Employee’s card shipping address if different from the mailing address. Use the appropriate 2 character state postal code associated with employee’s address. Please contact us if you intend to send to any international address. Required if the ShippingAddress1 field is included

First Available Version:	AddEmployeeRequest
Default Values:	`""`

ShippingZipCod String conditionally required

Employee’s card shipping address if different from the above address. Required if the ShippingAddress1 field is included

First Available Version:	AddEmployeeRequest
Default Values:	`""`

State String required

State code for the employee's mailing address. Use 2 character state or region postal code associated with employee’s address. Please contact us if you intend to send to any international address.

First Available Version: AddEmployeeRequest
TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.

First Available Version: AddEmployeeRequest

UserDefinedField String

Field defined by the administrator. This is not used by WCA

First Available Version:	AddEmployeeRequest
Default Values:	`""`

ZipCode String required

Zip code of the employee's mailing address

First Available Version:	AddEmployeeRequest
Default Values:	`""`

ProcessingNotes String

This field may be used to enter notes for claims processors

First Available Version:	AddEmployeeRequest
Default Values:	`Blank`

CardDesignId String

For future use. Card design will currently always be payment.

First Available Version:	AddEmployeeRequest_2007_12
Default Values:	`Payment`

EligibilityDate String

YYYYMMDD. Date upon which the employee is eligible to elect benefits.

First Available Version: AddEmployeeRequest_2008_07
TerminationDate String

YYYYMMDD. Date upon which the employee's account is no longer eligible for benefits. Date must be after dependent Account Effective date

First Available Version: AddEmployeeRequest_2008_07
DriverLicense String

The employee’s drivers license number.

First Available Version: AddEmployeeRequest_2009_04
MaidenName String

The employee's mother’s maiden name.

First Available Version: AddEmployeeRequest_2009_04
EmailCommunicationOptions String

This is a bit field - please refer to the bit field for help if needed.
0 will indicate opt-out for all messages.
256 = Manual Claim Entered
512 = Participant Shipping Address Change
1024 = Participant Email Address Change
2048 = Participant Direct Deposit Change
4096 = Participant Portal Password Change
8192 = Participant Billing Address Change
16384 = Card Mailed
32768 = Card Lost/Stolen
65535 = Card Transaction Denied
131072 = Account Balance Alert
262144 = Account Deductible Met
5242588 = Run Out Date Reminder
1048576 = Year-End Reminder
2097152 = Grace Period Reminder
8388608 = Balance Statement Alert
16777216 = User ID Change
67108864 = Participant Claim Entry
4294967296 = Deposit Received
8589934592 = HSA Online Statement
17179869184 = Enrollee Welcome Email
34359738368 = Email Communication Template
18014398509482000 = Completed HSA Payment

First Available Version: AddEmployeeRequest_2009_04
Field

36028797018964000 = Failed HSAPayment
72057594037927900 = Card Transaction Approved
144115188075856000 = Reimbursement Processed
576460752303423000 = Partner Welcome Email
1152921504606850000 = Partner Billing Address Change
2305843009213690000 = Partner Shipping Address Change
4611686018427390000 = Partner Employee Email Address Change
9223372036854780000 = Partner Password Change
18446744073709600000 = Partner User ID Change
36893488147419100000 = Partner HSA Online Statement
73786976294838200000 = Partner Deposit Received
147573952589676000000 = Partner External Account Updated
295147905179353000000 = Partner Email Communication Template
590295810358706000000 = Partner IRS Contribution Limit
1180591620717410000000 = Partner Account Closed
2361183241434820000000 = Partner Account Re-Associated
4722366482869650000000 = Partner Online Enrollment
9444426721029150000000 = All Communications

First Available Version:
SmsCommunicationOptions String

This is a bit field - please refer to the bit field for help if needed.
0 will indicate opt-out for all messages.
256 = Manual Claim Entered
512 = Participant Shipping Address Change
1024 = Participant Email Address Change
2048 = Participant Direct Deposit Change
4096 = Participant Portal Password Change
8192 = Participant Billing Address Change
16384 = Card Mailed
32768 = Card Lost/Stolen
65535 = Card Transaction Denied
131072 = Account Balance Alert
262144 = Account Deductible Met
5242588 = Run Out Date Reminder
1048576 = Year-End Reminder
2097152 = Grace Period Reminder
8388608 = Balance Statement Alert
16777216 = User ID Change
67108864 = Participant Claim Entry
4294967296 = Deposit Received
8589934592 = HSA Online Statement
17179869184 = Enrollee Welcome Email
34359738368 = Email Communication Template
18014398509482000 = Completed HSA Payment

First Available Version: AddEmployeeRequest_2009_04
Field

36028797018964000 = Failed HSAPayment
72057594037927900 = Card Transaction Approved
144115188075856000 = Reimbursement Processed
576460752303423000 = Partner Welcome Email
1152921504606850000 = Partner Billing Address Change
2305843009213690000 = Partner Shipping Address Change
4611686018427390000 = Partner Employee Email Address Change
9223372036854780000 = Partner Password Change
18446744073709600000 = Partner User ID Change
36893488147419100000 = Partner HSA Online Statement
73786976294838200000 = Partner Deposit Received
147573952589676000000 = Partner External Account Updated
295147905179353000000 = Partner Email Communication Template
590295810358706000000 = Partner IRS Contribution Limit
1180591620717410000000 = Partner Account Closed
2361183241434820000000 = Partner Account Re-Associated
4722366482869650000000 = Partner Online Enrollment
9444426721029150000000 = All Communications

First Available Version:

BankAcctName String

Employee’s Direct Deposit Bank Account Name.

First Available Version:	AddEmployeeRequest_2012_06
Default Values:	`Blank`

EmployeeMarketplaceGUID String

Used to identify the participant on the WealthCare Marketplace platform.

First Available Version:	AddEmployeeRequest_2014_10
Default Values:	`Blank`

HealthPlanId String

An assigned ID for the employee’s health plan. Note: You can use this field for TPS matching but cannot use it to search for an employee.

First Available Version:	AddEmployeeRequest_2014_10
Default Values:	`Blank`

PbmId String

An assigned ID for the pharmacy benefits management (PBM) organization handling pharmaceutical benefits for employees. Note: You can use this field for TPS matching but cannot use it to search for an employee.

First Available Version:	AddEmployeeRequest_2014_10
Default Values:	`Blank`

AlternateID String

The employee’s Alternate ID

First Available Version:	AddEmployeeRequest_2015_02
Default Values:	`Blank`

MobileNum String

Employee’s mobile phone number, including area code.

First Available Version:	AddEmployeeRequest_2010_04
Default Values:	`Blank`

UserDefinedField2 String

Field defined by administrator. WealthCare Admin does not use the field.

First Available Version: AddEmployeeRequest_2018_10
UserDefinedField3 String

Field defined by administrator. WealthCare Admin does not use the field.

First Available Version: AddEmployeeRequest_2018_10
UserDefinedField4 String

Field defined by administrator. WealthCare Admin does not use the field.

First Available Version: AddEmployeeRequest_2018_10
UserDefinedField5 String

Field defined by administrator. WealthCare Admin does not use the field.

First Available Version: AddEmployeeRequest_2018_10
UserDefinedField6 String

Field defined by administrator. WealthCare Admin does not use the field.

First Available Version: AddEmployeeRequest_2018_10
UserDefinedField7 String

Field defined by administrator. WealthCare Admin does not use the field.

First Available Version: AddEmployeeRequest_2018_10
UserDefinedField8 String

Field defined by administrator. WealthCare Admin does not use the field.

First Available Version: AddEmployeeRequest_2018_10
UserDefinedField9 String

Field defined by administrator. WealthCare Admin does not use the field.

First Available Version: AddEmployeeRequest_2018_10
UserDefinedField10 String

Field defined by administrator. WealthCare Admin does not use the field.

First Available Version: AddEmployeeRequest_2018_10
DisableOnlineRepayment Boolean

Indicates if online repayments should be disabled for the employee
False/0 – Online repayments are available for this employee
True/1 – Online repayment is disabled for this employee

First Available Version: AddEmployeeRequest_2019_02

ValidateEmployeeAccount Short

If a direct deposit account is being added, use this field to indicate if you want micro-deposit validation to trigger. The micro-deposit validation will only occur if your administrator has this feature enabled. If the feature is not enabled or if this is not sent/sent as false, the employee bank account will be available immediately for use.
0 – False, do not validate (default)
1 – True, validate

First Available Version:	AddEmployeeRequest_2022_10
Default Values:	`0`

Example of an AddEmployee SOAP request message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>jhcppu45zzo00y45cqi03r55</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <AddEmployee xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Request/2004/06/">
            <addEmployeeRequest>
                <Address1>123 EasternGirls St</Address1>
                <BankAccount>123456</BankAccount>
                <BankAccountTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Checking</BankAccountTypeCode>
                <BankRoutingNumber>123456789</BankRoutingNumber>
                <BirthDate>1945-01-01</BirthDate>
                <City>WesternWorld</City>
                <EmailAddress />
                <EmployeeSocialSecurityNumber>444555666</EmployeeSocialSecurityNumber>
                <EmployerId>EASE10</EmployerId>
                <FirstName>Pet</FirstName>
                <Gender xmlns="http://www.medibank.com/MBIWebServices/Enums/">Male</Gender>
                <LastName>Shop</LastName>
                <EmployeeMaritalStatus
                    xmlns="http://www.medibank.com/MBIWebServices/Enums/">Divorced</EmployeeMaritalStatus>
                    <MiddleInitial />
                    <NamePrefix>Mr.</NamePrefix>
                    <Phone />
                    <ReimbursementCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Check</ReimbursementCode>
                    <Remarks>This is a test</Remarks>
                    <ShippingCountry />
                    <State>MA</State>
                    <TpaId>T00209</TpaId>
                    <ZipCode>12345</ZipCode>
                </addEmployeeRequest>
            </AddEmployee>
        </soap:Body>
    </soap:Envelope>

Example of an AddEmployee SOAP response message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
    </soap:Header>
    <soap:Body>
        <AddEmployeeResponse
            xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Response/2004/06/">
            <AddEmployeeResult />
        </AddEmployeeResponse>
    </soap:Body>
</soap:Envelope>

Example Client Code

The following is an example of the client code (using a .NET proxy class for accessing the service) using the AddEmployee web method.

try
{
    // Create the session SOAP header in order to pass the Account Service
    // the client’s current session ID.
    mbiSessionHeader = new EmployeeServiceNameSpace.MBISessionHeader();
    // Create proxy object for the Employee service
    proxy = new EmployeeServiceNameSpace.EmployeeService();
    // Create request message for method call (input parameters)
    request = new EmployeeServiceNameSpace.AddEmployeeRequest();
    // Set the input parameters
    request.Address1 = _address1.Text;
    request.Address2 = _address2.Text;
    request.BankAccount = _bankAccount.Text;
    request.BankAccountTypeCode = (EmployeeServiceNameSpace.BankAccountType)
    _bankAccountTypeCode.SelectedItem;
    request.BankRoutingNumber = _bankRoutingNumber.Text;
    if(_birthDate.Text.Length > 0)
    {
        request.BirthDate = Convert.ToDateTime(_birthDate.Text);
    }
    request.City = _city.Text;
    request.Country = _country.Text;
    request.EmailAddress = _email.Text;
    request.EmployeeMaritalStatus = (EmployeeServiceNameSpace.MaritalStatus)
    _maritalStatus.SelectedItem;
    request.EmployeeSocialSecurityNumber = _empeSSN.Text;
    request.EmployerId = _emprId.Text;
    request.FirstName = _firstName.Text;
    request.Gender = (EmployeeServiceNameSpace.Gender)_gender.SelectedItem;
    request.LastName = _lastName.Text;
    request.MiddleInitial = _initial.Text;
    request.NamePrefix = _namePrefix.Text;
    request.Phone = _phone.Text;
    request.ReimbursementCode = (EmployeeServiceNameSpace.ReimbursementMethod)
    _reimbursementCode.SelectedItem;
    request.Remarks = _remarks.Text;
    request.ShippingAddress1 = _shippingAddress1.Text;
    request.ShippingAddress2 = _shippingAddress2.Text;
    request.ShippingCity = _shippingCity.Text;
    request.ShippingCountry = _shippingCountry.Text;
    request.ShippingState = _shippingState.Text;
    request.ShippingZipCode = _shippingZip.Text;
    request.State = _state.Text;
    request.TpaId = _tpaId.Text;
    request.UserDefinedField = _userDefinedField.Text;
    request.ZipCode = _zipCode.Text;
    // session ID returned from login method
    mbiSessionHeader.MBISessionID = _sessionId.Text;
    proxy.MBISessionHeaderValue = mbiSessionHeader;
    // Call the method
    response = proxy.AddEmployee(request);
    MessageBox.Show("Finished.");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

DeleteEmployee

This method is used to delete information about an employee from the system.

History

The DeleteEmployee methods are listed below:

Request Message

DeleteEmployeeRequest

Response Message

DeleteEmployeeResponse

DeleteEmployee Request/Response Messages

The DeleteEmployee method requires the following request and response messages (input and output data).

The table below includes the following request message:

DeleteEmployeeRequest

Request Body

EmployeeSocialSecurityNumber String conditionally required

Employee’s social security number. Required if this field is being used as the unique employee Identifier - either this field or EmployeeID may be used for this purpose.

First Available Version: DeleteEmployeeRequest
EmployeeId String conditionally required

Employee ID. Required if this field is being used as the unique employee Identifier - either this field or EmployeeSocialSecurityNumber may be used for this purpose.

First Available Version: DeleteEmployeeRequest
EmployerId String required

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

First Available Version: DeleteEmployeeRequest
TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up. If not sent, the service will use the TpaID associated with the username making the request.

First Available Version: DeleteEmployeeRequest

Response Message: Empty Message

Example of a DeleteEmployee SOAP request message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>jhcppu45zzo00y45cqi03r55</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <DeleteEmployee xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Request/2004/06/">
            <deleteEmployeeRequest>
                <EmployeeSocialSecurityNumber>444555666</EmployeeSocialSecurityNumber>
                <EmployerId>EASE10</EmployerId>
                <TpaId>T00209</TpaId>
            </deleteEmployeeRequest>
        </DeleteEmployee>
    </soap:Body>
</soap:Envelope>

Example of a DeleteEmployee SOAP response message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
    </soap:Header>
    <soap:Body>
        <DeleteEmployeeResponse
            xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Response/2004/06/"> <DeleteEmployeeResult />
    </DeleteEmployeeResponse>
</soap:Body>
</soap:Envelope>

Example Client Code

The following is an example of the client code (using a .NET proxy class to connect with the service) used when calling the DeleteEmployee method.

try
{
    // Create the session SOAP header in order to pass the Account Service
    // the client’s current session ID.
    mbiSessionHeader = new EmployeeServiceNameSpace.MBISessionHeader();
    // Create proxy object for the Employee service
    proxy = new EmployeeServiceNameSpace.EmployeeService();
    // Create request message for method call (input parameters)
    request = new EmployeeServiceNameSpace.DeleteEmployeeRequest();
    // Set the input parameters
    request.EmployeeSocialSecurityNumber = _employeeSocialSecurityNumber.Text;
    request.EmployerId = _employerId.Text;
    request.TpaId = _tpaId.Text;
    // session ID returned from login method
    mbiSessionHeader.MBISessionID = _sessionId.Text;
    proxy.MBISessionHeaderValue = mbiSessionHeader;
    // Call the method
    response = proxy.DeleteEmployee(request);
    MessageBox.Show("Finished.");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

GetEmployee

This method is used to retrieve an employee’s demographic information and to check routing.

History

The GetEmployee methods are listed below:

Request Message

GetEmployeeRequest

Response Message

GetEmployeeResponse_2012_06
GetEmployeeResponse_2009_04
GetEmployeeResponse_2008_07
GetEmployeeResponse_2007_12
GetEmployeeResponse

GetEmployee Request/Response Messages

The GetEmployee method requires the following request and response messages (input and output data).

The table below includes the following request message:

GetEmployeeRequest

Request Body

EmployeeSocialSecurityNumber String conditionally required

Employee’s social security number. Required if this field is being used as the unique employee Identifier - either this field, EmployeeID, or CardNumber may be used for this purpose.

First Available Version: GetEmployeeRequest
EmployeeId String conditionally required

Employee ID. Required if this field is being used as the unique employee Identifier - either this field, EmployeeSocialSecurityNumber, or CardNumber may be used for this purpose.

First Available Version: GetEmployeeRequest
CardNumber String conditionally required

Employee’s card number. Required if this field is being used as the unique employee Identifier - either this field, EmployeeID, or EmployeeSocialSecurityNumber may be used for this purpose.

First Available Version: GetEmployeeRequest
EmployerId String

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

First Available Version: GetEmployeeRequest

TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up. If not sent, the service will use the TpaID associated with the username making the request.

First Available Version:	GetEmployeeRequest
Default Values:	`""`

VerboseMode Boolean

Optional, if set to true, the operation may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.

First Available Version:	GetEmployeeRequest
Default Values:	`FALSE`

The table below includes the following response message:

GetEmployeeResponse_2009_04
GetEmployeeResponse_2007_12
GetEmployeeResponse

Response Body

Address1 String

First line of the employee’s mailing address.

First Available Version: GetEmployeeResponse
Address2 String

Second line of the employee’s mailing address

First Available Version: GetEmployeeResponse
BankAccount String

Employee bank account number for direct deposit reimbursements. This field can be included in a direct deposit file exported from the system. Due to NACHA requirements, if using direct deposit do not enter a value greater than 17 characters.
Note: If ReimbursementCode is set to DirectDeposit than this field is required.

First Available Version: GetEmployeeResponse
BankAccountTypeCode Enumeration

Possible values include:
0 = None
1 = Checking
2 = Savings
3 = General Ledger
Note: Cannot be None if ReimbursementCode is set to DirectDeposit

First Available Version: GetEmployeeResponse
BankRouting Number String

Employee's bank account routing number for direct deposit reimbursements. This field can be included in a direct deposit file exported from the system.
Note: If ReimbursementCode is set to DirectDeposit than this field is required.

First Available Version: GetEmployeeResponse
BirthDate String

Date of birth for the employee.
Note: Birth Date is not required for creating new employees, but is required prior to an employee enrolling in an HSA.

First Available Version: GetEmployeeResponse
City String

City associated with employee’s address.

First Available Version: GetEmployeeResponse
Country String

US is the only valid option. Please contact us if you intend to send to any international address.

First Available Version: GetEmployeeResponse
EmailAddress String

Employee’s email address. Email addresses are automatically converted by WCA to all lowercase.

First Available Version: GetEmployeeResponse
EmployeeSocialSecurityNumber String

Employee’s social security number.
HSAs: In general, WCA requires SSN for employees is enrolled in an HSA account. Employee SSN is not required for creating new employees, but is required prior to an employee enrolling in an HSA.
Note: Validation logic prevents duplicate social security numbers from being entered within a family unit. For example, a dependent can't have the same SSN as the employee. Additionally, a dependent can't have the same SSN as another dependent.

First Available Version: GetEmployeeResponse
EmployeeId String

Unique identifier for the employee

First Available Version: GetEmployeeResponse
EmployeeStatus Enumeration

Status of the employee. Valid values are:
1 - New
2 - Active
3 - TempInactive
4 - PermInactive
5 - Terminated

First Available Version: GetEmployeeResponse
EmployerId String

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

First Available Version: GetEmployeeResponse
FirstName String

Employee’s first name

First Available Version: GetEmployeeResponse
Gender Enumeration

Employee’s gender. Valid values are:
0 = None
1 = Male
2 = Female

First Available Version: GetEmployeeResponse
LastName String

Employee’s last name

First Available Version: GetEmployeeResponse
EmployeeMaritalStatus Enumeration

The employee's marital status. Valid values are:
0 - None
1 - Single
2 - Married
3 - Separated
4 - Widowed
5 -Divorced

First Available Version: GetEmployeeResponse
MiddleInitial String

Employee’s middle initial name.

First Available Version: GetEmployeeResponse
NamePrefix String

Title for employee, such as Mr., Mrs., Ms., Dr., or Rev

First Available Version: GetEmployeeResponse
Phone String

Employee’s phone number including area code.

First Available Version: GetEmployeeResponse
MobileNum String

Employee's mobile phone number, including area code

First Available Version: GetEmployeeResponse
ReimbursementCode Enumeration

Sets the employee's default reimbursement method. Valid values are:
0 - None
1 - Check
2 - DirectDeposit
3 - ExternalCheck
4 - ExternalDirectDeposit
Note: Check printing normally occurs in the administrator’s application and not in WCA.

First Available Version: GetEmployeeResponse
Remarks String

Any comments about the employee.
Note: This is field is for information only and is not used in any WCA processing.

First Available Version: GetEmployeeResponse
Shipping Address1 String

Address line 1 of the employee’s card shipping address if different from the mailing address.

First Available Version: GetEmployeeResponse
Shipping Address2 String

Employee’s card shipping address if different from the mailing address

First Available Version: GetEmployeeResponse
ShippingCity String

Employee’s card shipping address if different from the mailing address.

First Available Version: GetEmployeeResponse
Shipping Country String

Employee’s card shipping address if different from the mailing address

First Available Version: GetEmployeeResponse
ShippingState String

Employee’s card shipping address if different from the mailing address.

First Available Version: GetEmployeeResponse
Shipping ZipCode String

Employee’s card shipping address if different from the above address.

First Available Version: GetEmployeeResponse
State String

State code for the employee's mailing address.

First Available Version: GetEmployeeResponse
TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

First Available Version: GetEmployeeResponse
UserDefined Field String

Field defined by administrator user. Not used by WCA

First Available Version: GetEmployeeResponse
ZipCode String

Zip code associated with the employee's mailing address

First Available Version: GetEmployeeResponse
CardDesignId String

Future use only. Only valid value today is "Payment"

First Available Version: GetEmployeeResponse_2007_12
EligibilityDate String

Date upon which the employee is eligible to elect benefits.

First Available Version: GetEmployeeResponse_2008_07
TerminationDate String

Date upon which the employee's account is no longer eligible for benefits. Date must be after Account Effective date.

First Available Version: GetEmployeeResponse_2008_07
DriverLicense String

The employee’s drivers license number

First Available Version: GetEmployeeResponse_2009_04
MaidenName String

The employee mother’s maiden name

First Available Version: GetEmployeeResponse_2009_04
EmailCommunicationOptions String

This field indicates the email messages the participant is opted into. This is a bit field - please refer to the bit field for help if needed.
0 will indicate opt-out for all messages.
256 = Manual Claim Entered
512 = Participant Shipping Address Change
1024 = Participant Email Address Change
2048 = Participant Direct Deposit Change
4096 = Participant Portal Password Change
8192 = Participant Billing Address Change
16384 = Card Mailed
32768 = Card Lost/Stolen
65535 = Card Transaction Denied
131072 = Account Balance Alert
262144 = Account Deductible Met
5242588 = Run Out Date Reminder
1048576 = Year-End Reminder
2097152 = Grace Period Reminder
8388608 = Balance Statement Alert
16777216 = User ID Change
67108864 = Participant Claim Entry
4294967296 = Deposit Received
8589934592 = HSA Online Statement
17179869184 = Enrollee Welcome Email
34359738368 = Email Communication Template
18014398509482000 = Completed HSA Payment
36028797018964000 = Failed HSAPayment

First Available Version: GetEmployeeResponse_2009_04
Field

72057594037927900 = Card Transaction Approved
144115188075856000 = Reimbursement Processed
576460752303423000 = Partner Welcome Email
1152921504606850000 = Partner Billing Address Change
2305843009213690000 = Partner Shipping Address Change
4611686018427390000 = Partner Employee Email Address Change
9223372036854780000 = Partner Password Change
18446744073709600000 = Partner User ID Change
36893488147419100000 = Partner HSA Online Statement
73786976294838200000 = Partner Deposit Received
147573952589676000000 = Partner External Account Updated
295147905179353000000 = Partner Email Communication Template
590295810358706000000 = Partner IRS Contribution Limit
1180591620717410000000 = Partner Account Closed
2361183241434820000000 = Partner Account Re-Associated
4722366482869650000000 = Partner Online Enrollment
9444426721029150000000 = All Communications

First Available Version:
SmsCommunicationOptions String

This fiend indicates the mobile messages the participant is opted into. This is a bit field - please refer to the bit field for help if needed.
0 will indicate opt-out for all messages.
256 = Manual Claim Entered
512 = Participant Shipping Address Change
1024 = Participant Email Address Change
2048 = Participant Direct Deposit Change
4096 = Participant Portal Password Change
8192 = Participant Billing Address Change
16384 = Card Mailed
32768 = Card Lost/Stolen
65535 = Card Transaction Denied
131072 = Account Balance Alert
262144 = Account Deductible Met
5242588 = Run Out Date Reminder
1048576 = Year-End Reminder
2097152 = Grace Period Reminder
8388608 = Balance Statement Alert
16777216 = User ID Change
67108864 = Participant Claim Entry
4294967296 = Deposit Received
8589934592 = HSA Online Statement
17179869184 = Enrollee Welcome Email
34359738368 = Email Communication Template
18014398509482000 = Completed HSA Payment
36028797018964000 = Failed HSAPayment

First Available Version: GetEmployeeResponse_2009_04
Field

72057594037927900 = Card Transaction Approved
144115188075856000 = Reimbursement Processed
576460752303423000 = Partner Welcome Email
1152921504606850000 = Partner Billing Address Change
2305843009213690000 = Partner Shipping Address Change
4611686018427390000 = Partner Employee Email Address Change
9223372036854780000 = Partner Password Change
18446744073709600000 = Partner User ID Change
36893488147419100000 = Partner HSA Online Statement
73786976294838200000 = Partner Deposit Received
147573952589676000000 = Partner External Account Updated
295147905179353000000 = Partner Email Communication Template
590295810358706000000 = Partner IRS Contribution Limit
1180591620717410000000 = Partner Account Closed
2361183241434820000000 = Partner Account Re-Associated
4722366482869650000000 = Partner Online Enrollment
9444426721029150000000 = All Communications

First Available Version:
ProcessingNotes String

Notes entered for the employee to be used by claims processors

First Available Version: GetEmployeeResponse
BankAcctName String

Direct Deposit Bank Account Name

First Available Version: GetEmployeeResponse_2012_06
EmployeeMarketplaceGUID String

Used to identify the participant on the WealthCare Marketplace platform.

First Available Version: GetEmployeeResponse_2013_06
HealthPlanId String

An assigned ID for the employee’s health plan. Note: You can use this field for TPS matching but cannot use it to search for an employee.

First Available Version: GetEmployeeResponse_2013_06
PbmId String

An assigned ID for the pharmacy benefits management (PBM) organization handling pharmaceutical benefits for employees. Note: You can use this field for TPS matching but cannot use it to search for an employee.

First Available Version: GetEmployeeResponse_2014_10
AlternateId String

The employee’s Alternate ID

First Available Version: GetEmployeeResponse_2015_02
UserDefinedField2 String

Field defined by administrator. Not used by WCA.

First Available Version: GetEmployeeResponse_2018_10
UserDefinedField3 String

Field defined by administrator. Not used by WCA.

First Available Version: GetEmployeeResponse_2018_10
UserDefinedField4 String

Field defined by administrator. Not used by WCA.

First Available Version: GetEmployeeResponse_2018_10
UserDefinedField5 String

Field defined by administrator. Not used by WCA.

First Available Version: GetEmployeeResponse_2018_10
UserDefinedField6 String

Field defined by administrator. Not used by WCA.

First Available Version: GetEmployeeResponse_2018_10
UserDefinedField7 String

Field defined by administrator. Not used by WCA.

First Available Version: GetEmployeeResponse_2018_10
UserDefinedField8 String

Field defined by administrator. Not used by WCA.

First Available Version: GetEmployeeResponse_2018_10
UserDefinedField9 String

Field defined by administrator. Not used by WCA.

First Available Version: GetEmployeeResponse_2018_10
UserDefinedField10 String

Field defined by administrator. Not used by WCA.

First Available Version: GetEmployeeResponse_2018_10
IsOnlineRepaymentDisabled Boolean

Indicates if online repayments are disabled for the employee
False/0 – Online repayments are available for this employee
True/1 – Online repayment is disabled for this employee

First Available Version: GetEmployeeResponse_2019_02
CarrierName String

The name of the employee’s medical insurance carrier.

First Available Version: GetEmployeeResponse_2019_07
MedicalDeductible Decimal

The annual deductible for this employee’s medical insurance

First Available Version: GetEmployeeResponse_2019_07
MedicalDeductiblePTD Decimal

The amount the employee has paid toward his deductible in the current plan year.

First Available Version: GetEmployeeResponse_2019_07

Example of a GetEmployee SOAP request message

<soapenv:Envelope xmlns:soapenv=http://schemas.xmlsoap.org/soap/envelope/ xmlns:mbi=http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers xmlns:v1=http://bensoft.metavante.com/WebServices/Contracts/Employee/2010/04/V1 xmlns:ns=http://bensoft.metavante.com/WebServices/Messages/Employee/Request/2010/04/>
<soapenv:Header>
    <mbiSessionHeader>
        <!--Optional:-->
        <mbi:MBISessionID>xckprvmlfekgxfzwttwiwxn3</mbi:MBISessionID>
    </mbiSessionHeader>
</soapenv:Header>
<soapenv:Body>
    <v1:GetEmployee>
        <!--Optional:-->
        <v1:request xsi:type="ns39:GetEmployeeRequest_2019_07" xmlns:ns717=http://bensoft.metavante.com/WebServices/Messages/Employee/Request/2019/02/ xmlns:ns20=http://bensoft.metavante.com/WebServices/Messages/Employee/Request/2015/10/ xmlns:ns680=http://bensoft.metavante.com/WebServices/Messages/Employee/Request/2015/02/ xmlns:ns619=http://bensoft.metavante.com/WebServices/Messages/Employee/Request/2014/10/ xmlns:ns790=http://bensoft.metavante.com/WebServices/Messages/Employee/Request/2012/06/ xmlns:ns122=http://bensoft.metavante.com/WebServices/Messages/Employee/Request/2013/06/ xmlns:ns39=http://bensoft.metavante.com/WebServices/Messages/Employee/Request/2019/07/ xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance>
            <!--Optional:-->
            <ns:EmployeeId>?</ns:EmployeeId>
            <!--Optional:-->
            <ns:EmployeeSocialSecurityNumber>?</ns:EmployeeSocialSecurityNumber>
            <!--Optional:-->
            <ns:EmployerId>AREMPLOYER</ns:EmployerId>
            <!--Optional:-->
            <ns:TpaId>T02528</ns:TpaId>
            <!--Optional:-->
            <ns:VerboseMode>?</ns:VerboseMode>
            <!--Optional:-->
            <ns122:CardNumber>?</ns122:CardNumber>
            <!--Optional:-->
            <ns619:EmployeeMarketplaceGUID>?</ns619:EmployeeMarketplaceGUID>
        </v1:request>
    </v1:GetEmployee>
</soapenv:Body>
</soapenv:Envelope>

Example of a GetEmployee SOAP response message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
    </soap:Header>
    <soap:Body>
        <GetEmployeeResponse
            xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Response/2004/06/">
            <GetEmployeeResult>
                <Address1>123 EasternGirls St</Address1>
                <Address2 />
                <BankAccount>123456</BankAccount>
                <BankAccountTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Checking</BankAccountTypeCode>
                <BankRoutingNumber>123456789</BankRoutingNumber>
                <BirthDate>19450101</BirthDate>
                <City>WesternWorld</City>
                <Country>US</Country>
                <EmailAddress />
                <EmployeeSocialSecurityNumber>444555666</EmployeeSocialSecurityNumber>
                <EmployeeStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">New</EmployeeStatus>
                <EmployerId>EASE10</EmployerId>
                <FirstName>Pet</FirstName>
                <Gender xmlns="http://www.medibank.com/MBIWebServices/Enums/">Male</Gender>
                <LastName>Shop</LastName>
                <EmployeeMaritalStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">Divorced</EmployeeMaritalStatus>
                <MiddleInitial />
                <NamePrefix>Mr.</NamePrefix>
                <Phone />
                <ReimbursementCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Check</ReimbursementCode>
                <Remarks>This is a test</Remarks>
                <ShippingAddress1 />
                <ShippingAddress2 />
                <ShippingCity />
                <ShippingCountry />
                <ShippingState />
                <ShippingZipCode />
                <State>MA</State>
                <TpaId>T00209</TpaId>
                <UserDefinedField />
                <ZipCode>12345</ZipCode>
            </GetEmployeeResult>
        </GetEmployeeResponse>
    </soap:Body>
</soap:Envelope>

Example Client Code

The following is an example of the client code (using a .NET proxy class to connect to the service) used when calling the GetEmployee method.

try
{
    _dataset.Tables["Employees"].Clear();
    // Create the session SOAP header in order to pass the Account Service
    // the client’s current session ID.
    mbiSessionHeader = new EmployeeServiceNameSpace.MBISessionHeader();
    // Create proxy object for the Employee service
    proxy = new EmployeeServiceNameSpace.EmployeeService();
    // Create request message for method call (input parameters)
    request = new EmployeeServiceNameSpace.GetEmployeeRequest();
    // Set the input parameters
    request.EmployeeSocialSecurityNumber = _employeeSocialSecurityNumber.Text;
    request.EmployerId = _employerId.Text;
    request.TpaId = _tpaId.Text;
    request.VerboseMode = Convert.ToBoolean(_verboseMode.Text);
    // session ID returned from logon method
    mbiSessionHeader.MBISessionID = _sessionId.Text;
    proxy.MBISessionHeaderValue = mbiSessionHeader;
    response = proxy.GetEmployee(request);
    if(response != null)
    {
        _dataset.Tables["Employees"].Rows.Add(new string[]
        {
            response.Address1,
                response.Address2,
                response.BankAccount,
                response.BankAccountTypeCode.ToString(),
                response.BankRoutingNumber,
                response.BirthDate,
                response.City,
                response.Country,
                response.EmailAddress,
                response.EmployeeMaritalStatus.ToString(),
                response.EmployeeSocialSecurityNumber,
                response.EmployeeStatus.ToString(),
                response.EmployerId,
                response.FirstName,
                response.Gender.ToString(),
                response.LastName,
                response.MiddleInitial,
                response.NamePrefix,
                response.Phone,
                response.ReimbursementCode.ToString(),
                response.Remarks,
                response.ShippingAddress1,
                response.ShippingAddress2,
                response.ShippingCity,
                response.ShippingCountry,
                response.ShippingState,
                response.ShippingZipCode,
                response.State,
                response.TpaId,
                response.UserDefinedField,
                response.ZipCode
        });
    }
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

UpdateEmployee

This method is used to update an employee’s demographic information and to check routing.

History

The UpdateEmployee methods are listed below:

Request Message

UpdateEmployee_2022_10
UpdateEmployee_2012_06
UpdateEmployee_2009_04
UpdateEmployee_2008_07
UpdateEmployee_2007_12
UpdateEmployeeRequest

Response Message

UpdateEmployeeResponse

UpdateEmployee Request/Response Messages

The UpdateEmployee method requires the following request and response messages (input and output data).

The table below includes the following request message:

UpdateEmployee_2022_10
UpdateEmployee_2012_06
UpdateEmployee_2009_04
UpdateEmployee_2008_07
UpdateEmployee_2007_12
UpdateEmployeeRequest

Request Body

Address1 String required

First line of the employee’s mailing address.

First Available Version: UpdateEmployeeRequest

Address2 String

Second line of the employee’s mailing address

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

BankAccount String

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

BankAccountTypeCode Enumeration

Possible values include:
0 = None
1 = Checking
2 = Savings
3 = General Ledger
Note: Cannot be None if ReimbursementCode is set to DirectDeposit

First Available Version:	UpdateEmployeeRequest
Default Values:	`None`

BankRoutingNumber String

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

BirthDate Date

Date of birth for the employee.
Note: Birth Date is not required for creating new employees, but is required prior to an employee enrolling in an HSA.

First Available Version: UpdateEmployeeRequest
City String required

City associated with employee’s address.

First Available Version: UpdateEmployeeRequest
Country String required

US is the only valid option. Please contact us if you intend to send to any international address.

First Available Version: UpdateEmployeeRequest
CurrentEmployeeSocialSecurityNumber String conditionally required

Employee’s current social security number. Required if this field is being used as the uniue employee identifier. Either this field or EmployeeId may be used for this purpose. This field is not used to update the employee's social security number - use NewEmployeeSocialSecurityNumber to make updates to SSN.

First Available Version: UpdateEmployeeRequest
EmployeeId String conditionally required

Employee’s current Employee ID. Required if this field is being used as the uniue employee identifier. Either this field or CurrentEmployeeSocialSecurityNumber may be used for this purpose. This field is not used to update the employee's ID - use NewEmployeeId to make updates to the employee ID.

First Available Version: UpdateEmployeeRequest

EmailAddress String

Employee’s email address. Email addresses are automatically converted by WCA to all lowercase.

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

EmployeeMaritalStatus Enumeration

The employee's marital status. Valid values are:
0 - None
1 - Single
2 - Married
3 - Separated
4 - Widowed
5 -Divorced

First Available Version:	UpdateEmployeeRequest
Default Values:	`None`

EmployeeStatus Enumeration

Status of the employee. Valid values are:
1 - New
2 - Active
3 - TempInactive
4 - PermInactive
5 - Terminated

First Available Version:	UpdateEmployeeRequest
Default Values:	`New`

EmployerId String required

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

First Available Version: UpdateEmployeeRequest
FirstName String required

Employee’s first name. Allowable characters are alphanumeric (a-z, A-Z, 0-9), Special characters - comma (,), period (.), dash (-), ampersand (&), single apostrophe ('), and space ( ).

First Available Version: UpdateEmployeeRequest

Gender Enumeration

The employee's gender. Valid values are:
0 - None
1 - Male
2 - Female

First Available Version:	UpdateEmployeeRequest
Default Values:	`None`

LastName String required

Employee’s last name. Allowable characters are alphanumeric (a-z, A-Z, 0-9), Special characters - comma (,), period (.), dash (-), ampersand (&), single apostrophe ('), and space ( ).

First Available Version: UpdateEmployeeRequest
MiddleInitial String

Employee’s middle initial name. Allowable characters are alphanumeric (a-z, A-Z, 0-9), Special characters - comma (,), period (.), dash (-), ampersand (&), single apostrophe ('), and space ( ).

First Available Version: UpdateEmployeeRequest
NamePrefix String

Title for the employee, such as Mr., Mrs., Dr., Rev, etc

First Available Version: UpdateEmployeeRequest

NewEmployeeId String

Employee’s new employee ID, used as a unique identifier for the employee

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

NewEmployeeSocialSecurityNumber String

Employee’s new social security number. Leave empty unless the employee’s SSN needs to be replaced.

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

Phone String

Employee’s phone number including area code.

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

ReimbursementCode Enumeration

Sets the employee's default reimbursement method. Valid values are:
0 - None
1 - Check
2 - DirectDeposit
3 - ExternalCheck
4 - ExternalDirectDeposit
Note 1: Check printing normally occurs in the administrator’s application and not in WCA. This typically should be set to None.
Note 2: If no value is passed (blank/null), or this field is not supplied in the request; the employee’s reimbursement method is not changed.

First Available Version: UpdateEmployeeRequest

Remarks String

Any comments about the employee.
Note: This is field is for information only and is not used in any WCA processing.

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

ShippingAddress String

Address line 1 of the employee’s card shipping address if different from the mailing address.

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

ShippingAddress2 String

Employee’s card shipping address line 2 if different from the mailing address

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

ShippingCity String conditionally required

Employee’s card shipping address city if different from the mailing address.

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

ShippingCountry String conditionally required

Employee’s card shipping address country code if different from the mailing address

First Available Version:	UpdateEmployeeRequest
Default Values:	`US`

ShippingState String conditionally required

Employee’s card shipping address state code, if different from the mailing address.

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

ShippingZipCode String conditionally required

Employee’s card shipping address zip code if different from the above address.

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

State String required

State code for the employee's mailing address.

First Available Version: UpdateEmployeeRequest
TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

First Available Version: UpdateEmployeeRequest

UserDefinedField String

Field defined by administrator user. Not used by WCA

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

ZipCode String required

Zip code of the employee's mailing address

First Available Version:	UpdateEmployeeRequest
Default Values:	`""`

ProcessingNotes String

This field may be used to enter notes for claims processors

First Available Version:	UpdateEmployeeRequest
Default Values:	`Blank`

CardDesignId String

For future use. Card design will currently always be payment.

First Available Version:	UpdateEmployeeRequest_2007_12
Default Values:	`Payment`

EligibilityDate String

YYYYMMDD. Date upon which the employee is eligible to elect benefits.

First Available Version: UpdateEmployeeRequest_2008_07
TerminationDate String

YYYYMMDD. Date upon which the employee's account is no longer eligible for benefits. Date must be after dependent Account Effective date

First Available Version: UpdateEmployeeRequest_2008_07
DriverLicense String

The employee’s drivers license number.

First Available Version: UpdateEmployeeRequest_2009_04
MaidenName String

The employee's mother’s maiden name.

First Available Version: UpdateEmployeeRequest_2009_04
EmailCommunicationOptions String

This is a bit field - please refer to the bit field for help if needed.
0 will indicate opt-out for all messages.
256 = Manual Claim Entered
512 = Participant Shipping Address Change
1024 = Participant Email Address Change
2048 = Participant Direct Deposit Change
4096 = Participant Portal Password Change
8192 = Participant Billing Address Change
16384 = Card Mailed
32768 = Card Lost/Stolen
65535 = Card Transaction Denied
131072 = Account Balance Alert
262144 = Account Deductible Met
5242588 = Run Out Date Reminder
1048576 = Year-End Reminder
2097152 = Grace Period Reminder
8388608 = Balance Statement Alert
16777216 = User ID Change
67108864 = Participant Claim Entry
4294967296 = Deposit Received
8589934592 = HSA Online Statement
17179869184 = Enrollee Welcome Email
34359738368 = Email Communication Template
18014398509482000 = Completed HSA Payment
36028797018964000 = Failed HSAPayment

First Available Version: UpdateEmployeeRequest_2009_04
Field

72057594037927900 = Card Transaction Approved
144115188075856000 = Reimbursement Processed
576460752303423000 = Partner Welcome Email
1152921504606850000 = Partner Billing Address Change
2305843009213690000 = Partner Shipping Address Change
4611686018427390000 = Partner Employee Email Address Change
9223372036854780000 = Partner Password Change
18446744073709600000 = Partner User ID Change
36893488147419100000 = Partner HSA Online Statement
73786976294838200000 = Partner Deposit Received
147573952589676000000 = Partner External Account Updated
295147905179353000000 = Partner Email Communication Template
590295810358706000000 = Partner IRS Contribution Limit
1180591620717410000000 = Partner Account Closed
2361183241434820000000 = Partner Account Re-Associated
4722366482869650000000 = Partner Online Enrollment
9444426721029150000000 = All Communications

First Available Version:
SMSCommunicationOptions String

This is a bit field - please refer to the bit field for help if needed.
0 will indicate opt-out for all messages.
256 = Manual Claim Entered
512 = Participant Shipping Address Change
1024 = Participant Email Address Change
2048 = Participant Direct Deposit Change
4096 = Participant Portal Password Change
8192 = Participant Billing Address Change
16384 = Card Mailed
32768 = Card Lost/Stolen
65535 = Card Transaction Denied
131072 = Account Balance Alert
262144 = Account Deductible Met
5242588 = Run Out Date Reminder
1048576 = Year-End Reminder
2097152 = Grace Period Reminder
8388608 = Balance Statement Alert
16777216 = User ID Change
67108864 = Participant Claim Entry
4294967296 = Deposit Received
8589934592 = HSA Online Statement
17179869184 = Enrollee Welcome Email
34359738368 = Email Communication Template
18014398509482000 = Completed HSA Payment
36028797018964000 = Failed HSAPayment

First Available Version: UpdateEmployeeRequest_2009_04
Field

72057594037927900 = Card Transaction Approved
144115188075856000 = Reimbursement Processed
576460752303423000 = Partner Welcome Email
1152921504606850000 = Partner Billing Address Change
2305843009213690000 = Partner Shipping Address Change
4611686018427390000 = Partner Employee Email Address Change
9223372036854780000 = Partner Password Change
18446744073709600000 = Partner User ID Change
36893488147419100000 = Partner HSA Online Statement
73786976294838200000 = Partner Deposit Received
147573952589676000000 = Partner External Account Updated
295147905179353000000 = Partner Email Communication Template
590295810358706000000 = Partner IRS Contribution Limit
1180591620717410000000 = Partner Account Closed
2361183241434820000000 = Partner Account Re-Associated
4722366482869650000000 = Partner Online Enrollment
9444426721029150000000 = All Communications

First Available Version:

BankAcctName String

Employee’s Direct Deposit Bank Account Name.

First Available Version:	UpdateEmployeeRequest_2012_06
Default Values:	`Blank`

HealthPlanId String

An assigned ID for the employee’s health plan. Note: You can use this field for TPS matching but cannot use it to search for an employee.

First Available Version:	UpdateEmployeeRequest_2014_10
Default Values:	`Blank`

PbmId String

First Available Version:	UpdateEmployeeRequest_2014_10
Default Values:	`Blank`

AlternateID String

The employee’s Alternate ID

First Available Version:	UpdateEmployeeRequest_2015_02
Default Values:	`Blank`

MobileNum String

Employee’s mobile phone number, including area code.

First Available Version:	UpdateEmployeeRequest_2010_04
Default Values:	`Blank`

UserDefinedField2 String

Field defined by administrator. Not used by WCA.

First Available Version: UpdateEmployeeRequest_2018_10
UserDefinedField3 String

Field defined by administrator. Not used by WCA.

First Available Version: UpdateEmployeeRequest_2018_10
UserDefinedField4 String

Field defined by administrator. Not used by WCA.

First Available Version: UpdateEmployeeRequest_2018_10
UserDefinedField5 String

Field defined by administrator. Not used by WCA.

First Available Version: UpdateEmployeeRequest_2018_10
UserDefinedField6 String

Field defined by administrator. Not used by WCA.

First Available Version: UpdateEmployeeRequest_2018_10
UserDefinedField7 String

Field defined by administrator. Not used by WCA.

First Available Version: UpdateEmployeeRequest_2018_10
UserDefinedField8 String

Field defined by administrator. Not used by WCA.

First Available Version: UpdateEmployeeRequest_2018_10
UserDefinedField9 String

Field defined by administrator. Not used by WCA.

First Available Version: UpdateEmployeeRequest_2018_10
UserDefinedField10 String

Field defined by administrator. Not used by WCA.

First Available Version: UpdateEmployeeRequest_2018_10

NoOverwrite Boolean

Indicates whether blank/null values in optional fields are ignored.
True - blank fields on this request are ignored; data stays as is in WCA
False - blank/null values in optional fields update the corresponding fields – effectively erasing and overwriting current data in WCA.
This option applies to the following optional fields:
Address2
BankAccount
BankAccountTypeCode
BankRoutingNumber
EmployeeMaritalStatus
Gender
MiddleInitial
NamePrefix
Phone
MobileNumber
EmailAddress
BirthDate
Remarks
ProcessingNotes
ShippingAddress1
ShippingAddress2
ShippingCity
ShippingCountry
ShippingState
ShippingZipCode

First Available Version:	UpdateEmployeeRequest_2018_10
Default Values:	`FALSE`

DisableOnlineRepayment Boolean

Indicates if online repayments should be disabled for the employee
False/0 – Online repayments are available for this employee
True/1 – Online repayment is disabled for this employee

First Available Version: UpdateEmployeeRequest_2019_02
CarrierName String

The name of the employee’s medical insurance carrier.

First Available Version: UpdateEmployeeRequest_2019_07
MedicalDeductible Decimal

The annual deductible for this employee’s medical insurance

First Available Version: UpdateEmployeeRequest_2019_07
MedicalDeductiblePTD Decimal

The amount the employee has paid toward his deductible in the current plan year.

First Available Version: UpdateEmployeeRequest_2019_07

ValidateEmployeeAccount Short

First Available Version:	UpdateEmployeeRequest_2022_10
Default Values:	`0`

Response Message: Empty Message Example of a UpdateEmployee SOAP request message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>jhcppu45zzo00y45cqi03r55</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <UpdateEmployee xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Request/2004/06/">
            <updateEmployeeRequest>
                <Address1>123 Water</Address1>
                <BankAccount>123455</BankAccount>
                <BankAccountTypeCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Savings</BankAccountTypeCode>
                <BankRoutingNumber>123456789</BankRoutingNumber>
                <BirthDate>1976-01-01</BirthDate>
                <City>World</City>
                <CurrentEmployeeSocialSecurityNumber>444555666</CurrentEmployeeSocialSecurityNumber>
                <EmailAddress />
                <EmployeeMaritalStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">Divorced</EmployeeMaritalStatus>
                <EmployeeStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">Active</EmployeeStatus>
                <EmployerId>EASE10</EmployerId>
                <FirstName>Movie</FirstName>
                <Gender xmlns="http://www.medibank.com/MBIWebServices/Enums/">None</Gender>
                <LastName>Doe</LastName>
                <MiddleInitial />
                <NamePrefix>Mr.</NamePrefix>
                <Phone />
                <ReimbursementCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Check</ReimbursementCode>
                <Remarks>This is a test</Remarks>
                <ShippingCountry />
                <State>MA</State>
                <TpaId>T00209</TpaId>
                <ZipCode>34567</ZipCode>
            </updateEmployeeRequest>
        </UpdateEmployee>
    </soap:Body>
</soap:Envelope>

Example of an UpdateEmployee SOAP response message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
    </soap:Header>
    <soap:Body>
        <UpdateEmployeeResponse
            xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Response/2004/06/">
            <UpdateEmployeeResult />
        </UpdateEmployeeResponse>
    </soap:Body>
</soap:Envelope>

Example Client Code

The following is an example of the client code (using a .NET proxy class for the service) used when calling the UpdateEmployee method.

try
{
    // Create the session SOAP header in order to pass the Account Service
    // the client’s current session ID.
    mbiSessionHeader = new EmployeeServiceNameSpace.MBISessionHeader();
    // Create proxy object for the Employee service
    proxy = new EmployeeServiceNameSpace.EmployeeService();
    // Create request message for method call (input parameters)
    request = new EmployeeServiceNameSpace.UpdateEmployeeRequest();
    // Set the input parameters
    request.Address1 = _address1.Text;
    request.Address2 = _address2.Text;
    request.BankAccount = _bankAccount.Text;
    request.BankAccountTypeCode = (EmployeeServiceNameSpace.BankAccountType)
    _bankAccountTypeCode.SelectedItem;
    request.BankRoutingNumber = _bankRoutingNumber.Text;
    if(_birthDate.Text.Length > 0)
    {
        request.BirthDate = Convert.ToDateTime(_birthDate.Text);
    }
    request.City = _city.Text;
    request.Country=_country.Text;
    request.CurrentEmployeeSocialSecurityNumber = _empeCurrentSSN.Text;
    request.EmailAddress = _email.Text;
    request.EmployeeMaritalStatus = (EmployeeServiceNameSpace.MaritalStatus)
    _maritalStatus.SelectedItem;
    request.EmployeeStatus = (EmployeeServiceNameSpace.CardholderStatus)
    _empeStatus.SelectedItem;
    request.EmployerId = _emprId.Text;
    request.FirstName = _firstName.Text;
    request.Gender = (EmployeeServiceNameSpace.Gender)_gender.SelectedItem;
    request.LastName = _lastName.Text;
    request.MiddleInitial = _initial.Text;
    request.NamePrefix = _namePrefix.Text;
    request.NewEmployeeSocialSecurityNumber = _empeNewSSN.Text;
    request.Phone = _phone.Text;
    request.ReimbursementCode = (EmployeeServiceNameSpace.ReimbursementMethod)
    _reimbursementCode.SelectedItem;
    request.Remarks = _remarks.Text;
    request.ShippingAddress1 = _shippingAddress1.Text;
    request.ShippingAddress2 = _shippingAddress2.Text;
    request.ShippingCity = _shippingCity.Text;
    request.ShippingCountry = _shippingCountry.Text;
    request.ShippingState = _shippingState.Text;
    request.ShippingZipCode = _shippingZip.Text;
    request.State = _state.Text;
    request.TpaId = _tpaId.Text;
    request.UserDefinedField = _userDefinedField.Text;
    request.ZipCode = _zipCode.Text;
    // session ID returned from login method
    mbiSessionHeader.MBISessionID = _sessionId.Text;
    proxy.MBISessionHeaderValue = mbiSessionHeader;
    // Call the method
    response = proxy.UpdateEmployee(request);
    MessageBox.Show("Finished.");
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

SearchEmployee

This method is used to search for employee information.

History

The SearchEmployees methods are listed below:

Request Message

SearchEmployeesRequest

Response Message

SearchEmployeesResponse

SearchEmployees Request/Response Messages

The SearchEmployees method requires the following request and response messages (input and output data).

The table below includes the following request message:

SearchEmployeesRequest

Request Body

EmployeeSocialSecurityNumber String conditionally required

Employee’s social security number. At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request.

First Available Version:	SearchEmployeesRequest
Default Values:	`""`

EmployeeId String conditionally required

Employee ID. At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request.

First Available Version:	SearchEmployeesRequest
Default Values:	`""`

FirstName String conditionally required

First name of the employee.At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request.

First Available Version:	SearchEmployeesRequest
Default Values:	`""`

LastName String conditionally required

Last Name of the employee. At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request.

First Available Version:	SearchEmployeesRequest
Default Values:	`""`

CardNumber String conditionally required

Card Number. At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request.

First Available Version:	SearchEmployeesRequest
Default Values:	`""`

EmployerId String required

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

First Available Version: SearchEmployeesRequest

TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up. If this is not on the request, the TPA ID of the user ID making the request will be used.

First Available Version:	SearchEmployeesRequest
Default Values:	`"'`

VerboseMode Boolean

Optional, if set to true, the operation may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.

First Available Version:	SearchEmployeesRequest
Default Values:	`FALSE`

PageIndex Integer

Page number for paginated result set.
The maximum number of records per request/page is 100. You must submit a separate request for each page you wish to return. By making multiple requests, you can retrieve an unlimited number of records.

First Available Version:	SearchEmployeesRequest_2018_08
Default Values:	`1`

The table below includes the following response message:

SearchEmployeesResponse

Response Body

EmployeeSocialSecurityNumber String

Employee’s social security number

First Available Version: SearchEmployeesResponse
EmployeeId String

EmployeeId

First Available Version: SearchEmployeesResponse
EmployeeStatus Enumeration

The employee's status. Valid values are:
1 - New
2 - Active
3 - TempInactive
4 - PermInactive
5 - Terminated

First Available Version: SearchEmployeesResponse
EmployerId String

Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

First Available Version: SearchEmployeesResponse
FirstName String

Employee’s first name

First Available Version: SearchEmployeesResponse
Gender Enumeration

The employee's gender. Valid values are:
0 - None
1 - Male
2 - Female

First Available Version: SearchEmployeesResponse
LastName String

Employee’s last name

First Available Version: SearchEmployeesResponse
EmployeeMaritalStatus Enumeration

The employee's marital status. Valid values are:
0 - None
1 - Single
2 - Married
3 - Separated
4 - Widowed
5 - Divorced

First Available Version: SearchEmployeesResponse
MiddleInitial String

Employee’s middle initial

First Available Version: SearchEmployeesResponse
NamePrefix String

Title of the employee, such as Mr., Mrs., Dr., Rev, etc

First Available Version: SearchEmployeesResponse
TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

First Available Version: SearchEmployeesResponse
AlternateID String

The employee’s Alternate ID

First Available Version: SearchEmployeesResponse
CarrierName String

The name of the employee’s medical insurance carrier.

First Available Version: SearchEmployeesResponse_2019_07
MedicalDeductible Decimal

The annual deductible for this employee’s medical insurance

First Available Version: SearchEmployeesResponse_2019_07
MedicalDeductiblePTD Decimal

The amount the employee has paid toward his deductible in the current plan year.

First Available Version: SearchEmployeesResponse_2019_07

Example of a SearchEmployees SOAP request message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
            <MBISessionID>jhcppu45zzo00y45cqi03r55</MBISessionID>
        </MBISessionHeader>
    </soap:Header>
    <soap:Body>
        <SearchEmployees xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Request/2004/06/"> <searchEmployeesRequest>
        <EmployeeSocialSecurityNumber>444555666</EmployeeSocialSecurityNumber>
        <EmployerId>EASE10</EmployerId>
        <iId>T00209</TpaId>
    </searchEmployeesRequest>
</SearchEmployees>
</soap:Body>
</soap:Envelope>

Example of a SearchEmployees SOAP response message

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Header>
        <MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
    </soap:Header>
    <soap:Body>
        <SearchEmployeesResponse xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Response/2004/06/">
            <SearchEmployeesResult>
                <EmployeeSocialSecurityNumber>123981312</EmployeeSocialSecurityNumber>
                <EmployeeId>XXX999</EmployeeId>
                <EmployeeStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">New</EmployeeStatus>
                <EmployerId>EASE10</EmployerId>
                <FirstName>Pet</FirstName>
                <Gender xmlns="http://www.medibank.com/MBIWebServices/Enums/">Male</Gender>
                <LastName>Shop</LastName>
                <EmployeeMaritalStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">Divorced</EmployeeMaritalStatus>
                <MiddleInitial />
                <NamePrefix>Mr.</NamePrefix>
                <TpaId>T00209</TpaId>
            </SearchEmployeesResult>
        </SearchEmployeesResponse>
    </soap:Body>
</soap:Envelope>

Example Client Code

The following is an example of the client code (using a .NET proxy class to connect to the service) used when calling the SearchEmployees method.

try
{
    _dataset.Tables["Employees"].Clear();
    // Create the session SOAP header in order to pass the Account Service
    // the client’s current session ID.
    mbiSessionHeader = new EmployeeServiceNameSpace.MBISessionHeader();
    // Create proxy object for the Employee service
    proxy = new EmployeeServiceNameSpace.EmployeeService();
    // Create request message for method call (input parameters)
    request = new EmployeeServiceNameSpace.SearchEmployeesRequest();
    // Set the input parameters
    request.EmployeeSocialSecurityNumber = _employeeSocialSecurityNumber.Text;  request.EmployerId = _employerId.Text;
    request.TpaId = _tpaId.Text;
    request.VerboseMode = Convert.ToBoolean(_verboseMode.Text);
    // session ID returned from logon method
    mbiSessionHeader.MBISessionID = _sessionId.Text;
    proxy.MBISessionHeaderValue = mbiSessionHeader;
    response = proxy.SearchEmployees(request);
    if(response != null)
    {
        _dataset.Tables["Employees"].Rows.Add(new string[]
        {
            response.EmployeeMaritalStatus.ToString(),
                response.EmployeeSocialSecurityNumber,
                response.EmployeeStatus.ToString(),
                response.EmployeeId.ToString(),
                response.EmployerId,
                response.FirstName,
                response.Gender.ToString(),
                response.LastName,
                response.MiddleInitial,
                response.NamePrefix,
                response.TpaId
        });
    }
}
catch(SoapException se)
{
    // perform needed operations
}
catch(Exception ex)
{
    // perform needed operations
}

UpdateEmployeeHumanResourceInfo

This method is used to add an employee’s non-discriminatory information.

History

The UpdateEmployeeHumanResourceInfo methods are listed below:

Request Message

UpdateEmployeeHumanResourceInfoRequest

Response Message

UpdateEmployeeHumanResourceInfoResponse Request/Response Messages The UpdateEmployeeHumanResourceInfo method requires the following request and response messages (input and output data). The table below includes the following request message:

UpdateEmployeeHumanResourceInfoRequest

Request Body

TpaId String

A unique identifer for your administrator instance, generated by WCA when the instance was first set up. If this is not

First Available Version: