Employee Person Service


With UKG Pro Web Services, you can leverage your UKG Pro data for solving business application and integration needs.

This document describes how to use the Employee Person web service and is intended for individuals who are familiar with software development and web service technologies.

Employee Person Service API

The UKG Pro Employee Person Service API enables the user to programmatically retrieve and update employee person information in UKG Pro.


This document describes the methods of the service and provides code examples using Microsoft’s Visual Studio 2008 using C# and XML (.NET Framework 3.0 or higher).

The following information describes the service requirements.

Service Specifications
ProtocolSimple Object Access Protocol (SOAP) 1.2
SSL SupportRequired
Signup and Licensing
Account RequiredUKG Pro Service Account or UKG Pro Web User with Web Services Permissions

Using an UKG Pro Service Account is recommended. For information regarding establishing and maintaining an UKG Pro Service Account, please refer to the document Maintaining Service Accounts located in the UKG Pro Technical Content section of the Ultimate Library under UKG Pro Web Services and APIs.

Employee Person Object

The employee person object includes the following properties.

AlternateEmailAddressStringAlternate email address.
EmailAddressStringPrimary email address.
FirstNameYesStringFirst name of the person.
FormerLastNameStringFormer last name of the person.
LastNameYesStringLast name of the person.
MiddleNameStringMiddle name of the person.
PreferredFirstNameStringPreferred name of the person.
PrefixCodeA valid UKG Pro prefix code.
SSNStringSocial Security Number
SuffixCodeA valid UKG Pro suffix code.
SuppressSSNBooleanDetermines if the SSN should be suppressed in the UKG Pro portal.
EmployeeIdentifierYesIdentifierID that represents a person.

Quick Start

This section provides steps for creating a sample application in your development environment to retrieve and update the employee person information.


In order to use the service, you will need the following items:

  • An UKG Pro Service Account username and password OR an UKG Pro Web User username and password
  • The Customer API key from the UKG Pro Web Service administrative page
  • If you use an UKG Pro Service Account:
    • You will need the User API key from the Service Account administrative page.
    • You must have appropriate permissions granted to the Service Account for the Employee Person service on the Service Account administrative page.
  • If you use an UKG Pro Web User account:
    • You will need the User API key from the Web Service administrative page.


This section introduces the API methods for the Employee Person Web Service.


This method provides a way to query the web service based on one or more filter criteria. See the getting started guide for a list of query properties and operations supported.

Note that the paging properties may be set when using this method. You can specify the PageNumber and PageSize. The page number indicates which page you want to return and the PageSize refers to the number of records to return per PageNumber. You can return a maximum of 100 records per PageNumber.


This method allows you to retrieve an individual person record by providing an employee identifier.

This is helpful if you are designing an application that is aware of the employees to retrieve or when you plan to execute an update of some of the person information.


This method allows you to update the person information. We recommend executing a find or get to retrieve the person information first then submitting the object to the update method.

C# Example

Generate the Service Reference

Once you have a user and API keys, you need to create a service reference to the Login Service and the Person Service. In your development environment, add the service references.

In Visual Studio, select the Add Service Reference menu item from the Project menu. Once you enter the service information you should have the references display in the solution explorer.

Created service reference

Created service reference

Example Code

The following code is an example of retrieving employee person information from your UKG Pro data in a console application. You can copy the entire contents to a C# console application and update the following values and have an operable application.

See the methods section for an example of adding updates to your application.

Password = "YOUR PASSWORD",

//Example Quick Start Code Begin
using System;
using System.Collections.Generic;
using System.Linq;
using System.ServiceModel;
using System.ServiceModel.Channels;
using System.Text;
using ConsolePerson.LoginService;
using ConsolePerson.PersonService;
namespace ConsolePerson
    class Program
        static void Main(string[] args)
            LoginServiceClient loginClient = null;
                // Setup your user credentials.
                string UserName = "";
                string Password = "";
                string UserAPIkey = "";
                string CustomerAPIkey = "";
                string Message = "";
                string AuthenticationToken = "";
                // Create a proxy to the login service.
                loginClient = new LoginServiceClient("WSHttpBinding_ILoginService");
                // Submit the login request to authenticate the user.
                AuthenticationStatus loginRequest = loginClient.Authenticate
                    (CustomerAPIkey, Password, UserAPIkey, UserName, out Message, 
out AuthenticationToken);
                if (loginRequest == AuthenticationStatus.Ok)
                    // User is authenticated and the authentication token is provided.
                    Console.WriteLine("User authentication successful.");
                    // Find employees
                    FindPerson(CustomerAPIkey, AuthenticationToken);
                    // User authentication has failed. Review the message for details.
                    Console.WriteLine("User authentication failed: " + Message);
                Console.WriteLine("Press a key to exit");
            catch (Exception ex)
                Console.WriteLine("Exception:" + ex);
        static void FindPerson(string CustomerAPI, string Token)
            // Create a proxy to the person service.
            EmployeePersonClient proxyPerson = 
                new EmployeePersonClient("WSHttpBinding_IEmployeePerson");
                // Add the headers for the Customer API key and authentication token.
                using (new OperationContextScope(proxyPerson.InnerChannel))
