UKG Pro Web Service API Guide

Employee Phone Service

Introduction

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

This document is intended for individuals who are familiar with software development and web service technologies.

Employee Phone Service API

The UKG Pro Employee Phone Service API enables the user to programmatically retrieve and update Employee Phone in UKG Pro.

Overview

This document describes the methods of the service and provides code examples using Microsoft’s Visual Studio 2010 using C# as well as XML examples.

The following information describes the service requirements.


Service Specifications
Protocol	Simple Object Access Protocol (SOAP) 1.2
SSL Support	Required


Signup and Licensing
Signup requirements	Web Services Product Key
Account Required	UKG Pro Web User or UKG Pro Site Admin with API keys

Employee Phone Object

The Employee Phone object includes the following properties.


Property	Field DataType	Validations
HomeNumber	Varchar(50)	Numeric, max length 10
HomeNumberCountry	Char(3)	USA or CAN only
HomeNumberIsPrivate	Boolean
WorkNumber	Varchar(50)	Numeric, max length 10
WorkNumberCountry	Char(3)	USA or CAN only
WorkNumberExtension	Varchar(10)
AlternateNumber
Country	Char(3)	USA or CAN only
CountryPrefix	Varchar(10)
Extension	Varchar(10)
IsPrivate	Boolean
Number	Varchar(50)	Numeric, max length 10
NumberId	ID
Type	Char(3)	Code value

Quick Start

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

Prerequisites

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

UKG Pro Web service account and password
User API key and Customer API key from the UKG Pro Web service administrative page

Methods

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

FindPhoneInformations

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.

GetPhoneInformationByEmployeeIdentifier

This method allows you to retrieve an individual employee’s phone information by providing an employee identifier.

UpdatePhoneInformation

This method allows you to update employee phone information.

CreateAlternateNumber

This method allows you to create a new alternate phone number record.

DeleteAlternateNumber

This method allows you to delete an alternate phone number record.

C# Example

Generate the Service Reference

Once you have a user and API keys, you need to create a service reference to the EmployeePhone Service and the Login 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.

Example Code

The following code is an example of retrieving Employee Phone 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.

UserName = "YOUR WEB USER NAME ",
Password = "YOUR PASSWORD",
UserAPIkey = "YOUR USER API KEY",
CustomerAPIkey = "YOUR CUSTOMER API KEY"

//Example Quick Start Code Begin

namespace PhoneInformationSample
{
    using System;
    using System.Linq;
    using System.ServiceModel;
    using System.ServiceModel.Channels;
    using Login;
    using UltiProEmployeePhoneInformation;

    public class Program
    {
        static void Main(string[] args)
        {
            // Setup your user credentials.
            const string userName = "YOUR WEB USER NAME";
            const string password = "YOUR PASSWORD";
            const string userApiKey = "YOUR USER API KEY";
            const string customerApiKey = "YOUR CUSTOMER API KEY";

            // Create a proxy to the login service.
            LoginServiceClient loginClient = null;

            try
            {
                loginClient = new LoginServiceClient("WSHttpBinding_ILoginService");

                // Submit the login request to authenticate the user.
                string message = "";
                string authenticationToken = "";
                AuthenticationStatus loginStatus = loginClient.Authenticate(customerApiKey, password, userApiKey, userName, out message, out authenticationToken);

                if (loginStatus == AuthenticationStatus.Ok)
                {
                    // User is authenticated and the authentication token is provided.
                    Console.WriteLine("User authentication was successful.\n");

                    // Find Employees
                    Console.WriteLine("----------Start Find----------");
                    FindPhoneInformation(customerApiKey, authenticationToken);
                    Console.WriteLine("----------End Find----------\n");

                    // Get Phone Information
                    Console.WriteLine("----------Start Get----------");
                    GetPhoneInformation(customerApiKey, authenticationToken);
                    Console.WriteLine("----------End Get----------\n");

                    // Update Phone Information
                    Console.WriteLine("----------Start Update----------");
                    UpdatePhoneInformation(customerApiKey, authenticationToken);
                    Console.WriteLine("----------End Update----------\n");

                    // Create Alternate Number
                    Console.WriteLine("----------Start Create----------");
                    CreateAlternateNumber(customerApiKey, authenticationToken);
                    Console.WriteLine("----------End Create----------\n");

                    // Get Phone Information
                    Console.WriteLine("----------Start Get----------");
                    GetPhoneInformation(customerApiKey, authenticationToken);
                    Console.WriteLine("----------End Get----------\n");

                    // Delete Alternate Number
                    Console.WriteLine("----------Start Delete----------");
                    DeleteAlternateNumber(customerApiKey, authenticationToken);
                    Console.WriteLine("----------End Delete----------\n");

                    // Get Phone Information
                    Console.WriteLine("----------Start Get----------");
                    GetPhoneInformation(customerApiKey, authenticationToken);
                    Console.WriteLine("----------End Get----------\n");
                }
                else
                {
                    // User authentication has failed. Review the message for details.
                    Console.WriteLine("User authentication failed: " + message);
                }

                loginClient.Close();
                Console.WriteLine("Press a key to exit");
                Console.ReadKey(true);

            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }
            finally
            {
                if (loginClient != null)
                {
                    loginClient.Close();
                }
            }
        }

