UKG Pro Pending Hire Service API Guide

Pending Hire Service API Overview

Introduction

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

This document describes the methods of the service and provides examples for how to use the Pending Hire web service. This is intended for individuals who are familiar with software development and web service technologies.

Service Specifications

Protocol: HTTP (REST)
SSL Support: Required

Account and Licensing

Account Required:
One of the following is required:
- UKG Pro Web Service Account, or
- UKG Pro Web User with Web Services Permissions
Using a UKG Pro Web Service Account is recommended. For information regarding establishing and maintaining a UKG Pro Web Service Account, refer to the Manage Service Accounts guide located in the UKG Pro Learning Center Home > Content > System Management > Web Services.

Pending Hire Service API Data

The UKG Pro Pending Hire Service API enables you to load pending hire information into UKG Pro for processing.

Pending Hire Data

Table 1. Pending Hire Detail

Property	Required	Data Type	Max Length	Notes
ID	See Notes	Integer		Required if updating a record
OfferID	N	String	15
RequisitionID	N	String	50
CandidateKey		GUID
ImportedBy	N	String	30
ImportDate	N	DateTime		Read-only from GET

Table 2. Employee Hire Data

Property	Required	Data Type	Min Length	Max Length	Notes
CompanyId	N	String	5	5
SsnOrSin	N	String	0	50
SinExpirationDate	N	DateTime			1/1/1881 – 12/31/2199
NamePrefixCode	N	String		50	UKG Pro Code (PREFIX)
NameFirst	Y	String	1	100
NameMiddle	N	String	1	50
NameLast	Y	String	1	100
NamePreferred	N	String	1	100
NameSuffixCode	N	String	1	50	UKG Pro Code (SUFFIX)
FormerLastname	N	String	0	100
EmployeeNumber	N	String	1	9
TimeclockId	N	String		12
AddressLine1	N	String	1	255
AddressLine2	N	String	1	255
City	N	String	1	255
StateOrProvinceCode	N	String	0	255
ZipOrPostalCode	N	String	0	50
AddressCounty	N	String	0	255
AddressCountryCode	N	String	0	3
MailStop	N	String	0	10
HomePhoneNumber	N	String	0	50
BusinessPhoneNumber	N	String	0	10
BusinessPhoneExtension	N	String	0	5
OtherPhoneNumber	N	String	0	50
OtherPhoneTypeCode	N	String	1	50	UKG Pro Code (OTHERPHONE)
PrimaryEmailAddress	N	String	1	50
AlternateEmailAddress	N	String	1	50
DateOfBirth	N	DateTime			1/1/1881 – 12/31/2199
GenderCode	N	String	1	50	UKG Pro Code (GENDER)
MaritalStatusCode	N	String	1	50	UKG Pro Code (MARITALSTATUS)
EthnicCode	N	String	1	50	UKG Pro Code (ETHNICCODE2007)
I9VerifiedCode	N	String	1	50	UKG Pro Code (I9VERIF)
StartDate	N	DateTime			1/1/1881 – 12/31/2199
DateOfOriginalHire	N	DateTime			1/1/1881 – 12/31/2199
DateOfSeniority	N	DateTime			1/1/1881 – 12/31/2199
DateOfBenefitSeniority	N	DateTime			1/1/1881 – 12/31/2199
Supervisor	N	See notes			Employee Identifier

Sample:

{
  "Supervisor": {
    "Type": "Ssn",
    "Value": "369852147",
    "CompanyIdentifier": null
  }
}

Types available:

EmployeeId
EmployeeNumber
EmailAddress
SSN
SIN
NationalId

