UpsertEmployee
This call creates new records and updates existing records. It uses the employee's code to determine if a record already exists in PureSafety. With this method, you do not need to check whether the employee already exists as you do with the create and update calls for employees.
Sending a NULL value to an existing field removes the current value from that field.
Information | Employee Web Service 1 | Employee Web Service 2 |
---|---|---|
Usage |
In most cases, we recommend that you use the UpsertEmployee call instead of the CreateEmployee to avoid creating unwanted duplicate records. You can create or update information in any of the fields listed in the Optional Fields column. Refer to Appendix D for details about each field. |
In most cases, we recommend that you use the UpsertEmployee call instead of the CreateEmployee to avoid creating unwanted duplicate records. You can create or update information in any of the fields listed in the Optional Fields column. Refer to Appendix D for details about each field. |
Syntax |
UpsertEmployee(UserLoginWebServiceEntity userLoginWebServiceEntity, EmployeeWebServiceEntity employeeWebServiceEntity) |
UpsertEmployee(UserLoginWebServiceEntity userLoginWebServiceEntity, EmployeeWebServiceEntity employeeWebServiceEntity) |
Fields | ||
Required Fields |
Note: NULL or False can be used to
indicate that a value is not provided.
If you do not enter any value for Address1, then you do not have to complete Address2,City, Country, State, or Zip. If you do not enter any value for PhoneNumber, then you do not have to complete PhoneCountry. If you do not enter any value for LoginName then you do not have to complete LoginPassword, ForcePasswordChange or IsActive. |
|
Response |
|
|
Sample Code - C# (Employee Web Service 1)
public void Sample()
{
UserLoginWebServiceEntity userLoginWebServiceEntity = new UserLoginWebServiceEntity();
userLoginWebServiceEntity.WebServiceLoginName = "username";
userLoginWebServiceEntity.WebServiceLoginPassword = "password";
EmployeeWebServiceEntity employee = new EmployeeWebServiceEntity();
employee.EmployeeCode = "JB01";
employee.FirstName = "Jim";
employee.MiddleName = "A";
employee.LastName = "Bob";
employee.BirthDate = "1/1/1980";
employee.HireDate = "10/6/2004";
employee.Address1 = "1234 Straight Rd.";
employee.Address2 = "Apt 1";
employee.City = "SmallTown";
employee.State = "TX";
employee.Zip = "55555";
employee.Country = "USA";
employee.EmailAddress = "jb@email.com";
employee.PhoneNumber = "(555)555-5555";
employee.PhoneCountry = "USA";
employee.JobTitle = "Driver";
employee.LoginName = "jim.bob";
employee.LoginPassword = "Password123!";
employee.IsActive = true;
employee.ForcePasswordChange = false;
employee.OrganizationUnitCode = "Client";
employee.GroupCode = "LiftOperators";
// Invoke the call
try
{
EmployeeWebServiceContractClient employeeWebService = new EmployeeWebServiceContractClient();
employeeWebService.UpsertEmployee(userLoginWebServiceEntity, employee);
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
}
Sample Code - C# (Employee Web Service 2)
public void CSharpSample() {
UserLoginWebServiceEntity userLoginWebServiceEntity = new UserLoginWebServiceEntity() {
WebServiceLoginName = "username",
WebServiceLoginPassword = "password"
};
EmployeeWebServiceEntity employee = new EmployeeWebServiceEntity() {
EmployeeCode = "JB01",
Prefix = "Mr.", //NEW for v2
FirstName = "Jim",
MiddleName = "A",
LastName = "Bob",
Suffix = "Jr.", //NEW for v2
BirthDate = new DateTime(1988, 1, 1),
HireDate = new DateTime(2006, 10, 1),
ReleaseDate = new DateTime(2013, 1, 1),
Gender = "Male", //NEW for v2
ManagerEmployeeCode = "PSADMIN", //NEW for v2
WorkLocation = "Engineering Dept.", //NEW for v2
OrganizationUnitCode = "Client",
GroupCode = "LiftOperators",
Address1 = "1234 Straight Rd.",
Address2 = "Apt 1",
City = "SmallTown",
State = "TX",
Zip = "55555",
Zip4 = "1111", //NEW for v2
Country = "USA",
EmailAddress = "jb@email.com",
PhoneNumber = "(555)555-5555",
PhoneExtension = "1234", //NEW for v2
PhoneCountry = "USA",
JobTitle = "Driver",
LoginName = "jim.bob",
LoginPassword = "Password123!",
IsActive = false,
ForcePasswordChange = false,
Language = "English", //NEW for v2
TimeZone = "Central Standard Time" //NEW for v2
};
try {
EmployeeWebServiceContractClient employeeWebService = new EmployeeWebServiceContractClient();
// Invoke the call
if (!employeeWebService.UpsertEmployee(userLoginWebServiceEntity, employee))
throw new Exception("Method call was not successful.");
} catch (FaultException<PureSafetyFaultDetail> detail) {
Console.WriteLine(String.Format("ErrorCode: {0}, ErrorDescription: {1}", detail.Detail.ErrorCode, detail.Detail.ErrorDescription));
} catch (Exception ex) {
Console.WriteLine(ex.Message);
}
}
Sample Code - Java (Employee Web Service 1)
public void JavaSample()
{
UserLoginWebServiceEntity userLoginWebServiceEntity =
new UserLoginWebServiceEntity("username","password");
EmployeeWebServiceEntity employeeWebServiceEntity = new EmployeeWebServiceEntity(
"1234 Straight Rd.",
"Apt 1",
new java.util.GregorianCalendar(1980,0,1),
"SmallTown",
"USA",
"jb@email.com",
"JB01",
"Jim",
false,
"LiftOperators",
new java.util.GregorianCalendar(2004,9,6),
true,
"Driver",
"Bob",
"jim.bob",
"Password123!",
"A",
"Client",
"USA",
"(555)555-5555",
null,
"TX",
"55555"
);
try { //Invoke the call
EmployeeWebServiceLocator locator = new EmployeeWebServiceLocator();
EmployeeWebServiceContract employeeWebService = locator.getbasicEndpoint();
employeeWebService.upsertEmployee(
userLoginWebServiceEntity, employeeWebServiceEntity);}
catch (Exception e) {
e.printStackTrace();
}
}
Sample Code - Java (Employee Web Service 2)
public void JavaExample() {
UserLoginWebServiceEntity userLoginWebServiceEntity = new UserLoginWebServiceEntity (
"username",
"password"
);
EmployeeWebServiceEntity employeeWebServiceEntity = new EmployeeWebServiceEntity (
"1234 Straight Rd.",
"Apt 1",
new java.util.GregorianCalendar(1980,0,1),
"SmallTown",
"USA",
"jb@email.com",
"JB01",
"Jim",
false,
"Male", //NEW for V2
"LiftOperators",
new java.util.GregorianCalendar(2004,9,6),
true,
"Driver",
"English", //NEW for V2
"Bob",
"jim.bob",
"Password123!",
"PSADMIN", //NEW for v2
"A",
"Client",
"USA",
"1234", //NEW for v2
"(555)555-5555",
"Mr.", //NEW for v2
new java.util.GregorianCalendar(2013,0,1),
"TX",
"Jr.", //NEW for v2
"Central Standard Time", //NEW for v2
"Engineering Dept.", //NEW for v2
"55555",
"1111" //NEW for v2
);
try { //Invoke the call
EmployeeWebServiceLocator locator = new EmployeeWebServiceLocator();
EmployeeWebServiceContract employeeWebService = locator.getbasicEndpoint();
if (!employeeWebService.upsertEmployee(userLoginWebServiceEntity, employeeWebServiceEntity))
throw new Exception("Method call was not successful.");
} catch (PureSafetyFaultDetail detail) {
System.out.println(String.format("ErrorCode: %s, ErrorDescription: %s", detail.getErrorCode(), detail.getErrorDescription()));
} catch (Exception ex) {
System.out.println(ex.getMessage());
}
}