        static void FindPhoneInformation(string customerApiKey, string authenticationToken)
        {
            EmployeePhoneInformationClient proxy = null;
            try
            {
                // Create a proxy to the EmployeePhoneInformation service.
                proxy = new EmployeePhoneInformationClient("WSHttpBinding_IEmployeePhoneInformation");

                // Add the headers for the Customer api key and authentication token.
                using (new OperationContextScope(proxy.InnerChannel))
                {
                    OperationContext.Current.OutgoingMessageHeaders
                                    .Add(MessageHeader
                                    .CreateHeader("UltiProToken",
                                                  "http://www.ultimatesoftware.com/foundation/authentication/ultiprotoken",
                                                  authenticationToken));

                    OperationContext.Current.OutgoingMessageHeaders
                                    .Add(MessageHeader
                                    .CreateHeader("ClientAccessKey",
                                                  "http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey",
                                                  customerApiKey));

                    // Create a query object to find the employees.
                    EmployeeQuery query = new EmployeeQuery();

                    // Set one or more properties to search.
                    query.LastName = "LIKE (ba%)";
                    query.FullOrPartTime = "=F";

                    // Set paging properties
                    query.PageSize = "10";
                    query.PageNumber = "1";

                    // Search for the employees.
                    PhoneInformationFindResponse response = proxy.FindPhoneInformations(query);

                    // Check the results of the find to see if there are any errors.
                    if (response.OperationResult.HasErrors)
                    {
                        // Review each error.
                        foreach (OperationMessage message in response.OperationResult.Messages)
                        {
                            Console.WriteLine("Error message: " + message.Message);
                        }
                    }
                    else
                    {
                        // If employee records are returned,
                        // loop through the results and write out the data.
                        EmployeePhoneInformation[] employees = response.Results;

                        foreach (EmployeePhoneInformation employee in employees)
                        {
                            Console.WriteLine("Employee: " + employee.FirstName + " " + employee.LastName);

                            foreach (PhoneInformation phoneInformation in employee.PhoneInformations)
                            {
                                Console.WriteLine("\tHome Number: " + phoneInformation.HomeNumber);
                                Console.WriteLine("\tWork Number: " + phoneInformation.WorkNumber);

                                foreach (AlternateNumber alternateNumber in phoneInformation.AlternateNumbers)
                                {
                                    Console.WriteLine("\tAlternate Number: " + alternateNumber.Number);
                                }
                            }
                        }

                        if (employees.Length > 0)
                        {
                            Console.WriteLine("Find was successful.");
                        }
                        else
                        {
                            Console.WriteLine("No employees were found for the provided EmployeeQuery.");
                        }

                        var pagingInfo = response.OperationResult.PagingInfo;

                        Console.WriteLine("\nPaging Information:");
                        Console.WriteLine("\tThe employee query returned a total of " + pagingInfo.TotalItems + " records.");
                        Console.WriteLine("\tThe employee query returned a total of " + pagingInfo.PageTotal + " pages.");
                        Console.WriteLine("\tEach page contains " + pagingInfo.PageSize + " records.");
                        Console.WriteLine("\tThe Results contain the records for page " + pagingInfo.CurrentPage + ".");
                    }
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }
            finally
            {
                if (proxy != null)
                {
                    proxy.Close();
                }
            }
        }

        static void GetPhoneInformation(string customerApiKey, string authenticationToken)
        {
            EmployeePhoneInformationClient proxy = null;
            try
            {
                // Create a proxy to the EmployeePhoneInformation service.
                proxy = new EmployeePhoneInformationClient("WSHttpBinding_IEmployeePhoneInformation");

                // Add the headers for the Customer api key and authentication token.
                using (new OperationContextScope(proxy.InnerChannel))
                {
                    OperationContext.Current.OutgoingMessageHeaders
                        .Add(MessageHeader.CreateHeader("UltiProToken",
                            "http://www.ultimatesoftware.com/foundation/authentication/ultiprotoken",
                            authenticationToken));
                    OperationContext.Current.OutgoingMessageHeaders
                        .Add(MessageHeader.CreateHeader("ClientAccessKey",
                            "http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey",
                            customerApiKey));

                    // Define employee whose phone information you want to get.
                    EmployeeIdentifier employeeIdentifier = new EmployeeNumberIdentifier
                                                                {
                                                                    CompanyCode = "C0013",
                                                                    EmployeeNumber = "638945004"
                                                                };
                    // Get the phone information.
                    PhoneInformationGetResponse response =
                        proxy.GetPhoneInformationByEmployeeIdentifier(employeeIdentifier);

                    // Check the results of the get to see if there are any errors.
                    if (response.OperationResult.HasErrors)
                    {
                        // Review each error.
                        foreach (OperationMessage message in response.OperationResult.Messages)
                        {
                            Console.WriteLine("Error message: " + message.Message);
                        }
                    }
                    else
                    {
                        // If we did not get any errors then 1 phone information
                        // or no phone information was found.
                        if (response.Results.Length > 0)
                        {
                            // One phone information was found.
                            Console.WriteLine("Phone Information:");

                            PhoneInformation phoneInformation = response.Results[0];
                            Console.WriteLine("\tHome Number: " + phoneInformation.HomeNumber);
                            Console.WriteLine("\tWork Number: " + phoneInformation.WorkNumber);
                            Console.WriteLine("\tAlternate Numbers: " + phoneInformation.WorkNumber);

                            foreach (var alternateNumber in phoneInformation.AlternateNumbers)
                            {
                                Console.WriteLine("\t\tAlternate Number Id: " + alternateNumber.NumberId);
                                Console.WriteLine("\t\tAlternate Number: " + alternateNumber.Number);
                            }

                            Console.WriteLine("Get was Successful.");
                        }
                        else
                        {
                            // No phone information was found for this employee.
                            Console.WriteLine(string.Format("No phone information was found for employee with Employee Number = {0} and Company Code = {1}",
                                ((EmployeeNumberIdentifier)employeeIdentifier).EmployeeNumber, employeeIdentifier.CompanyCode));
                        }
                    }
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }
            finally
            {
                if (proxy != null)
                {
                    proxy.Close();
                }
            }
        }

        static void UpdatePhoneInformation(string customerApiKey, string authenticationToken)
        {
            EmployeePhoneInformationClient proxy = null;
            try
            {
                // Create a proxy to the EmployeePhoneInformation service.
                proxy = new EmployeePhoneInformationClient("WSHttpBinding_IEmployeePhoneInformation");

                // Add the headers for the Customer api key and authentication token.
                using (new OperationContextScope(proxy.InnerChannel))
                {
                    OperationContext.Current.OutgoingMessageHeaders
                        .Add(MessageHeader.CreateHeader("UltiProToken",
                            "http://www.ultimatesoftware.com/foundation/authentication/ultiprotoken",
                            authenticationToken));
                    OperationContext.Current.OutgoingMessageHeaders
                        .Add(MessageHeader.CreateHeader("ClientAccessKey",
                            "http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey",
                            customerApiKey));

                    // Define employee whose phone information you want to update.
                    EmployeeIdentifier employeeIdentifier = new EmployeeNumberIdentifier
                                                                {
                                                                    CompanyCode = "C0013",
                                                                    EmployeeNumber = "638945004"
                                                                };
                    // Get the phone information.
                    PhoneInformationGetResponse getResponse =
                        proxy.GetPhoneInformationByEmployeeIdentifier(employeeIdentifier);

                    // Check the results of the get to see if there are any errors.
                    if (getResponse.OperationResult.HasErrors)
                    {
                        // Review each error.
                        foreach (OperationMessage message in getResponse.OperationResult.Messages)
                        {
                            Console.WriteLine("Error message: " + message.Message);
                        }
                    }
                    else
                    {
                        // If we did not get any errors then 1 phone information
                        // or no phone information was found.
                        if (getResponse.Results.Length > 0)
                        {
                            // One phone information was found.
                            PhoneInformation phoneInformation = getResponse.Results[0];

                            Console.WriteLine("Phone information to be updated was found.");

                            // Update phone information.
                            phoneInformation.HomeNumber = "2225556677";
                            phoneInformation.HomeNumberCountry = "CAN";
                            phoneInformation.HomeNumberIsPrivate = true;

                            PhoneInformationUpdateResponse updateResponse = proxy.UpdatePhoneInformation(new[] { phoneInformation });

                            // Check the results to see if the update was successful.
                            if (updateResponse.HasErrors)
                            {
                                if (updateResponse.OperationResult.HasErrors)
                                {
                                    // Review each operation error.
                                    foreach (OperationMessage message in updateResponse.OperationResult.Messages)
                                    {
                                        Console.WriteLine("Operation Error Message: " + message.Message);
                                    }
                                }

                                // Review each result errors.
                                foreach (Result result in updateResponse.Results.Where(r => r.HasErrors))
                                {
                                    // Review messages for this result error.
                                    foreach (OperationMessage message in result.Messages)
                                    {
                                        Console.WriteLine("Result " + result.RequestNumber
                                            + " Error Message: " + message.Message);
                                    }
                                }
                            }
                            else
                            {
                                // The update was successful.
                                Console.WriteLine("Update was successful.");
                            }
                        }
                        else
                        {
                            // No phone information was found for this employee.
                            Console.WriteLine(string.Format("No phone information was found for employee with Employee Number = {0} and Company Code = {1}",
                                ((EmployeeNumberIdentifier)employeeIdentifier).EmployeeNumber, employeeIdentifier.CompanyCode));
                        }
                    }
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }
            finally
            {
                if (proxy != null)
                {
                    proxy.Close();
                }
            }
        }

        static void CreateAlternateNumber(string customerApiKey, string authenticationToken)
        {
            EmployeePhoneInformationClient proxy = null;
            try
            {
                // Create a proxy to the EmployeePhoneInformation service.
                proxy = new EmployeePhoneInformationClient("WSHttpBinding_IEmployeePhoneInformation");

                // Add the headers for the Customer api key and authentication token.
                using (new OperationContextScope(proxy.InnerChannel))
                {
                    OperationContext.Current.OutgoingMessageHeaders
                        .Add(MessageHeader.CreateHeader("UltiProToken",
                            "http://www.ultimatesoftware.com/foundation/authentication/ultiprotoken",
                            authenticationToken));
                    OperationContext.Current.OutgoingMessageHeaders
                        .Add(MessageHeader.CreateHeader("ClientAccessKey",
                            "http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey",
                            customerApiKey));

                    // Define employee for whom you want to create an alternate number.
                    EmployeeIdentifier employeeIdentifier = new EmployeeNumberIdentifier
                    {
                        CompanyCode = "C0013",
                        EmployeeNumber = "638945004"
                    };

                    AlternateNumber alternateNumber = new AlternateNumber
                                                          {
                                                              Country = "ARG",
                                                              Number = "4447778899",
                                                              Type = "CEL"
                                                          };

                    PhoneInformationCreateResponse response = proxy.CreateAlternateNumber(new[] { alternateNumber }, employeeIdentifier);

                    // Check the results to see if the create was successful.
                    if (response.HasErrors)
                    {
                        if (response.OperationResult.HasErrors)
                        {
                            // Review each operation error.
                            foreach (OperationMessage message in response.OperationResult.Messages)
                            {
                                Console.WriteLine("Operation Error Message: " + message.Message);
                            }
                        }

                        // Review each result errors.
                        foreach (Result result in response.Results.Where(r => r.HasErrors))
                        {
                            // Review messages for this result error.
                            foreach (OperationMessage message in result.Messages)
                            {
                                Console.WriteLine("Result " + result.RequestNumber
                                    + " Error Message: " + message.Message);
                            }
                        }
                    }
                    else
                    {
                        // The create was successful.
                        Console.WriteLine("Create of alternate number was successful.");
                    }
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }
            finally
            {
                if (proxy != null)
                {
                    proxy.Close();
                }
            }
        }

        static void DeleteAlternateNumber(string customerApiKey, string authenticationToken)
        {
            EmployeePhoneInformationClient proxy = null;
            try
            {
                // Create a proxy to the EmployeePhoneInformation service.
                proxy = new EmployeePhoneInformationClient("WSHttpBinding_IEmployeePhoneInformation");

                // Add the headers for the Customer api key and authentication token.
                using (new OperationContextScope(proxy.InnerChannel))
                {
                    OperationContext.Current.OutgoingMessageHeaders
                        .Add(MessageHeader.CreateHeader("UltiProToken",
                                                        "http://www.ultimatesoftware.com/foundation/authentication/ultiprotoken",
                                                        authenticationToken));
                    OperationContext.Current.OutgoingMessageHeaders
                        .Add(MessageHeader.CreateHeader("ClientAccessKey",
                                                        "http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey",
                                                        customerApiKey));

                    // Define employee for whom you want to delete an alternate number.
                    EmployeeIdentifier employeeIdentifier = new EmployeeNumberIdentifier
                                                                {
                                                                    CompanyCode = "C0013",
                                                                    EmployeeNumber = "638945004"
                                                                };

                    // Get the phone information for this employee.
                    PhoneInformationGetResponse getResponse =
                        proxy.GetPhoneInformationByEmployeeIdentifier(employeeIdentifier);

                    // Check the results of the get to see if there are any errors.
                    if (getResponse.OperationResult.HasErrors)
                    {
                        // Review each error.
                        foreach (OperationMessage message in getResponse.OperationResult.Messages)
                        {
                            Console.WriteLine("Error message: " + message.Message);
                        }
                    }
                    else
                    {
                        // If we did not get any errors then 1 phone information
                        // or no phone information was found.
                        if (getResponse.Results.Length > 0)
                        {
                            // One phone information was found.
                            PhoneInformation phoneInformation = getResponse.Results[0];

                            // Get alternate number to delete from employee's phone information.
                            AlternateNumber alternateNumber = null;
                            if (phoneInformation.AlternateNumbers.Length > 0)
                            {
                                // Save alternate number to delete
                                alternateNumber = phoneInformation.AlternateNumbers[0];
                                Console.WriteLine("Alternate number to be deleted was found:");
                                Console.WriteLine("\tAlternate Number Id: " + alternateNumber.NumberId);
                            }
                            else
                            {
                                Console.WriteLine("This employee does not have an alternate number to delete.");
                            }

                            if (alternateNumber != null)
                            {
                                // Delete alternate number
                                PhoneInformationDeleteResponse deleteResponse =
                                    proxy.DeleteAlternateNumber(new[] { alternateNumber }, employeeIdentifier);

                                // Check the results to see if the delete was successful.
                                if (deleteResponse.HasErrors)
                                {
                                    if (deleteResponse.OperationResult.HasErrors)
                                    {
                                        // Review each operation error.
                                        foreach (OperationMessage message in deleteResponse.OperationResult.Messages)
                                        {
                                            Console.WriteLine("Operation Error Message: " + message.Message);
                                        }
                                    }

                                    // Review each result errors.
                                    foreach (Result result in deleteResponse.Results.Where(r => r.HasErrors))
                                    {
                                        // Review messages for this result error.
                                        foreach (OperationMessage message in result.Messages)
                                        {
                                            Console.WriteLine("Result " + result.RequestNumber
                                                              + " Error Message: " + message.Message);
                                        }
                                    }
                                }
                                else
                                {
                                    // The delete was successful.
                                    Console.WriteLine("Delete of alternate number was successful.");
                                }
                            }
                        }
                        else
                        {
                            // No phone information was found for this employee.
                            Console.WriteLine(
                                string.Format(
                                    "No phone information was found for employee with Employee Number = {0} and Company Code = {1}",
                                    ((EmployeeNumberIdentifier)employeeIdentifier).EmployeeNumber,
                                    employeeIdentifier.CompanyCode));
                        }
                    }
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }
            finally
            {
                if (proxy != null)
                {
                    proxy.Close();
                }
            }
        }
    }
}


// Example Quick Start Code End

XML Examples

The Authentication Service (http://<address>/services/LoginService) 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.

FindEmployeePhone

<s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Header>
  <a:Action s:mustUnderstand="1">http://www.ultipro.com/services/employeephoneinformation/IEmployeePhoneInformation/FindPhoneInformations</a:Action> 
    <UltiProToken xmlns="http://www.ultimatesoftware.com/foundation/authentication/ultiprotoken">7ffdbe24-c89f-4d09-b92a-ead6e956f40c</UltiProToken> 
    <ClientAccessKey xmlns="http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey">CAN12</ClientAccessKey> 
   </s:Header>
   <s:Body>
    <FindPhoneInformations xmlns="http://www.ultipro.com/services/employeephoneinformation">
      <query xmlns:b="http://www.ultipro.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 /> 
      </query>
    </FindPhoneInformations>
  </s:Body>
</s:Envelope>

GetEmployeePhoneByEmployeeIdentifier

<s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Header>
  <a:Action s:mustUnderstand="1">http://www.ultipro.com/services/employeephoneinformation/IEmployeePhoneInformation/GetPhoneInformationByEmployeeIdentifier</a:Action> 
    <UltiProToken xmlns="http://www.ultimatesoftware.com/foundation/authentication/ultiprotoken">7ffdbe24-c89f-4d09-b92a-ead6e956f40c</UltiProToken> 
    <ClientAccessKey xmlns="http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey">CAN12</ClientAccessKey> 
  </s:Header>
  <s:Body>
    <GetPhoneInformationByEmployeeIdentifier xmlns="http://www.ultipro.com/services/employeephoneinformation">
      <employeeIdentifier xmlns:b="http://www.ultipro.com/contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="b:EmployeeNumberIdentifier">
        <b:CompanyCode>C0014</b:CompanyCode> 
        <b:EmployeeNumber>555667788</b:EmployeeNumber> 
      </employeeIdentifier>
    </GetPhoneInformationByEmployeeIdentifier>
  </s:Body>
</s:Envelope>

UpdateEmployeePhone

<s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Header>
  <a:Action s:mustUnderstand="1">http://www.ultipro.com/services/employeephoneinformation/IEmployeePhoneInformation/UpdatePhoneInformation</a:Action> 
    <UltiProToken xmlns="http://www.ultimatesoftware.com/foundation/authentication/ultiprotoken">7ffdbe24-c89f-4d09-b92a-ead6e956f40c</UltiProToken> 
    <ClientAccessKey xmlns="http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey">CAN12</ClientAccessKey> 
    <a:MessageID>urn:uuid:89a8f26c-659d-4784-8f49-0c3d11f08bab</a:MessageID> 
    <a:ReplyTo>
      <a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address> 
    </a:ReplyTo>
 </s:Header>
 <s:Body>
   <UpdatePhoneInformation xmlns="http://www.ultipro.com/services/employeephoneinformation">
     <entities xmlns:b="http://www.ultipro.com/contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <b:PhoneInformation>
          <b:AlternateNumbers /> 
          <b:EmployeeIdentifier i:type="b:EmployeeNumberIdentifier">
            <b:CompanyCode>C0014</b:CompanyCode> 
            <b:EmployeeNumber>555667788</b:EmployeeNumber> 
          </b:EmployeeIdentifier>
          <b:HomeNumber>5556669999</b:HomeNumber> 
          <b:HomeNumberCountry>USA</b:HomeNumberCountry> 
          <b:HomeNumberIsPrivate>false</b:HomeNumberIsPrivate> 
          <b:WorkNumber>5551112222</b:WorkNumber> 
          <b:WorkNumberCountry>USA</b:WorkNumberCountry> 
          <b:WorkNumberExtension>1234</b:WorkNumberExtension> 
        </b:PhoneInformation>
      </entities>
    </UpdatePhoneInformation>
  </s:Body>
</s:Envelope>

CreateAlternateNumber

<s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">
  <s:Header>
    <a:Action s:mustUnderstand="1">http://www.ultipro.com/services/employeephoneinformation/IEmployeePhoneInformation/CreateAlternateNumber</a:Action> 
    <UltiProToken xmlns="http://www.ultimatesoftware.com/foundation/authentication/ultiprotoken">7ffdbe24-c89f-4d09-b92a-ead6e956f40c</UltiProToken> 
    <ClientAccessKey xmlns="http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey">CAN12</ClientAccessKey> 
  </s:Header>
  <s:Body>
    <CreateAlternateNumber xmlns="http://www.ultipro.com/services/employeephoneinformation">
      <entities xmlns:b="http://www.ultipro.com/contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <b:AlternateNumber>
          <b:Country>USA</b:Country> 
          <b:CountryPrefix i:nil="true" /> 
          <b:Extension i:nil="true" /> 
          <b:IsPrivate>true</b:IsPrivate> 
          <b:Number>5558887777</b:Number> 
          <b:NumberId i:nil="true" /> 
          <b:Type>CEL</b:Type> 
        </b:AlternateNumber>
      </entities>
      <employeeIdentifier xmlns:b="http://www.ultipro.com/contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="b:EmployeeNumberIdentifier">
        <b:CompanyCode>C0014</b:CompanyCode> 
        <b:EmployeeNumber>555667788</b:EmployeeNumber> 
      </employeeIdentifier>
    </CreateAlternateNumber>
  </s:Body>
</s:Envelope>

DeleteAlternateNumber

<s:Envelope xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:s="http://www.w3.org/2003/05/soap-envelope">
  <s:Header>
    <a:Action s:mustUnderstand="1">http://www.ultipro.com/services/employeephoneinformation/IEmployeePhoneInformation/DeleteAlternateNumber</a:Action> 
    <UltiProToken xmlns="http://www.ultimatesoftware.com/foundation/authentication/ultiprotoken">7ffdbe24-c89f-4d09-b92a-ead6e956f40c</UltiProToken> 
    <ClientAccessKey xmlns="http://www.ultimatesoftware.com/foundation/authentication/clientaccesskey">CAN12</ClientAccessKey> 
  </s:Header>
  <s:Body>
    <DeleteAlternateNumber xmlns="http://www.ultipro.com/services/employeephoneinformation">
      <entities xmlns:b="http://www.ultipro.com/contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <b:AlternateNumber>
          <b:Country i:nil="true" /> 
          <b:CountryPrefix i:nil="true" /> 
          <b:Extension i:nil="true" /> 
          <b:IsPrivate>false</b:IsPrivate> 
          <b:Number i:nil="true" /> 
          <b:NumberId>9JC2JP0000K0</b:NumberId> 
          <b:Type i:nil="true" /> 
        </b:AlternateNumber>
      </entities>
      <employeeIdentifier xmlns:b="http://www.ultipro.com/contracts" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="b:EmployeeNumberIdentifier">
        <b:CompanyCode>C0014</b:CompanyCode> 
        <b:EmployeeNumber>555667788</b:EmployeeNumber> 
      </employeeIdentifier>
    </DeleteAlternateNumber>
  </s:Body>
</s:Envelope>

© UKG Inc. All rights reserved. For a full list of UKG trademarks, visit www.ukg.com/trademarks. All other trademarks, if any, are the property of their respective owners. No part of this document or its content may be reproduced in any form or by any means or stored in a database or retrieval system without the prior written authorization of UKG Inc. (“UKG”). Information in this document is subject to change without notice. The document and its content are confidential information of UKG and may not be disseminated to any third party. Nothing herein constitutes legal advice, tax advice, or any other advice. All legal or tax questions or concerns should be directed to your legal counsel or tax consultant.

Liability/Disclaimer

UKG makes no representation or warranties with respect to the accuracy or completeness of the document or its content and specifically disclaims any responsibility or representation for other vendors’ software. The terms and conditions of your agreement with us regarding the software or services provided by us, which is the subject of the documentation contained herein, govern this document or content. All company, organization, person, and event references are fictional. Any resemblance to actual companies, organizations, persons, and events is entirely coincidental.

Links to Other Materials: The linked sites and embedded links are not under the control of UKG. We reserve the right to terminate any link or linking program at any time. UKG does not endorse companies or products to which it links. If you decide to access any of the third-party sites linked to the site, you do so entirely at your own risk.