Property	Required	Data Type	Min Length	Max Length	Notes
JobGroupCode	N	String		5	UKG Pro Code (JOBGRP)
JobCode	See Notes	String			UKG Pro Code (JOBCODEBYCOUNTRY)
JobTitle	See Notes	String			See notes for JobCode
LocationCode	N	String	1	6	UKG Pro Code (TAXPRIMARYLOCATION)
HireSourceCode	N	String	1	6	UKG Pro Code (HIRESRCE)
OrgLevel1Code	N	String	1	6	UKG Pro Code (ORGLVL1)
OrgLevel2Code	N	String	1	6	UKG Pro Code (ORGLVL2)
OrgLevel3Code	N	String	1	6	UKG Pro Code (ORGLVL3)
OrgLevel4Code	N	String	1	6	UKG Pro Code (ORGLVL4)
PayRate	N	Decimal	1	Decimal Max	0.0 - 999999999.99
RatePerCode	N	String	1	50	UKG Pro Code (RATESPER)
PayGroupCode	N	String	1	6	UKG Pro Code (PAYGROUPBYCOMP)
ScheduledWorkHours	N	Double	0.0	99999999.0	0.0 - 99999999.0000
PaymentsPerYear	N	Integer	Int.Min	Int.Max
WeeklyHours	N	String	0.0	168.0
EarningsGroupCode	N	String	1	5	UKG Pro Code (EARNGRP)
DeductionBenefitGroupCode	N	String	1	5	UKG Pro Code (BENGRP)
EmployeeTypeCode	N	String	1	50	UKG Pro Code (EMPTYPE)
HourlyOrSalaryCode	N	String	1	50	UKG Pro Code (SALARYORHOURLY)
FullTimeOrPartTimeCode	N	String	1	50	UKG Pro Code (FULLORPARTTIME)
ShiftCode	N	String	1	2	UKG Pro Code (SHIFTSBYJOBANDGROUP)
PositionCode	N	String	1	8	UKG Pro Code (POSITION)
PersonId	N	GUID			UKG Pro PersonId to Use Onb10 Integration Only
CurrencyCode	N	String	1	3	Supported for Global hires

Pending Hire Data - Supplemental Data

Although supplemental data is not required and the section may be omitted, if you choose to submit supplemental data, there may be certain requirements that apply. These requirements are included below.

Table 3. Candidate Information - Military

Property	Required	Data Type	Max Length	Notes
MilitaryEraCode	N	String	50	UKG Pro Code (MILITARYERA)
MilitaryBranchServedCode	N	String	50	UKG Pro Code (MILITARY)
IsDisabled	Y	String		Yes/No/Decline
IsVeteran	Y	String		Yes/No/Decline
SeparationDate	N	DateTime		1/1/1881 – 12/31/2199
IsArmedForcesServiceMedal	N	String		Yes/No/Decline
IsSpecialDisabledVeteran	N	String		Yes/No/Decline
IsActiveWarTimeVet	N	String		Yes/No/Decline

Table 4. Contact Information

Property	Required	Data Type	Min Length	Max Length	Notes
NameFirst	Y	String	1	20
NameMiddle	N	String	1	50
NameLast	Y	String	1	30
NameSuffixCode	N	String			UKG Pro Code Validation
RelationshipCode	Y	String			UKG Pro Code Validation
CountryCode	Y	String			UKG Pro Code Validation
AddressLine1	Y	String		30
AddressLine2	Y	String		30
City	Y	String		30
StateOrProvinceCode	Y	String			UKG Pro Code Validation
ZipOrPostalCode	Y	String			USA: `@"^(\d{5})(\d{4})?$"` CAN: `@"^([a-z]\d){3}$"`
PreferredPhoneCode	Y	String			UKG Pro Code Validation
PhoneNumber	Y	String	1	10
EmailAddress	N	String	4	50	[email protected] format

Table 5. Direct Deposit - US

Property	Required	Data Type	Max Length	Notes
AccountNumber	Y	String	22
DepositRuleCode	Y	String		UKG Pro Code Validation
Amount	N	Decimal		Decimal.MaxValue Decimal.MinValue
RoutingNumber	Y	String	9
AccountTypeCode	Y	String		UKG Pro Code Validation

Table 6. Direct Deposit - Canada

Property	Required	Data Type	Min Length	Max Length	Notes
AccountNumber	Y	String	1	22
DepositRuleCode	Y	String			UKG Pro Code Validation
Amount	N	Decimal			Decimal.MaxValue Decimal.MinValue
BranchNumber	Y	String	1	5
InstitutionNumber	Y	String	1	3

Table 7. Education Information

Property	Required	Data Type	Min Length	Max Length	Notes
SchoolCode	Y	String		50	UKG Pro Code (SCHOOL)
FromDate	N	DateTime			1/1/1881 – 12/31/2199
ToDate	N	DateTime			1/1/1881 – 12/31/2199
Graduated	N	Boolean			True/False
Years	N	Integer	0	999	0 – Int32.MaxValue
MajorCode	N	String		50	UKG Pro Code (EDUCMAJOR)
MinorCode	N	String		50	UKG Pro Code (EDUCMAJOR)
Location	N	String		20
LevelCode	N	String		50	UKG Pro Code (EDUCLEVEL)
Gpa	N	Decimal			0 – 99999
Rank	N	Integer			0 – 999999
Notes	N	String	1	32,767	Characters for length

