Fields Updated by the Employee Web Services

Address1

Employee's mailing address.

An imported mailing address that already exists in the employee record is set as the primary address.

An imported mailing address that does not exist in the employee record is added and set as the primary address. Existing mailing addresses in the employee record are updated to alternate mailing addresses.

You must provide a value for Address1 in order to enter information into the Address2, City, Country, State, or Zip fields.

String

Address2

Additional information about the employee's mailing address.

This field can be blank if you do not enter a value for Address 1.

String

BirthDate

Employee's date of birth

Date

City

City in the employee's mailing address

This field can be blank if you do not enter a value for Address 1.

String

Country

Country in the employee's mailing address

This field can be blank if you do not enter a value for Address 1.

For a complete list of country codes, see the Country Codes topic.

String

EmailAddress

Employee's email address (for example, username@company.com)

An imported email address that already exists in the employee record is set as the primary email address.

An imported email address that does not exist in the employee record is added and set as the primary address. Existing email addresses in the employee record are updated to alternate email addresses.

Deleting email addresses is not available through the Employee Web services.

String

EmployeeCode

An external unique ID specified by customers, used to identify each employee.

The Employee Web service uses this code to determine whether an employee record is created or updated.

String

Extension

Employee's phone extension

String

FirstName

Employee's first name

String

ForcePasswordChange

Indicates whether employees are required to change their passwords the next time they log in to PureSafety (true = requires a password change, false or null = allows employees to log into PureSafety with their previous passwords).

This field must have a true, false, or null value. False is the default value.

Boolean

Gender

Available only when using Employee Web Service 2

Employee's gender.

String

GroupCode

Employee's group code

Employees inherit assignments currently assigned to the group, provided that the assignments are configured to automatically be assigned to new entrants, when they are added to the group.

Recommendation: Log in to PureSafety and remove an employee from any groups to which he currently belongs manually.

The following error message displays if the Web service sends invalid data in this field.

"The requested Group is invalid or missing. - Group:<GroupCode>, Employee: <EmployeeName>"

String

HireDate

Employee's hire date

Date

IsActive

Indicates whether the employee record is active by default or not (true = Yes (Active), false or null = No (Not Active)). The employee cannot log in to PureSafety if he is inactive.

This field must have a true, false, or null value.

The IsActive becomes a required field if the LoginName field is included in the call.

Boolean

IsPrimary

Specifies whether the mailing address, email address, or phone number provided is the primary one (true = Is Primary, false or null = No).

This field must have a true, false, or null value.

Boolean

JobTitle

Employee's job title

String

Language

Employee's culture.

This field accepts English, Spanish, and French.

String

LastName

Employee's last name

String

LoginName

User name employee uses to log in to PureSafety, for example, first.lastname

String

LoginPassword

Password employee uses to log in to PureSafety

The LoginPassword becomes a required field if the LoginName field is include in the call.

String

Manager Employee Code

The employee's manager's employee code.

String

MiddleName

Employee's middle name

String

OrganizationUnitCode

Employee's organization unit

Employees inherit assignments currently assigned to the organization unit, provided that the assignments are configured to automatically be assigned to new entrants, when they are added to an organization unit.

Recommendation: If you want to assign the employee to a new organization unit and keep him in those to which he currently belongs, enter the organization unit codes of all the units to which he belongs in addition to the code for the new organization unit.

If the Web service sends invalid data in this field, the following error message appears: "The requested Organization Unit is invalid or missing. - OrganizationCode:<OrgUnitCode>, Employee: <EmployeeName>"

String

PhoneCountry

Country used for the employee's phone number

This field can be blank if you do not enter a value for PhoneNumber.

For a complete list of country codes, see the Country Codes topic.

String

Phone Extension

Employee's phone number extension.

String

PhoneNumber

Employee's phone number

An imported phone number that already exists in the employee record is set as the primary address.

An imported phone number that does not exist in the employee record is added and set as the primary address. Existing mailing addresses in the employee record are updated to alternate mailing addresses.

You cannot enter information into the PhoneCountry field if you do not enter a value in the PhoneNumber field.

String

Prefix

Employee's prefix.

This field accepts Dr., Miss, Mr., Mrs., and Ms.

String

ReleaseDate

Employee's release date

Date

State

State in the employee's mailing address (for example, Tennessee)

This field can be blank if you do not enter a value for Address 1.

String

Suffix

Employee's suffix.

This field accepts II, III, IV, Jr. and Sr.

String

Time Zone

Employee's time zone.

This field accepts a standard time zone code. For example, Central Standard Time.

String

Work Location

Employee's work location.

String

Zip

ZIP code in the employee's mailing address

This field can be blank if you do not enter a value for Address 1.

String