The Employee Service provides clients employee functionalities such as reading, adding, updating, and deleting employees’ information.
- 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.
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.
The Employee Service makes the following assumptions as well as enforces the following business rules.
- 9 TClients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus Technologies and the 9 T 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:
- AddEmployee_2022_10
- AddEmployee_2015_02
- AddEmployee_2012_06
- AddEmployee_2009_04
- AddEmployee_2008_07
- AddEmployee_2007_12
- AddEmployeeRequest
- AddEmployeeResponse
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
- Address1StringrequiredFirst line of the employee’s mailing address.
First Available Version: AddEmployeeRequest - Address2StringSecond line of the employee’s mailing address
First Available Version: AddEmployeeRequest Default Values: ""
- BankAccountStringconditionally requiredEmployee 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: ""
- BankAccountTypeCodeEnumerationPossible values include:
0 = None
1 = Checking
2 = Savings
3 = General Ledger
Note: Cannot be None if ReimbursementCode is set to DirectDepositFirst Available Version: AddEmployeeRequest Default Values: None
- BankRoutingNumberStringconditionally requiredEmployee'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: ""
- BirthDateDateDate 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 - CityStringrequiredCity associated with employee’s address.
First Available Version: AddEmployeeRequest - CountryStringrequiredUS is the only valid option. Please contact us if you intend to send to any international address.
First Available Version: AddEmployeeRequest Default Values: US
- EmailAddressStringEmployee’s email address. Email addresses are automatically converted by WCA to all lowercase.
First Available Version: AddEmployeeRequest - EmployeeSocialSecurityNumberStringEmployee’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 - EmployeeIdStringrequiredUnique identifier for the employee
First Available Version: AddEmployeeRequest - EmployerIdStringrequiredUnique 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 - FirstNameStringrequiredEmployee’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 - GenderEnumerationEmployee’s gender. Valid values are:
0 = None
1 = Male
2 = FemaleFirst Available Version: AddEmployeeRequest Default Values: None
- LastNameStringrequiredEmployee’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 MaritalStatusEnumerationThe employee's marital status. Valid values are:
0 - None
1 - Single
2 - Married
3 - Separated
4 - Widowed
5 -DivorcedFirst Available Version: AddEmployeeRequest - MiddleInitialStringEmployee’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 - NamePrefixStringTitle for employee, such as Mr., Mrs., Ms., Dr., or Rev
First Available Version: AddEmployeeRequest Default Values: ""
- PhoneStringEmployee’s phone number including area code.
First Available Version: AddEmployeeRequest Default Values: ""
- ReimbursementCodeEnumerationSets 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
- RemarksString
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: ""
- ShippingAddress1StringAddress 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: ""
- ShippingAddress2StringEmployee’s card shipping address if different from the mailing address
First Available Version: AddEmployeeRequest Default Values: ""
- ShippingCityStringconditionally requiredEmployee’s card shipping address if different from the mailing address. Required if the ShippingAddress1 field is included.
First Available Version: AddEmployeeRequest Default Values: ""
- ShippingCountryStringconditionally requiredEmployee’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
- ShippingStateStringconditionally requiredEmployee’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: ""
- ShippingZipCodStringconditionally requiredEmployee’s card shipping address if different from the above address. Required if the ShippingAddress1 field is included
First Available Version: AddEmployeeRequest Default Values: ""
- StateStringrequiredState 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 - TpaIdStringA 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 - UserDefinedFieldStringField defined by the administrator. This is not used by WCA
First Available Version: AddEmployeeRequest Default Values: ""
- ZipCodeStringrequiredZip code of the employee's mailing address
First Available Version: AddEmployeeRequest Default Values: ""
- ProcessingNotesStringThis field may be used to enter notes for claims processors
First Available Version: AddEmployeeRequest Default Values: Blank
- CardDesignIdStringFor future use. Card design will currently always be payment.
First Available Version: AddEmployeeRequest_2007_12 Default Values: Payment
- EligibilityDateStringYYYYMMDD. Date upon which the employee is eligible to elect benefits.
First Available Version: AddEmployeeRequest_2008_07 - TerminationDateStringYYYYMMDD. 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 - DriverLicenseStringThe employee’s drivers license number.
First Available Version: AddEmployeeRequest_2009_04 - MaidenNameStringThe employee's mother’s maiden name.
First Available Version: AddEmployeeRequest_2009_04 - EmailCommunicationOptionsStringThis 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 PaymentFirst Available Version: AddEmployeeRequest_2009_04 - 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 CommunicationsFirst Available Version: - SmsCommunicationOptionsStringThis 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 PaymentFirst Available Version: AddEmployeeRequest_2009_04 - 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 CommunicationsFirst Available Version: - BankAcctNameStringEmployee’s Direct Deposit Bank Account Name.
First Available Version: AddEmployeeRequest_2012_06 Default Values: Blank
- EmployeeMarketplaceGUIDStringUsed to identify the participant on the WealthCare Marketplace platform.
First Available Version: AddEmployeeRequest_2014_10 Default Values: Blank
- HealthPlanIdStringAn 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
- PbmIdString
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
- AlternateIDStringThe employee’s Alternate ID
First Available Version: AddEmployeeRequest_2015_02 Default Values: Blank
- MobileNumStringEmployee’s mobile phone number, including area code.
First Available Version: AddEmployeeRequest_2010_04 Default Values: Blank
- UserDefinedField2StringField defined by administrator. WealthCare Admin does not use the field.
First Available Version: AddEmployeeRequest_2018_10 - UserDefinedField3StringField defined by administrator. WealthCare Admin does not use the field.
First Available Version: AddEmployeeRequest_2018_10 - UserDefinedField4StringField defined by administrator. WealthCare Admin does not use the field.
First Available Version: AddEmployeeRequest_2018_10 - UserDefinedField5StringField defined by administrator. WealthCare Admin does not use the field.
First Available Version: AddEmployeeRequest_2018_10 - UserDefinedField6StringField defined by administrator. WealthCare Admin does not use the field.
First Available Version: AddEmployeeRequest_2018_10 - UserDefinedField7StringField defined by administrator. WealthCare Admin does not use the field.
First Available Version: AddEmployeeRequest_2018_10 - UserDefinedField8StringField defined by administrator. WealthCare Admin does not use the field.
First Available Version: AddEmployeeRequest_2018_10 - UserDefinedField9StringField defined by administrator. WealthCare Admin does not use the field.
First Available Version: AddEmployeeRequest_2018_10 - UserDefinedField10StringField defined by administrator. WealthCare Admin does not use the field.
First Available Version: AddEmployeeRequest_2018_10 - DisableOnlineRepaymentBooleanIndicates 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 employeeFirst Available Version: AddEmployeeRequest_2019_02 - ValidateEmployeeAccountShortIf 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, validateFirst 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:
- DeleteEmployeeRequest
- DeleteEmployeeResponse
The DeleteEmployee method requires the following request and response messages (input and output data). The table below includes the following request message:
- DeleteEmployeeRequest
- EmployeeSocialSecurityNumberStringconditionally requiredEmployee’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 - EmployeeIdStringconditionally requiredEmployee 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 - EmployerIdStringrequiredUnique 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 - TpaIdStringA 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:
- GetEmployeeRequest
- GetEmployeeResponse_2012_06
- GetEmployeeResponse_2009_04
- GetEmployeeResponse_2008_07
- GetEmployeeResponse_2007_12
- GetEmployeeResponse
The GetEmployee method requires the following request and response messages (input and output data). The table below includes the following request message:
- GetEmployeeRequest
- EmployeeSocialSecurityNumberStringconditionally requiredEmployee’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 - EmployeeIdStringconditionally requiredEmployee 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 - CardNumberStringconditionally requiredEmployee’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 - EmployerIdStringUnique 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 - TpaIdStringA 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: ""
- VerboseModeBooleanOptional, 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
- GetEmployeeResponse_2009_04
- GetEmployeeResponse_2007_12
- GetEmployeeResponse
- Address1StringFirst line of the employee’s mailing address.
First Available Version: GetEmployeeResponse - Address2StringSecond line of the employee’s mailing address
First Available Version: GetEmployeeResponse - BankAccountStringEmployee 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 - BankAccountTypeCodeEnumerationPossible values include:
0 = None
1 = Checking
2 = Savings
3 = General Ledger
Note: Cannot be None if ReimbursementCode is set to DirectDepositFirst Available Version: GetEmployeeResponse - BankRouting NumberStringEmployee'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 - BirthDateStringDate 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 - CityStringCity associated with employee’s address.
First Available Version: GetEmployeeResponse - CountryStringUS is the only valid option. Please contact us if you intend to send to any international address.
First Available Version: GetEmployeeResponse - EmailAddressStringEmployee’s email address. Email addresses are automatically converted by WCA to all lowercase.
First Available Version: GetEmployeeResponse - EmployeeSocialSecurityNumberStringEmployee’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 - EmployeeIdStringUnique identifier for the employee
First Available Version: GetEmployeeResponse - EmployeeStatusEnumerationStatus of the employee. Valid values are:
1 - New
2 - Active
3 - TempInactive
4 - PermInactive
5 - TerminatedFirst Available Version: GetEmployeeResponse - EmployerIdStringUnique 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 - FirstNameStringEmployee’s first name
First Available Version: GetEmployeeResponse - GenderEnumerationEmployee’s gender. Valid values are:
0 = None
1 = Male
2 = FemaleFirst Available Version: GetEmployeeResponse - LastNameStringEmployee’s last name
First Available Version: GetEmployeeResponse - EmployeeMaritalStatusEnumerationThe employee's marital status. Valid values are:
0 - None
1 - Single
2 - Married
3 - Separated
4 - Widowed
5 -DivorcedFirst Available Version: GetEmployeeResponse - MiddleInitialStringEmployee’s middle initial name.
First Available Version: GetEmployeeResponse - NamePrefixStringTitle for employee, such as Mr., Mrs., Ms., Dr., or Rev
First Available Version: GetEmployeeResponse - PhoneStringEmployee’s phone number including area code.
First Available Version: GetEmployeeResponse - MobileNumStringEmployee's mobile phone number, including area code
First Available Version: GetEmployeeResponse - ReimbursementCodeEnumerationSets 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 - RemarksString
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 Address1StringAddress line 1 of the employee’s card shipping address if different from the mailing address.
First Available Version: GetEmployeeResponse - Shipping Address2StringEmployee’s card shipping address if different from the mailing address
First Available Version: GetEmployeeResponse - ShippingCityStringEmployee’s card shipping address if different from the mailing address.
First Available Version: GetEmployeeResponse - Shipping CountryStringEmployee’s card shipping address if different from the mailing address
First Available Version: GetEmployeeResponse - ShippingStateStringEmployee’s card shipping address if different from the mailing address.
First Available Version: GetEmployeeResponse - Shipping ZipCode StringEmployee’s card shipping address if different from the above address.
First Available Version: GetEmployeeResponse - StateStringState code for the employee's mailing address.
First Available Version: GetEmployeeResponse - TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up.
First Available Version: GetEmployeeResponse - UserDefined Field StringField defined by administrator user. Not used by WCA
First Available Version: GetEmployeeResponse - ZipCodeStringZip code associated with the employee's mailing address
First Available Version: GetEmployeeResponse - CardDesignIdStringFuture use only. Only valid value today is "Payment"
First Available Version: GetEmployeeResponse_2007_12 - EligibilityDateStringDate upon which the employee is eligible to elect benefits.
First Available Version: GetEmployeeResponse_2008_07 - TerminationDateStringDate 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 - DriverLicenseStringThe employee’s drivers license number
First Available Version: GetEmployeeResponse_2009_04 - MaidenNameStringThe employee mother’s maiden name
First Available Version: GetEmployeeResponse_2009_04 - EmailCommunicationOptionsStringThis 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 HSAPaymentFirst Available Version: GetEmployeeResponse_2009_04 - 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 CommunicationsFirst Available Version: - SmsCommunicationOptionsStringThis 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 HSAPaymentFirst Available Version: GetEmployeeResponse_2009_04 - 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 CommunicationsFirst Available Version: - ProcessingNotesStringNotes entered for the employee to be used by claims processors
First Available Version: GetEmployeeResponse - BankAcctNameStringDirect Deposit Bank Account Name
First Available Version: GetEmployeeResponse_2012_06 - EmployeeMarketplaceGUIDStringUsed to identify the participant on the WealthCare Marketplace platform.
First Available Version: GetEmployeeResponse_2013_06 - HealthPlanIdStringAn 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 - PbmIdString
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 - AlternateIdStringThe employee’s Alternate ID
First Available Version: GetEmployeeResponse_2015_02 - UserDefinedField2StringField defined by administrator. Not used by WCA.
First Available Version: GetEmployeeResponse_2018_10 - UserDefinedField3StringField defined by administrator. Not used by WCA.
First Available Version: GetEmployeeResponse_2018_10 - UserDefinedField4StringField defined by administrator. Not used by WCA.
First Available Version: GetEmployeeResponse_2018_10 - UserDefinedField5StringField defined by administrator. Not used by WCA.
First Available Version: GetEmployeeResponse_2018_10 - UserDefinedField6StringField defined by administrator. Not used by WCA.
First Available Version: GetEmployeeResponse_2018_10 - UserDefinedField7StringField defined by administrator. Not used by WCA.
First Available Version: GetEmployeeResponse_2018_10 - UserDefinedField8StringField defined by administrator. Not used by WCA.
First Available Version: GetEmployeeResponse_2018_10 - UserDefinedField9StringField defined by administrator. Not used by WCA.
First Available Version: GetEmployeeResponse_2018_10 - UserDefinedField10StringField defined by administrator. Not used by WCA.
First Available Version: GetEmployeeResponse_2018_10 - IsOnlineRepaymentDisabledBooleanIndicates 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 employeeFirst Available Version: GetEmployeeResponse_2019_02 - CarrierNameStringThe name of the employee’s medical insurance carrier.
First Available Version: GetEmployeeResponse_2019_07 - MedicalDeductibleDecimalThe annual deductible for this employee’s medical insurance
First Available Version: GetEmployeeResponse_2019_07 - MedicalDeductiblePTDDecimalThe 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:
- UpdateEmployee_2022_10
- UpdateEmployee_2012_06
- UpdateEmployee_2009_04
- UpdateEmployee_2008_07
- UpdateEmployee_2007_12
- UpdateEmployeeRequest
- UpdateEmployeeResponse
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
- Address1StringrequiredFirst line of the employee’s mailing address.
First Available Version: UpdateEmployeeRequest - Address2StringSecond line of the employee’s mailing address
First Available Version: UpdateEmployeeRequest Default Values: ""
- BankAccountStringEmployee 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: UpdateEmployeeRequest Default Values: ""
- BankAccountTypeCodeEnumerationPossible values include:
0 = None
1 = Checking
2 = Savings
3 = General Ledger
Note: Cannot be None if ReimbursementCode is set to DirectDepositFirst Available Version: UpdateEmployeeRequest Default Values: None
- BankRoutingNumberStringEmployee'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: UpdateEmployeeRequest Default Values: ""
- BirthDateDateDate 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 - CityStringrequiredCity associated with employee’s address.
First Available Version: UpdateEmployeeRequest - CountryStringrequiredUS is the only valid option. Please contact us if you intend to send to any international address.
First Available Version: UpdateEmployeeRequest - CurrentEmployeeSocialSecurityNumberStringconditionally requiredEmployee’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 - EmployeeIdStringconditionally requiredEmployee’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 - EmailAddressStringEmployee’s email address. Email addresses are automatically converted by WCA to all lowercase.
First Available Version: UpdateEmployeeRequest Default Values: ""
- EmployeeMaritalStatusEnumerationThe employee's marital status. Valid values are:
0 - None
1 - Single
2 - Married
3 - Separated
4 - Widowed
5 -DivorcedFirst Available Version: UpdateEmployeeRequest Default Values: None
- EmployeeStatusEnumerationStatus of the employee. Valid values are:
1 - New
2 - Active
3 - TempInactive
4 - PermInactive
5 - TerminatedFirst Available Version: UpdateEmployeeRequest Default Values: New
- EmployerIdStringrequiredUnique 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 - FirstNameStringrequiredEmployee’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 - GenderEnumerationThe employee's gender. Valid values are:
0 - None
1 - Male
2 - FemaleFirst Available Version: UpdateEmployeeRequest Default Values: None
- LastNameStringrequiredEmployee’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 - MiddleInitialStringEmployee’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 - NamePrefixStringTitle for the employee, such as Mr., Mrs., Dr., Rev, etc
First Available Version: UpdateEmployeeRequest - NewEmployeeIdStringEmployee’s new employee ID, used as a unique identifier for the employee
First Available Version: UpdateEmployeeRequest Default Values: ""
- NewEmployeeSocialSecurityNumberStringEmployee’s new social security number. Leave empty unless the employee’s SSN needs to be replaced.
First Available Version: UpdateEmployeeRequest Default Values: ""
- PhoneStringEmployee’s phone number including area code.
First Available Version: UpdateEmployeeRequest Default Values: ""
- ReimbursementCodeEnumerationSets 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 - RemarksString
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: ""
- ShippingAddressStringAddress line 1 of the employee’s card shipping address if different from the mailing address.
First Available Version: UpdateEmployeeRequest Default Values: ""
- ShippingAddress2StringEmployee’s card shipping address line 2 if different from the mailing address
First Available Version: UpdateEmployeeRequest Default Values: ""
- ShippingCityStringconditionally requiredEmployee’s card shipping address city if different from the mailing address.
First Available Version: UpdateEmployeeRequest Default Values: ""
- ShippingCountryStringconditionally requiredEmployee’s card shipping address country code if different from the mailing address
First Available Version: UpdateEmployeeRequest Default Values: US
- ShippingStateStringconditionally requiredEmployee’s card shipping address state code, if different from the mailing address.
First Available Version: UpdateEmployeeRequest Default Values: ""
- ShippingZipCodeStringconditionally requiredEmployee’s card shipping address zip code if different from the above address.
First Available Version: UpdateEmployeeRequest Default Values: ""
- StateStringrequiredState code for the employee's mailing address.
First Available Version: UpdateEmployeeRequest - TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up.
First Available Version: UpdateEmployeeRequest - UserDefinedFieldStringField defined by administrator user. Not used by WCA
First Available Version: UpdateEmployeeRequest Default Values: ""
- ZipCodeStringrequiredZip code of the employee's mailing address
First Available Version: UpdateEmployeeRequest Default Values: ""
- ProcessingNotesStringThis field may be used to enter notes for claims processors
First Available Version: UpdateEmployeeRequest Default Values: Blank
- CardDesignIdStringFor future use. Card design will currently always be payment.
First Available Version: UpdateEmployeeRequest_2007_12 Default Values: Payment
- EligibilityDateStringYYYYMMDD. Date upon which the employee is eligible to elect benefits.
First Available Version: UpdateEmployeeRequest_2008_07 - TerminationDateStringYYYYMMDD. 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 - DriverLicenseStringThe employee’s drivers license number.
First Available Version: UpdateEmployeeRequest_2009_04 - MaidenNameStringThe employee's mother’s maiden name.
First Available Version: UpdateEmployeeRequest_2009_04 - EmailCommunicationOptionsStringThis 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 HSAPaymentFirst Available Version: UpdateEmployeeRequest_2009_04 - 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 CommunicationsFirst Available Version: - SMSCommunicationOptionsStringThis 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 HSAPaymentFirst Available Version: UpdateEmployeeRequest_2009_04 - 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 CommunicationsFirst Available Version: - BankAcctNameStringEmployee’s Direct Deposit Bank Account Name.
First Available Version: UpdateEmployeeRequest_2012_06 Default Values: Blank
- HealthPlanIdStringAn 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
- PbmIdStringAn 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: UpdateEmployeeRequest_2014_10 Default Values: Blank
- AlternateIDStringThe employee’s Alternate ID
First Available Version: UpdateEmployeeRequest_2015_02 Default Values: Blank
- MobileNumStringEmployee’s mobile phone number, including area code.
First Available Version: UpdateEmployeeRequest_2010_04 Default Values: Blank
- UserDefinedField2StringField defined by administrator. Not used by WCA.
First Available Version: UpdateEmployeeRequest_2018_10 - UserDefinedField3StringField defined by administrator. Not used by WCA.
First Available Version: UpdateEmployeeRequest_2018_10 - UserDefinedField4StringField defined by administrator. Not used by WCA.
First Available Version: UpdateEmployeeRequest_2018_10 - UserDefinedField5StringField defined by administrator. Not used by WCA.
First Available Version: UpdateEmployeeRequest_2018_10 - UserDefinedField6StringField defined by administrator. Not used by WCA.
First Available Version: UpdateEmployeeRequest_2018_10 - UserDefinedField7StringField defined by administrator. Not used by WCA.
First Available Version: UpdateEmployeeRequest_2018_10 - UserDefinedField8StringField defined by administrator. Not used by WCA.
First Available Version: UpdateEmployeeRequest_2018_10 - UserDefinedField9StringField defined by administrator. Not used by WCA.
First Available Version: UpdateEmployeeRequest_2018_10 - UserDefinedField10StringField defined by administrator. Not used by WCA.
First Available Version: UpdateEmployeeRequest_2018_10 - NoOverwriteBooleanIndicates 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
ShippingZipCodeFirst Available Version: UpdateEmployeeRequest_2018_10 Default Values: FALSE
- DisableOnlineRepaymentBooleanIndicates 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 employeeFirst Available Version: UpdateEmployeeRequest_2019_02 - CarrierNameStringThe name of the employee’s medical insurance carrier.
First Available Version: UpdateEmployeeRequest_2019_07 - MedicalDeductibleDecimalThe annual deductible for this employee’s medical insurance
First Available Version: UpdateEmployeeRequest_2019_07 - MedicalDeductiblePTDDecimalThe amount the employee has paid toward his deductible in the current plan year.
First Available Version: UpdateEmployeeRequest_2019_07 - ValidateEmployeeAccountShortIf 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, validateFirst 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:
- SearchEmployeesRequest
- SearchEmployeesResponse
The SearchEmployees method requires the following request and response messages (input and output data).
The table below includes the following request message:
- SearchEmployeesRequest
- EmployeeSocialSecurityNumberStringconditionally requiredEmployee’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: ""
- EmployeeIdStringconditionally requiredEmployee ID. At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request.
First Available Version: SearchEmployeesRequest Default Values: ""
- FirstNameStringconditionally requiredFirst 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: ""
- LastNameStringconditionally requiredLast 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: ""
- CardNumberStringconditionally requiredCard Number. At least one of EmployeeSocialSecurityNumber, EmployeeID, FirstName, LastName, or CardNumber must be included on the request.
First Available Version: SearchEmployeesRequest Default Values: ""
- EmployerIdStringrequiredUnique 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 - TpaIdStringA 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: "'
- VerboseModeBooleanOptional, 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
- PageIndexIntegerPage 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
- SearchEmployeesResponse
- EmployeeSocialSecurityNumberStringEmployee’s social security number
First Available Version: SearchEmployeesResponse - EmployeeIdStringEmployeeId
First Available Version: SearchEmployeesResponse - EmployeeStatusEnumerationThe employee's status. Valid values are:
1 - New
2 - Active
3 - TempInactive
4 - PermInactive
5 - TerminatedFirst Available Version: SearchEmployeesResponse - EmployerIdStringUnique 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 - FirstNameStringEmployee’s first name
First Available Version: SearchEmployeesResponse - GenderEnumerationThe employee's gender. Valid values are:
0 - None
1 - Male
2 - FemaleFirst Available Version: SearchEmployeesResponse - LastNameStringEmployee’s last name
First Available Version: SearchEmployeesResponse - EmployeeMaritalStatusEnumerationThe employee's marital status. Valid values are:
0 - None
1 - Single
2 - Married
3 - Separated
4 - Widowed
5 - DivorcedFirst Available Version: SearchEmployeesResponse - MiddleInitialStringEmployee’s middle initial
First Available Version: SearchEmployeesResponse - NamePrefixStringTitle of the employee, such as Mr., Mrs., Dr., Rev, etc
First Available Version: SearchEmployeesResponse - TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up.
First Available Version: SearchEmployeesResponse - AlternateIDStringThe employee’s Alternate ID
First Available Version: SearchEmployeesResponse - CarrierNameStringThe name of the employee’s medical insurance carrier.
First Available Version: SearchEmployeesResponse_2019_07 - MedicalDeductibleDecimalThe annual deductible for this employee’s medical insurance
First Available Version: SearchEmployeesResponse_2019_07 - MedicalDeductiblePTDDecimalThe 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:
- UpdateEmployeeHumanResourceInfoRequest
Response Message
The UpdateEmployeeHumanResourceInfo method requires the following request and response messages (input and output data). The table below includes the following request message:
- UpdateEmployeeHumanResourceInfoRequest
- TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up. If this is not
First Available Version: UpdateEmployeeHumanResourceInfoRequest - EmployerIdStringrequiredUnique 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: UpdateEmployeeHumanResourceInfoRequest - EmployeeIdStringconditionally requiredEmployee ID for the employee that should be updated. Required if this field is being used as the unique employee Identifier. Either this field or SocSecNum may be used for this purpose.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - SocSecNumStringconditionally requiredSocial Security Number for the employee that should be updated. 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: UpdateEmployeeHumanResourceInfoRequest - AddComp1StringAny additional compensation reported by or determined by the Employer.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - AddComp2StringAny additional compensation reported by or determined by the administrator
First Available Version: UpdateEmployeeHumanResourceInfoRequest - BaseSalaryStringEnter the employee’s base salary determined by or reported by the Employer.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - BranchCdeStringThe branch code determined by the Employer/Administrator.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - CobraBooleanIndicates if participant is enrolled in COBRA
0 – False
1 – TrueFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - CompOfficerBooleanEmployee Highly Compensated Cafeteria Plan Definition
0 – False
1 – TrueFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - CompOfficerDcaBooleanHighly Compensated Dependent Care definition
0 – False
1 – TrueFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - DeptCdeStringDepartment Code
First Available Version: UpdateEmployeeHumanResourceInfoRequest - DivisionKeyStringA unique identifier generated by WCA used to represent a division
First Available Version: UpdateEmployeeHumanResourceInfoRequest - Elect401kAmtString401K election amount
Note 1: Do not use this field if Option to Enter ElectionAmounts is ‘Total.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectAdoptionAmtStringAdoption Election Amount for an employee
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectDentalAmtStringDental Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan TestFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectDependentcareFSAAmtStringDependent Care FSA Election Amount for an employee.
Note 1: This field can be used to capture Dependent Care
Election data for the Dependent Care Non-Discrimination Test. Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectGrpTermLifeAmtStringGroup Term Life Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectHealthAmtStringHealth Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectHealthFSAAmtStringHealth FSA Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectLtdAmtStringLTD Election Amount for an employee
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectOtherAmtStringHealth Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectOtherHealthAmtStringOther Health Election Amount for an employee
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectStdAmtStringSTD Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - ElectVisionAmtStringVision Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: UpdateEmployeeHumanResourceInfoRequest - EligDteString (YYYYMMDD)Date upon which the employee is eligible to elect benefits. This existing field is being updated to validate that it is prior to the termination date.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - EmpeOptioncdeStringOption to enter election amounts Total Individual. Valid values are:
Total = 0,
Individual = 1,
IsSelfCreated = 2,
MedicareOpted = 4,
Esrd = 8,
CMSAdd = 16,
HideDepClaimsOnExpensePage = 32,
DDBankAcctValReqReminderSent = 64,
DisableOnlineRepayment = 128,
HasForeignCardShipAddress = 256,
VIPException = 512First Available Version: UpdateEmployeeHumanResourceInfoRequest - EmployTypeCdeStringEmployment Type code. Valid values are:
1 - FullTime
2 - PartTime
3 - ContractFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - EvidInsurabilityStringThe administrator's status code used to indicate evidence of insurability.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - HcOverrideBooleanHighly compensated override
0 – False
1 – TrueFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - HcRelativeSsnStringThe social security number of the highly compensated relative.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - HireDteString (YYYYMMDD)Employee’s hire date
First Available Version: UpdateEmployeeHumanResourceInfoRequest - KeyEmpeBooleanIndicates if key employee
0 – False
1 – TrueFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - LocCdeStringThe administrator's location code for the employee
First Available Version: UpdateEmployeeHumanResourceInfoRequest - NonResidentAlienBooleanNon-resident alien
0 – False
1 – TrueFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - OccupCdeStringThe administrator's occupation code for the employee
First Available Version: UpdateEmployeeHumanResourceInfoRequest - OrigHireDteString (YYYYMMDD)Employee’s original hire date if more than one period of employment exists.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - PrevYrTotalCompStringThe employee’s previous year total compensation determined by or reported by the Employer.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - SecCdeStringThe employer or administrator's section code for the employee
First Available Version: UpdateEmployeeHumanResourceInfoRequest - SmokerBooleanSmoker
0 – False
1 – TrueFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - SpouseDepOfOwnerBooleanSpouse/Dependent of owner
0 – False
1 – TrueFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - StockPctStringPercent of company stock employee holds.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - TaxFilingStatusCdeStringTax filing status. Valid values are:
0 = None (default)
1 = Single
2 = Married Filing Jointly
3 = Married Filing Separately
4 = Head of Household
5 = Qualifying WidowFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - TermDteString (YYYYMMDD)Date upon which the employee is no longer eligible for benefits. This existing field is being updated to validate that it is after the eligibility date.
First Available Version: UpdateEmployeeHumanResourceInfoRequest - TotalElectAmtStringThe total of OTHER Election Amounts for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total.
Note 2: You can use this field to record the employees benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan TestFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - UnionMemberBooleanUnion Member
0 – False
1 – TrueFirst Available Version: UpdateEmployeeHumanResourceInfoRequest - VacationDaysStringNumber of vacation days for the employee
First Available Version: UpdateEmployeeHumanResourceInfoRequest - DivisionStringParticipant’s division name
Note: This information should exactly match the division name as displayed in WCAFirst Available Version: UpdateEmployeeHumanResourceInfoRequest_2018_08 - ClassStringParticipant’s class name
Note: This information should exactly match the class name as displayed in WCA.First Available Version: UpdateEmployeeHumanResourceInfoRequest_2018_08
Response Message: Empty Message
Example of an UpdateEmployeeHumanResourceInfo SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=32TUhttp://schemas.xmlsoap.org/soap/envelope/U32T
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>
<UpdateEmployeeHumanResourceInfoRequest
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Request/">
<updateEmployeeHumanResourceInfoRequest>
<TpaId>T00133</TpaId>
<EmployeeId>Employee1</EmployeeId>
<EmployerId>WST5111</EmployerId>
<AddComp1>1000</AddComp1>
<OrigHireDte>20050103</OrigHireDte>
</updateEmployeeHumanResourceInfoRequest>
</UpdateEmployeeHumanResourceInfoRequest>
</soap:Body>
</soap:Envelope>
Example of an UpdateEmployeeHumanResourceInfo 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>
< UpdateEmployeeHumanResourceInfoResponse
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Response/">
< UpdateEmployeeHumanResourceInfoResult />
</ UpdateEmployeeHumanResourceInfoResponse>
</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 UpdateEmployeeHumanResourceInfo
method.
try
{
//declare the request and response objects
SmokeTest.Employee_2007_08.UpdateEmployeeHumanResourceInfoRequest req_2007_08;
SmokeTest.Employee_2007_08.UpdateEmployeeHumanResourceInfoResponse resp_2007_08;
SmokeTest.Employee_2007_08.MBISessionHeader es_2007_08_sh;
//Create objects
es_2007_08_proxy = new SmokeTest.Employee_2007_08.EmployeeService();
es_2007_08_sh = new SmokeTest.Employee_2007_08.MBISessionHeader();
req_2007_08 = new SmokeTest.Employee_2007_08.UpdateEmployeeHumanResourceInfoRequest();
//Required fields
req_2007_08.TpaId = txtTPA.text;
req_2007_08.EmployerId = txtEmployerId.text;
req_2007_08.EmployeeId = txtEmployeeId.text;
req_2007_08.AddComp1 = txtAddComp1.text;
req_2007_08.AddComp2 = txtAddComp2.text;
es_2007_08_sh.MBISessionID = sSession;
es_2007_08_proxy.MBISessionHeaderValue = es_2007_08_sh;
resp_2007_08 = es_2007_08_proxy.UpdateEmployeeHumanResourceInfo(req_2007_08);
}
catch(Exception ex)
{
//If an exception occurred, display to the user txtResponse.Text = ex.Message;
}
}
__________________________________________________
GetEmployeeHumanResourceInfo
This method is used to get an employee’s non-discriminatory information.
History
The GetEmployeeHumanResourceInformation methods are listed
below:
- GetEmployeeHumanResourceInfoRequest
- GetEmployeeHumanResourceInfoResponse_2020_02
The GetEmployeeHumanResourceInfo method requires the following request and response messages (input and output data). The table below includes the following request message:
- GetEmployeeHumanResourceInfoRequest
- TpaIdStringA 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: GetEmployeeHumanResourceInfoRequest - EmployerIdStringrequiredUnique 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: GetEmployeeHumanResourceInfoRequest - EmployeeIdStringconditionally requiredEmployee 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: GetEmployeeHumanResourceInfoRequest - SocSecNumStringconditionally requiredEmployee’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: GetEmployeeHumanResourceInfoRequest
- GetEmployeeHumanResourceInfoResponse_2020_02
- GetEmployeeHumanResourceInfoResponse
- AddComp1StringAny additional compensation reported by or determined by the Employer.
First Available Version: GetEmployeeHumanResourceInfoResponse - AddComp2StringAny additional compensation reported by or determined by the administrator
First Available Version: GetEmployeeHumanResourceInfoResponse - BaseSalaryStringEnter the employee’s base salary determined by or reported by the Employer.
First Available Version: GetEmployeeHumanResourceInfoResponse - BranchCdeStringThe branch code determined by the Employer/Administrator.
First Available Version: GetEmployeeHumanResourceInfoResponse - CobraStringIndicates if participant is enrolled in COBRA
0 – False
1 – TrueFirst Available Version: GetEmployeeHumanResourceInfoResponse - CompOfficerStringEmployee Highly Compensated Cafeteria Plan Definition
0 – False
1 – TrueFirst Available Version: GetEmployeeHumanResourceInfoResponse - CompOfficerDcaStringHighly Compensated Dependent Care definition
0 – False
1 – TrueFirst Available Version: GetEmployeeHumanResourceInfoResponse - DeptCdeStringDepartment Code
First Available Version: GetEmployeeHumanResourceInfoResponse - DivisionKeyStringA unique identifier generated by WCA used to represent a division
First Available Version: GetEmployeeHumanResourceInfoResponse - Elect401kAmtString401K election amount
Note 1: Do not use this field if Option to Enter ElectionAmounts is ‘Total.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - ElectAdoptionAmtStringAdoption Election Amount for an employee
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - ElectDentalAmtStringDental Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan TestFirst Available Version: GetEmployeeHumanResourceInfoResponse - ElectDependentcareFSAAmtStringDependent Care FSA Election Amount for an employee.
Note 1: This field can be used to capture Dependent Care
Election data for the Dependent Care Non-Discrimination Test. Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - ElectGrpTermLifeAmtStringGroup Term Life Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - ElectHealthAmtStringHealth Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - ElectHealthFSAAmtStringHealth FSA Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - ElectLtdAmtStringLTD Election Amount for an employee
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - ElectOtherAmtStringHealth Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - ElectOtherHealthAmtStringOther Health Election Amount for an employee
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - ElectStdAmtStringSTD Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - ElectVisionAmtStringVision Election Amount for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total’.
Note 2: You can use this field to record the employee’s benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan Test.First Available Version: GetEmployeeHumanResourceInfoResponse - EligDte String (YYYYMMDD)Date upon which the employee is eligible to elect benefits. This existing field is being updated to validate that it is prior to the termination date.
First Available Version: GetEmployeeHumanResourceInfoResponse - EmpeOptioncdeStringOption to enter election amounts Total Individual. Valid values are:
Total = 0,
Individual = 1,
IsSelfCreated = 2,
MedicareOpted = 4,
Esrd = 8,
CMSAdd = 16,
HideDepClaimsOnExpensePage = 32,
DDBankAcctValReqReminderSent = 64,
DisableOnlineRepayment = 128,
HasForeignCardShipAddress = 256,
VIPException = 512First Available Version: GetEmployeeHumanResourceInfoResponse - EmployTypeCdeStringEmployment Type code. Valid values are:
1 - FullTime
2 - PartTime
3 - ContractFirst Available Version: GetEmployeeHumanResourceInfoResponse - EvidInsurabilityStringThe administrator's status code used to indicate evidence of insurability.
First Available Version: GetEmployeeHumanResourceInfoResponse - HcOverrideStringHighly compensated override
0 – False
1 – TrueFirst Available Version: GetEmployeeHumanResourceInfoResponse - HcRelativeSsnStringThe social security number of the highly compensated relative.
First Available Version: GetEmployeeHumanResourceInfoResponse - HireDteString (YYYYMMDD)Employee’s hire date
First Available Version: GetEmployeeHumanResourceInfoResponse - KeyEmpeStringIndicates if key employee
0 – False
1 – TrueFirst Available Version: GetEmployeeHumanResourceInfoResponse - LocCdeStringThe administrator's location code for the employee
First Available Version: GetEmployeeHumanResourceInfoResponse - NonResidentAlienStringNon-resident alien
0 – False
1 – TrueFirst Available Version: GetEmployeeHumanResourceInfoResponse - OccupCdeStringThe administrator's occupation code for the employee
First Available Version: GetEmployeeHumanResourceInfoResponse - OrigHireDte (YYYYMMDD)StringEmployee’s original hire date if more than one period of employment exists.
First Available Version: GetEmployeeHumanResourceInfoResponse - PrevYrTotalCompStringThe employee’s previous year total compensation determined by or reported by the Employer.
First Available Version: GetEmployeeHumanResourceInfoResponse - SecCdeStringThe employer or administrator's section code for the employee
First Available Version: GetEmployeeHumanResourceInfoResponse - SmokerStringSmoker
0 – False
1 – TrueFirst Available Version: GetEmployeeHumanResourceInfoResponse - SpouseDepOfOwnerStringSpouse/Dependent of owner
0 – False
1 – TrueFirst Available Version: GetEmployeeHumanResourceInfoResponse - StockPctStringPercent of company stock employee holds.
First Available Version: GetEmployeeHumanResourceInfoResponse - TaxFilingStatusCdeStringTax filing status. Valid values are:
0 = None (default)
1 = Single
2 = Married Filing Jointly
3 = Married Filing Separately
4 = Head of Household
5 = Qualifying WidowFirst Available Version: GetEmployeeHumanResourceInfoResponse - TermDte (YYYYMMD)StringDate upon which the employee is no longer eligible for benefits. This existing field is being updated to validate that it is after the eligibility date.
First Available Version: GetEmployeeHumanResourceInfoResponse - TotalElectAmStringThe total of OTHER Election Amounts for an employee.
Note 1: Do not use this field if Option to Enter Election Amounts is ‘Total.
Note 2: You can use this field to record the employees benefit/election amounts. This data can only be used when running the 25% Cafeteria Plan TestFirst Available Version: GetEmployeeHumanResourceInfoResponse - UnionMemberStringUnion Member
0 – False
1 – TrueFirst Available Version: GetEmployeeHumanResourceInfoResponse - VacationDaysStringNumber of vacation days for the employee
First Available Version: GetEmployeeHumanResourceInfoResponse - DivisionNameStringParticipant’s division name
First Available Version: GetEmployeeHumanResourceInfoResponse_2020_02 - ClassNameStringParticipant’s class name
First Available Version: GetEmployeeHumanResourceInfoResponse_2020_02
Example of a GetEmployeeHumanResourceInfo SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=32Thttp://schemas.xmlsoap.org/soap/envelope/32T
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>
<GetEmployeeHumanResourceInfoRequest xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Request/">
<getEmployeeHumanResourceInfoRequest>
<TpaId>T00123</TpaId>
<EmployeeId>Employee1</EmployeeId>
<EmployerId>WST1234</EmployerId>
</getEmployeeHumanResourceInfoRequest>
</GetEmployeeHumanResourceInfoRequest>
</soap:Body>
</soap:Envelope>
Example of a GetEmployeeHumanResourceInfo 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/" /> <MessageId>36565d89-7619-
48be-8c7e-7fb1929d0ded</MessageId></MBIMessageIdHeader>
</soap:Header>
<soap:Body>
<GetEmployeeHumanResourceInfoResponse
xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Employee/Response/"><GetEmployeeHumanResourc
eInfoResult>
<AddComp1>70</AddComp1>
<AddComp2>20</AddComp2>
<BaseSalary>95000</BaseSalary>
<BranchCde />
<Cobra>false</Cobra>
<CompOfficer>false</CompOfficer>
<CompOfficerDca>false</CompOfficerDca>
<HireDte />
<OrigHireDte />
<TermDte />
<EligDte />
<OccupCde />
<LocCde />
<DeptCde />
<DivisionKey>-1</DivisionKey>
<SecCde />
<HealthId />
<EvidInsurability />
<HcRelativeSsn/>
<PrevYrTotalComp>0</PrevYrTotalComp>
<StockPct>0</StockPct>
<VacationDays>0</VacationDays>
<UnionMember>false</UnionMember>
<Smoker>false</Smoker>
<NonResidentAlien>false</NonResidentAlien>
<TaxFilingStatusCde>Single</TaxFilingStatusCde>
<EmployTypeCde>FullTime</EmployTypeCde>
<EmpeOptioncde>Total</EmpeOptioncde>
<KeyEmpe>false</KeyEmpe>
<SpouseDepOfOwner>false</SpouseDepOfOwner>
<ElectOtherAmt>0</ElectOtherAmt>
<ElectHealthAmt>0</ElectHealthAmt>
<ElectDentalAmt>0</ElectDentalAmt>
<ElectVisionAmt>0</ElectVisionAmt>
<ElectGrpTermLifeAmt>0</ElectGrpTermLifeAmt>
<ElectOtherHealthAmt>0</ElectOtherHealthAmt>
<ElectLtdAmt>0</ElectLtdAmt>
<ElectStdAmt>0</ElectStdAmt>
<ElectAdoptionAmt>0</ElectAdoptionAmt>
<Elect401kAmt>0</Elect401kAmt>
<ElectHealthFSAAmt>0</ElectHealthFSAAmt>
<ElectDependentcareFSAAmt>0</ElectDependentcareFSAAmt>
<TotalElectAmt>0</TotalElectAmt>
<HcOverride>False</HcOverride>
</GetEmployeeHumanResourceInfoResult>
</GetEmployeeHumanResourceInfoResponse>
</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 GetEmployeeHumanResourceInfo method.
try
{
//declare the request/response objects
SmokeTest.Employee_2007_08.GetEmployeeHumanResourceInfoRequest req_2007_08;
SmokeTest.Employee_2007_08.GetEmployeeHumanResourceInfoResponse resp_2007_08;
//Create objects
SmokeTest.Employee_2007_08.MBISessionHeader es_2007_08_sh;
//Create objects
es_2007_08_proxy = new SmokeTest.Employee_2007_08.EmployeeService();
es_2007_08_sh = new SmokeTest.Employee_2007_08.MBISessionHeader();
req_2007_08 = new SmokeTest.Employee_2007_08.GetEmployeeHumanResourceInfoRequest();
//Required fields
req_2007_08.TpaId = txtTPA.text;
req_2007_08.EmployerId = txtEmployerId.text;
req_2007_08.EmployeeId = txtEmployeeId.text;
//Display session ID on web form
es_2007_08_sh.MBISessionID = sSession;
es_2007_08_proxy.MBISessionHeaderValue = es_2007_08_sh;
resp_2007_08 = es_2007_08_proxy.GetEmployeeHumanResourceInfo(req_2007_08);
}
catch (Exception ex)
{
txtResponse.Text = ex.Message;
}
}
__________________________________________________
AddEmployeeInteraction
This method is used by administrators to add employee interactions.
History
The AddEmployeeInteraction methods are listed below:
- AddEmployeeInteraction
- AddEmployeeInteraction
The AddEmployeeInteraction method requires the following request and response messages (input and output data). The table below includes the following request messages:
- AddEmployeeInteractionRequest
- ProductPartnerIdStringProduct partner ID
Note: If a valid product partner ID is provided, and if the assign to product partner field is included with a ‘1’ (yes), WCA creates a partner interaction. If no product partner ID is provided, WCA creates an administrator interaction.First Available Version: AddEmployeeInteractionRequest - TpaIdStringA 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: AddEmployeeInteractionRequest - TypeStringrequiredInteraction type. Must match an existing interaction type in WCA.
First Available Version: AddEmployeeInteractionRequest - DateTimeStringDate of the interaction. Defaults to today's date/current time if a date is not provided.
Format: yyyyMMddHHmmSS (24hrs)
Example: June 26, 2018 at 11:35:57AM must be submitted as shown below:
20180626113557First Available Version: AddEmployeeInteractionRequest Default Values: Current date & time
- NoteStringOptional, use to include additional details about interaction.
First Available Version: AddEmployeeInteractionRequest - ViewableByEmployerAdministratorBooleanIdentifies if interaction is viewable by employer (for administrator interactions), or admin (for partner interactions).
0 = No
1 = Yes (default)First Available Version: AddEmployeeInteractionRequest Default Values: 1 (yes)
- PlanIdStringPlan ID
First Available Version: AddEmployeeInteractionRequest - FileNameStringFile name and extension. You must specify file name.
First Available Version: AddEmployeeInteractionRequest - FileBase64StringFile contents represented as Base64 string.
First Available Version: AddEmployeeInteractionRequest - StatusEnumerationStatus of the interaction. Use the following field values:
0 = None
1 = New
2 = Closed
4 = In process
8 = On hold
16 = Re-openedFirst Available Version: AddEmployeeInteractionRequest - EmployeeIdStringrequiredUnique identifier for the employee
First Available Version: AddEmployeeInteractionRequest - EmployerIdStringrequiredUnique 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: AddEmployeeInteractionRequest - PlanStartDateString (YYYYMMDD)conditionally requiredStart date of associated plan.
Format: yyyyMMdd
Note: If you use unique plan IDs, you do not need to submit plan dates, This is required if Plan ID is not unique.First Available Version: AddEmployeeInteractionRequest - PlanEndDateString (YYYYMMDD)conditionally requiredEnd date of associated plan.
Format: yyyyMMdd
Note: If you use unique plan IDs, you do not need to submit plan dates. This is required if Plan ID is not unique.First Available Version: AddEmployeeInteractionRequest - AssignToProductPartnerBooleanDo you want the interaction to be saved as a partner interaction?
Passing a ‘1’ for this field indicates that the interaction should be saved as a partner interaction. Blank or ‘0’, indicates that the interaction should be saved as an administrator interaction.
For a ‘1’ to be passed, the following fields must be included: product partner ID, HSA-specific plan ID, plan start & end dates.
0 = No (default)
1 = YesFirst Available Version: AddEmployeeInteractionRequest
Response message:
- ReturnMessageStringSuccess message appears if AddEmployeeInteraction is created successfully.
First Available Version: AddEmployeeInteractionResponse