Table 8. Employment Details

Property	Required	Data Type	Min Length	Max Length	Notes
Employer	Y	String	1	30
FromDate	Y	DateTime			From Date must be less than To date 1/1/1881 – 12/31/2199
ToDate	Y	DateTime			From Date must be less than To date 1/1/1881 – 12/31/2199
Position	N	String	1	30
Location	N	String	1	20
Salary	N	Decimal			0 - 9999999999999.9 Required if SalaryPerCode is provided
SalaryPerCode	N	String			UKG Pro Code (SALARYPER) Required if Salary is provided
ReasonForLeaving	N	String	1	25
Notes	N	String	1	32,767	Character Length

Table 9. License Information

Property	Required	Data Type	Min Length	Max Length	Notes
LicenseCode	Y	String		6	UKG Pro Code (LICENSE)
LicenseNumber	N	String	1	20
ReceivedDate	N	DateTime			1/1/1881 – 12/31/2199
RenewalDate	N	DateTime			1/1/1881 – 12/31/2199
ProviderCode	N	String		6	UKG Pro Code (CAREPROVIDER)

Table 10. Onboarding Integration Data

Property	Required	Data Type
HiringManagerId	N	GUID
AssigneeId	N	GUID

Table 11. Skills Information

Property	Required	Data Type	Min Length	Max Length	Notes
SkillCode	Y	String		6	UKG Pro Codes (SKILLS)
ProficiencyCode	N	String		6	UKG Pro Codes (PROFICIENCY)
AssessedOnDate	N	DateTime			1/1/1881 – 12/31/2199 Required if AssessedBy is provided
AssessedBy	N	String	1	20	Required if AssessedOnDate is provided
Notes	N	String	1	32,767	Character length

Table 12. Taxes – US Federal Income Tax

Property	Required	Data Type	Min Length	Max Length
FilingStatusCode	Y	String
TotalAllowancesClaimed	N	Integer	0	999
AdditionalAmountWithheld	N	Decimal
IsExemptFromWithholding	N	Boolean
DeductionAmount	N	Decimal
DependentAmount	N	Decimal
OtherIncome	N	Decimal

Table 13. Taxes – US State Income Tax

Property	Required	Data Type	Min Length	Max Length
WorkInEmpTaxCalcOpt4	N	String
WorkInFilingStatusCode	Y	String
WorkInAllowancesClaimed	N	Integer	0	999
WorkInAdditionalAmountWithheld	N	Decimal
WorkInIsExemptFromWithholding	N	String
WorkInIsExemptFromTax	N	String
WorkInAdditionalAllowances	N	Integer	0	999
WorkInReducedAmountWithheld	N	Decimal	0	999
WorkInDeductionAmount	N	Decimal	0	999
WorkInDependentAmount	N	Decimal	0	999
WorkInOtherIncome	N	Decimal	0	999
ResidentEmpTaxCalcOpt4	N	String
ResidentFilingStatusCode	Y	String
ResidentAllowancesClaimed	Y	Integer	0	999
ResidentAdditionalAmountWithheld	N	Decimal
ResidentIsExemptFromWithholding	N	String
ResidentIsExemptFromTax	N	String
ResidentAdditionalAllowances	N	Integer	0	999
ResidentCounty	N	String
ResidentReducedAmountWithheld	N	Decimal	0	999
ResidentDeductionAmount	N	Decimal	0	999
ResidentDependentAmount	N	Decimal	0	999
ResidentOtherIncome	N	Decimal	0	999

Table 14. Taxes – Canada Federal Income Tax

Property	Required	Data Type
IsExemptFromIncomeTax	Y	String
UseBasicPersonalAmount	Y	String
IsTotalIncomeLessThanTotalClaimAmount	Y	String
PrescribedZoneResidenceDeduction	N	Decimal
AdditionalTaxDeduction	N	Decimal
TotalClaimAmount	N	Decimal

Table 15. Taxes – Canada Provincial Income Tax

Property	Required	Data Type
UseBasicPersonalAmount	Y	String
IsTotalIncomeLessThanTotalClaimAmount	Y	String
TotalClaimAmount	N	String