(MessageHeader.CreateHeader("ClientAccessKey", "http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey", CustomerAPI));
                    // Create a query object to find the employees.
                    EmployeeQuery pQuery = new EmployeeQuery();
                    // Set one or more properties to search.
                    pQuery.LastName = "LIKE (ba%)";
                    pQuery.FullOrPartTime = "=F";
             // Set paging properties  
             pQuery.PageSize = 10;
                    pQuery.PageNumber = 1;
                    // Search for the employees.
                    PersonFindResponse response = proxyPerson.FindPeople(pQuery);
                    // Check the results of the find to see if there are any errors.
                    if (response.OperationResult.HasErrors)
                        // Review each error.
                        foreach (OperationMessage message in 
                            Console.WriteLine("Error message: " + message.Message);
                        // If employee records are returned, 
loop through the results and write out the data.
                        Array employees = response.Results;
                        foreach (EmployeePerson employee in employees)
                            foreach (Person person in employee.People)
                                Console.WriteLine("Name:" + person.LastName + "," + 
   var pagingInfo = response.OperationResult.PagingInfo;
   Console.WriteLine("The employee query returned a total of " +
pagingInfo.TotalItems + " records.");
   Console.WriteLine("The employee query returned a total of " +
                    pagingInfo.PageTotal + " pages.");
                        Console.WriteLine("Each page contains " + pagingInfo.PageSize +
   Console.WriteLine("The Results contain the records for page " +
                           pagingInfo.CurrentPage + ".");
            catch (Exception ex)
                Console.WriteLine("Exception:" + ex);
// Example Quick Start Code End

XML Examples

Authentication Service (http://<address>/services/LoginService)
The Authentication Service is required to get the Token needed for all Core Web Service Calls. Please refer to the UKG Pro Login Service API Guide for further information.


  <s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">
  <a:Action s:mustUnderstand="1">http://www.ultimatesoftware.com/services/employeeperson/IEmployeePerson/FindPeople</a:Action> 
  <ultiproToken xmlns="http://www.ultimatesoftware.com/foundation/authentication/ultiproToken">e477967b-aa38-4187-a1a9-0849a8aab891</ultiproToken> 
  <ClientAccessKey xmlns="http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey">CAN12</ClientAccessKey> 
  <FindPeople xmlns="http://www.ultimatesoftware.com/services/employeeperson">
  <query xmlns:b="http://www.ultimatesoftware.com/contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <b:CompanyCode /> 
  <b:CompanyName /> 
  <b:Country /> 
  <b:EmployeeNumber /> 
  <b:FirstName>like (a%)</b:FirstName> 
  <b:FormerName /> 
  <b:FullOrPartTime /> 
  <b:Job /> 
  <b:LastHire /> 
  <b:LastName /> 
  <b:Location /> 
  <b:OrganizationLevel1 /> 
  <b:OrganizationLevel2 /> 
  <b:OrganizationLevel3 /> 
  <b:OrganizationLevel4 /> 
  <b:OriginalHire /> 
  <b:PageNumber /> 
  <b:PageSize /> 
  <b:PayGroup /> 
  <b:Status /> 
  <b:SupervisorLastName /> 
  <b:TerminationDate /> 
  <b:TimeClockId /> 


  <s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">
  <a:Action s:mustUnderstand="1">http://www.ultimatesoftware.com/services/employeeperson/IEmployeePerson/GetPersonByEmployeeIdentifier</a:Action> 
  <ultiproToken xmlns="http://www.ultimatesoftware.com/foundation/authentication/ultiproToken">e477967b-aa38-4187-a1a9-0849a8aab891</ultiproToken> 
  <ClientAccessKey xmlns="http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey">CAN12</ClientAccessKey> 
  <GetPersonByEmployeeIdentifier xmlns="http://www.ultimatesoftware.com/services/employeeperson">
  <employeeIdentifier xmlns:b="http://www.ultimatesoftware.com/contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="b:EmployeeNumberIdentifier">


  <s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">
  <a:Action s:mustUnderstand="1">http://www.ultimatesoftware.com/services/employeeperson/IEmployeePerson/UpdatePerson</a:Action> 
  <ultiproToken xmlns="http://www.ultimatesoftware.com/foundation/authentication/ultiproToken">e477967b-aa38-4187-a1a9-0849a8aab891</ultiproToken> 
  <ClientAccessKey xmlns="http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey">CAN12</ClientAccessKey> 
  <UpdatePerson xmlns="http://www.ultimatesoftware.com/services/employeeperson">
  <entities xmlns:b="http://www.ultimatesoftware.com/contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
 <b:AlternateEmailAddress>[email protected]</b:AlternateEmailAddress> 
  <b:EmailAddress i:nil="true" /> 
  <b:EmployeeIdentifier i:type="b:EmployeeNumberIdentifier">
  <b:FirstName i:nil="true" /> 
  <b:FormerLastName i:nil="true" /> 
  <b:LastName i:nil="true" /> 
  <b:MiddleName i:nil="true" /> 
  <b:Prefix i:nil="true" /> 
  <b:SSN i:nil="true" /> 
  <b:SelfServiceProperties xmlns:c="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <c:Key /> 
  <c:Value /> 
  <b:Suffix i:nil="true" />