Table 16. User-Defined Fields

Property	Required	Data Type	Max Length
Document	N	String	255
FieldName	N	String	255
FieldExternalCode	N	String	255
Owner	N	String	255
Value	N	String	255

Pending Hire Service

To initially log in to the Pending Hire web service, the username and password for the UKG Pro Web Service Account or UKG Pro Web User can be sent for basic authorization.

The format is username:password. Use a colon between the username and password. Credentials in this format must then be encoded using standard base64 encoding.

Header

The initial call to the Pending Hire Service should contain a header as follows:

Basic Auth Example

Authorization: basic dXNlcm5hbWU6cGFzc3dvcmQ=
Accept: application/json
Content-Type: application/json
US-Customer-Api-Key: <YOUR COMPANY’S API KEY>

The return from this call will contain a US-SessionId. This token should be included in the header of subsequent calls to the service.

Example

US-SessionId: 1807a7d3-1fdd-4c14-835b-59b178a323ec
Accept: application/json
Content-Type: application/json
US-Customer-Api-Key: <YOUR COMPANY’S API KEY>

Pending Hire Data – GET

Pending hire data using the GET statement is included in this section.

Parameter	Description
GET	Returns the Pending Hire records that have not yet been processed in UKG Pro
Resource URL	https://servername/services/employeehire/v1/pendinghires

Sample Return from GET

{
    "odata.metadata": "https://servername/services/employeehire/v1/pendinghires/$metadata#employeependinghires",
    "value": [
        {
            "Id": 5,
            "OfferId": "",
            "RequisitionId": "",
            "ImportDate": "2013-08-09T10:46:28.343",
            "EmployeeHireData": {
                "CompanyId": "0ZVY7",
                "SsnOrSin": null,
                "NamePrefixCode": "Mr",
                "NameFirst": "Bruce",
                "NameMiddle": null,
                "NameLast": "Wayne",
                "NameSuffixCode": "Jr",
                "EmployeeNumber": null,
                "TimeclockId": null,
                "AddressLine1": "Wayne Manor",
                "AddressLine2": null,
                "City": "Gotham City",
                "StateOrProvinceCode": "NJ",
                "ZipOrPostalCode": "12345",
                "HomePhoneNumber": "7555551212",
                "BusinessPhoneNumber": null,
                "BusinessPhoneExtension": null,
                "OtherPhoneNumber": null,
                "OtherPhoneTypeCode": null,
                "PrimaryEmailAddress": null,
                "AlternateEmailAddress": null,
                "DateOfBirth": null,
                "GenderCode": "M",
                "MaritalStatusCode": null,
                "EthnicCode": "1",
                "I9VerifiedCode": null,
                "StartDate": null,
                "JobGroupCode": null,
                "JobCode": "SUPPORT",
                "JobTitle": "",
                "LocationCode": "PALOCA",
                "HireSourceCode": null,
                "OrgLevel1Code": null,
                "OrgLevel2Code": null,
                "OrgLevel3Code": null,
                "OrgLevel4Code": null,
                "PayRate": "56789.1234",
                "RatePerCode": "Y",
                "PayGroupCode": null,
                "ScheduledWorkHours": null,
                "EarningsGroupCode": null,
                "DeductionBenefitGroupCode": null,
                "EmployeeTypeCode": null,
                "HourlyOrSalaryCode": "S",
                "FullTimeOrPartTimeCode": "P",
                "ShiftCode": null,
                "PositionCode": null
            },
            "SupplementalData": {
                "CandidateInfo": {
                    "MilitaryEraCode": null,
                    "MilitaryBranchServedCode": null,
                    "IsDisabled": "Y/N",
                    "IsVeteran": "Y/N"
                },
                "EducationInfo": [],
                "ExperienceInfo": [
                    {
                        "Employer": "ACME",
                        "FromDate": "2010-02-01T00:00:00",
                        "ToDate": "2012-04-01T00:00:00",
                        "Position": "Gardener",
                        "Location": "New York",
                        "Salary": null,
                        "SalaryPerCode": null,
                        "ReasonForLeaving": null,
                        "Notes": "Picked grass"
                    }
                ],
                "LicenseInfo": [
                    {
                        "LicenseCode": "MCNE",
                        "LicenseNumber": "1234",
                        "ReceivedDate": "2011-02-01T00:00:00",
                        "RenewalDate": "2014-02-01T00:00:00",
                        "ProviderCode": null
                    }
                ],
                "SkillInfo": [
                    {
                        "SkillCode": "ACT",
                        "ProficiencyCode": "NOV",
                        "AssessedOnDate": null,
                        "AssessedBy": null,
                        "Notes": null
                    }
                ]
            }
        },
        {
            "Id": 6,
            "OfferId": "",
            "RequisitionId": "",
            "ImportDate": "2013-08-09T11:47:11.2",
            "EmployeeHireData": {
                "CompanyId": "C0014",
                "SsnOrSin": null,
                "NamePrefixCode": "Mr",
                "NameFirst": "Peter",
                "NameMiddle": "Spiderman",
                "NameLast": "Parker",
                "NameSuffixCode": null,
                "EmployeeNumber": null,
                "TimeclockId": null,
                "AddressLine1": "123 Maple Lane",
                "AddressLine2": null,
                "City": "New York",
                "StateOrProvinceCode": "NY",
                "ZipOrPostalCode": "12345",
                "HomePhoneNumber": "7555551213",
                "BusinessPhoneNumber": "7555551214",
                "BusinessPhoneExtension": null,
                "OtherPhoneNumber": "7555551215",
                "OtherPhoneTypeCode": "CEL",
                "PrimaryEmailAddress": "[email protected]",
                "AlternateEmailAddress": null,
                "DateOfBirth": null,
                "GenderCode": "M",
                "MaritalStatusCode": null,
                "EthnicCode": "5",
                "I9VerifiedCode": null,
                "StartDate": null,
                "JobGroupCode": null,
                "JobCode": "EXEC",
                "JobTitle": "Executive",
                "LocationCode": "NYC",
                "HireSourceCode": null,
                "OrgLevel1Code": null,
                "OrgLevel2Code": null,
                "OrgLevel3Code": null,
                "OrgLevel4Code": null,
                "PayRate": "58000.00",
                "RatePerCode": "Y",
                "PayGroupCode": null,
                "ScheduledWorkHours": null,
                "EarningsGroupCode": null,
                "DeductionBenefitGroupCode": null,
                "EmployeeTypeCode": null,
                "HourlyOrSalaryCode": "S",
                "FullTimeOrPartTimeCode": "F",
                "ShiftCode": null,
                "PositionCode": null
            },
            "SupplementalData": null
        }
    ]
}

Pending Hire Data – GET with Record ID

Pending hire data using the GET with Record ID is included in this section.

Parameter	Description
GET with Record ID (Optional)	Filters the return to include only the Pending Hire record with the ID number indicated as the ID parameter.

Resource URL: https://servername/services/employeehire/v1/pendinghires(5)

Sample Return from GET with Record ID

{
    "odata.metadata": " https://servername/services/employeehire/v1/$metadata#pendinghires/@Element",
    "Id": 5,
    "OfferId": "               ",
    "RequisitionId": "",
    "ImportDate": "2013-08-09T10:46:28.343",
    "EmployeeHireData": {
        "CompanyId": "0ZVY7",
        "SsnOrSin": null,
        "NamePrefixCode": "Mr",
        "NameFirst": "Bruce",
        "NameMiddle": null,
        "NameLast": "Wayne",
        "NameSuffixCode": "Jr",
        "EmployeeNumber": null,
        "TimeclockId": null,
        "AddressLine1": "Wayne Manor",
        "AddressLine2": null,
        "City": "Gotham City",
        "StateOrProvinceCode": "NJ",
        "ZipOrPostalCode": "12345",
        "HomePhoneNumber": "7555551212",
        "BusinessPhoneNumber": null,
        "BusinessPhoneExtension": null,
        "OtherPhoneNumber": null,
        "OtherPhoneTypeCode": null,
        "PrimaryEmailAddress": null,
        "AlternateEmailAddress": null,
        "DateOfBirth": null,
        "GenderCode": "M",
        "MaritalStatusCode": null,
        "EthnicCode": "1",
        "I9VerifiedCode": null,
        "StartDate": null,
        "JobGroupCode": null,
        "JobCode": "SUPPORT",
        "JobTitle": "",
        "LocationCode": "PALOCA",
        "HireSourceCode": null,
        "OrgLevel1Code": null,
        "OrgLevel2Code": null,
        "OrgLevel3Code": null,
        "OrgLevel4Code": null,
        "PayRate": "56789.1234",
        "RatePerCode": "Y",
        "PayGroupCode": null,
        "ScheduledWorkHours": null,
        "EarningsGroupCode": null,
        "DeductionBenefitGroupCode": null,
        "EmployeeTypeCode": null,
        "HourlyOrSalaryCode": "S",
        "FullTimeOrPartTimeCode": "P",
        "ShiftCode": null,
        "PositionCode": null
    },
    "SupplementalData": {
        "CandidateInfo": {
            "MilitaryEraCode": null,
            "MilitaryBranchServedCode": null
        },
        "EducationInfo": [],
        "ExperienceInfo": [
            {
                "Employer": "ACME",
                "FromDate": "2010-02-01T00:00:00",
                "ToDate": "2012-04-01T00:00:00",
                "Position": "Gardener",
                "Location": "New York",
                "Salary": null,
                "SalaryPerCode": null,
                "ReasonForLeaving": null,
                "Notes": "Picked grass"
            }
        ],
        "LicenseInfo": [
            {
                "LicenseCode": "MCNE",
                "LicenseNumber": "1234",
                "ReceivedDate": "2011-02-01T00:00:00",
                "RenewalDate": "2014-02-01T00:00:00",
                "ProviderCode": null
            }
        ],
        "SkillInfo": [
            {
                "SkillCode": "ACT",
                "ProficiencyCode": "NOV",
                "AssesedOnDate": null,
                "AssessedBy": null,
                "Notes": null
            }
        ]
    }
}

Pending Hire Data – POST

Pending hire data using the POST is included in this section.

Parameter	Description
POST	Inserts a Pending Hire record

Sample from POST

{
    "Id": 0,
    "OfferId": "245",
    "RequisitionId": "N-714",
    "ImportDate": "2013-08-09T10:46:28.343",
    "EmployeeHireData": {
        "CompanyId": "C0014",
        "SsnOrSin": "222334444",
        "NamePrefixCode": "Ms",
        "NameFirst": "Diana",
        "NameMiddle": null,
        "NameLast": "Prince",
        "NameSuffixCode": null,
        "EmployeeNumber": null,
        "TimeclockId": null,
        "AddressLine1": "234 Oak Drive",
        "AddressLine2": null,
        "City": "1 Comic Lane",
        "StateOrProvinceCode": "DC",
        "ZipOrPostalCode": "23456",
        "HomePhoneNumber": "5555555555",
        "BusinessPhoneNumber": null,
        "BusinessPhoneExtension": null,
        "OtherPhoneNumber": null,
        "OtherPhoneTypeCode": null,
        "PrimaryEmailAddress": null,
        "AlternateEmailAddress": null,
        "DateOfBirth": null,
        "GenderCode": "F",
        "MaritalStatusCode": null,
        "EthnicCode": "1",
        "I9VerifiedCode": null,
        "StartDate": null,
        "JobGroupCode": null,
        "JobCode": "SUPPORT",
        "JobTitle": null,
        "LocationCode": "DC",
        "HireSourceCode": null,
        "OrgLevel1Code": null,
        "OrgLevel2Code": null,
        "OrgLevel3Code": null,
        "OrgLevel4Code": null,
        "PayRate": "85000",
        "RatePerCode": "Y",
        "PayGroupCode": null,
        "ScheduledWorkHours": null,
        "EarningsGroupCode": null,
        "DeductionBenefitGroupCode": null,
        "EmployeeTypeCode": null,
        "HourlyOrSalaryCode": "S",
        "FullTimeOrPartTimeCode": "P",
        "ShiftCode": null,
        "PositionCode": null
    },
    "SupplementalData": {
        "CandidateInfo": {
            "MilitaryEraCode": null,
            "MilitaryBranchServedCode": null,
            "IsDisabled": "Y",
            "IsVeteran": "N"
        },
        "EducationInfo": [
            {
                "SchoolCode": "UNI",
                "FromDate": "2010-06-07",
                "ToDate": "2013-06-07",
                "Graduated": "True",
                "Years": 3,
                "MajorCode": "HUM",
                "MinorCode": "HR",
                "Location": "USA",
                "LevelCode": "M",
                "Gpa": "4.0",
                "Rank": "25",
                "Notes": null              
            }
        ],
        "ExperienceInfo": [],
        "LicenseInfo": [],
        "SkillInfo": [
            {
                "SkillCode": "ACT",
                "ProficiencyCode": "NOV",
                "AssesedOnDate": null,
                "AssessedBy": null,
                "Notes": null
            }
        ]
    }
}

Note: Supplemental Data is optional. It may be removed from the POST if not applicable.

Pending Hire Data – PUT with Record ID

Pending hire data using PUT with Record ID is included in this section.

Parameter	Description
PUT with Record ID	Indicates one unprocessed record to be updated.

Resource URL: https://servername/services/employeehire/v1/pendinghires(12)

Sample PUT with Record ID

{
    "OfferId": "245",
    "RequisitionId": "N-714",
    "ImportDate": "2013-08-09T10:46:28.343",
    "EmployeeHireData": {
        "CompanyId": "C0014",
        "SsnOrSin": "222334444",
        "NamePrefixCode": "Ms",
        "NameFirst": "Diana",
        "NameMiddle": null,
        "NameLast": "Prince",
        "NameSuffixCode": null,
        "EmployeeNumber": null,
        "TimeclockId": null,
        "AddressLine1": "234 Oak Drive",
        "AddressLine2": null,
        "City": "1 Comic Lane",
        "StateOrProvinceCode": "DC",
        "ZipOrPostalCode": "23456",
        "HomePhoneNumber": "5555555555",
        "BusinessPhoneNumber": null,
        "BusinessPhoneExtension": null,
        "OtherPhoneNumber": null,
        "OtherPhoneTypeCode": null,
        "PrimaryEmailAddress": null,
        "AlternateEmailAddress": null,
        "DateOfBirth": null,
        "GenderCode": "F",
        "MaritalStatusCode": null,
        "EthnicCode": "1",
        "I9VerifiedCode": null,
        "StartDate": null,
        "JobGroupCode"
        "JobCode": "SUPPORT",
        "JobTitle": null,
        "LocationCode": "DC",
        "HireSourceCode": null,
        "OrgLevel1Code": null,
        "OrgLevel2Code": null,
        "OrgLevel3Code": null,
        "OrgLevel4Code": null,
        "PayRate": "86000", "updated value"
        "RatePerCode": "Y",
        "PayGroupCode": null,
        "ScheduledWorkHours": null,
        "EarningsGroupCode": null,
        "DeductionBenefitGroupCode": null,
        "EmployeeTypeCode": null,
        "HourlyOrSalaryCode": "S",
        "FullTimeOrPartTimeCode": "P",
        "ShiftCode": null,
        "PositionCode": null
    },
    "SupplementalData": {
        "CandidateInfo": {
            "MilitaryEraCode": null,
            "MilitaryBranchServedCode": null,
             "IsDisabled":"Y",
           "IsVeteran":"N"

        },
        "EducationInfo": [
            {
                "SchoolCode": "UNI",
  "FromDate": "2010-06-07",
  "ToDate": "2013-06-07",
  "Graduated": "True",
  "Years": 3,
  "MajorCode": "HUM",
  "MinorCode": "HR",
  "Location": "USA",
  "LevelCode": "M",
  "Gpa": "4.0",
                "Rank": "25",
                "Notes": null              
            }
      ],
        "ExperienceInfo": [ ],
        "LicenseInfo": [ ],
        "SkillInfo": [
            {
                "SkillCode": "ACT",
                "ProficiencyCode": "NOV",
                "AssesedOnDate": null,
                "AssessedBy": null,
                "Notes": null
            }
        ]
    }
  }

Possible Return Values

The following return values are possible for the Pending Hire Service:

Return Code	Description
200 OK	The request has succeeded (for instance, on a GET).
201 Created	The POST was successful and a new record was created.
204 No Content	The PUT was successful and the record was updated. *
400 Bad Request	The request was malformed, unable to be understood, or contained validation errors.
401 Unauthorized	The credentials provided were not able to be authenticated.
403 Forbidden	Access to the requested resource is denied.
404 Not Found	The Requested URI cannot be found.
500 Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.
501 Not Implemented	The request is not supported.

Note: Delete is not supported on this API and will return this code.

204 No Content (return-no-content) is the default behavior. This can be changed to return the content of the successful PUT by altering the header (return-content). The syntax for the Prefer header is as follows: