Valid values

Lookup value

A lookup field is a field which expects a Natural HR system ID for the value.

This means that this value should be an integer and it should reference the system ID of the data it is referring to.

For example, if you are trying to specify a department ID and you wanted to enter "Sales" which has an ID of 123 you would enter 123 which we would then lookup and validate that 123 is a valid department ID for your company.

If it is not then this will cause an error and the action will fail and you will get an error.

 

Expected value

An expected value field is a field which expects a valid text representation to be entered - for example, when entering a country you enter the name of the country but it must be a valid country according to the list we maintain.

Below in the menu there are the expected values for 5 fields which currently use this:

Countries
Currencies
Ethnicities
Nationalities
Languages

 

Active

Default value: 0

API valueContext
0Archived/Inactive
1Active
 

Employee active

API valueContext
1Current / active employee
2Archived / leaver employee
 

Employee status

API valueContext
CurrentCurrent / active employee
ArchivedArchived / leaver employee
 

Approved

Default value: 0

API valueContext
0Pending approval - not in workflow
99Pending approval - in workflow
1Approved
2Declined
 

Yes/No

Default value: 0

API valueContext
0No
1Yes
 

Yes/No/Not given

Default value: 0

API valueContext
0Not given
1Yes
2No
 

Yes/No/Prefer not to say

API valueContext
YesYes
NoNo
Prefer not to sayPrefer not to say
 

Yes/No text

API valueContext
YesYes
NoNo
 

Genders

API valueContext
FemaleFemale
MaleMale
NotNot given
 

Marital status

API valueContext
SingleSingle
MarriedMarried
EngagedEngaged
Civil partnershipCivil partnership
Co habitingCo habiting
Living with partnerLiving with partner
DivorcedDivorced
SeparatedSeparated
WidowedWidowed
Not specifiedNot specified
 

Pay period

API valueContext
Per hourPer hour
Per dayPer day
Per weekPer week
Per monthPer month
Per annumPer annum
 

Working days

This should only be used if the time off meter is set to DAYS.

This field expects a string indicating the days the employee works per week - this is shown as 12345, for example, for someone who works Monday to Friday or 45 for someone who works Thursday and Friday.

ValueContext
1Monday
2Tuesday
3Wednesday
4Thursday
5Friday
6Saturday
7Sunday
 

Working hours

This should only be used if the time off meter is set to HOURS.

This field expects a comma separated string indicating the hours the employee works per week broken down by day.

Unlike working days, this requires an entry for each day even if the employee is not working that day - for example if someone works 8 hours per day every day then it should read 8,8,8,8,8,,,

Notice the double comma at the end indicating they do not work on those days.

 

Date format

All dates are expected to be in the format yyyy-mm-dd regardless of the system setting for localisation - this is both when using POST and GET.
 

Time

When entering a time, the format should be HH:ii:ss

For example, 22:14:54

 

Time off meter

Default value: blank

API valueContext
days / blankDays
hoursHours
 

Deducting values

API valueContext
0Does not deduct from any allowance
1Yes from pool
2Yes from individual allowance
3Accrued on length of service
4Limited allowance
5Accrued on length of service (alternate)
6Summary
 

AM/PM

You should only enter AM or PM if the duration of the request is less than 1

Default value: all / blank

all / blankAll day
amAM
pmPM
 

User groups

API valueContext
EmployeeEmployee
ManagerManager
HRHR
FinanceFinance
FacilitiesFacilities
TrainerTrainer
RecruiterRecruiter
ApproverApprover
adminAdmin - NOTE THE LOWER CASE a in the API VALUE
 

User group 2

This can only be used if user group is Manager

API valueContext
FinanceFinance
FacilitiesFacilities
TrainerTrainer
RecruiterRecruiter
 

User status

API valueContext
EnabledEnabled/Active
DisabledDisabled/Inactive
 

Training internal/external

API valueContext
intInternal
extExternal
 

Training results

API valueContext
AttendedAttended
CancelledCancelled
CompletedCompleted
Did not showDid not show
FailedFailed
PassedPassed
 

Job role manager

API valueContext
yYes
nNo
 

Contract type

API valueContext
PermanentPermanent
TemporaryTemporary
ContractorContractor
Zero hourZero hours
OtherOther
 

Full time / part time

API valueContext
Full timeFull time
Part timePart time
 

Traffic light

API valueContext
0No value
1Green
2Orange
3Red
 

Issued

API valueContext
0Draft
1Approved - not issued
2Declined
5Issued
99Pending approval
 

Company holiday types

API valueContext
1Mandatory day
2Shutdown day
 

Array

API valueContext
["Site name 1", "Site name 2", "Site name 3"]Site with the name of "Site name 1", site with the site name of "Site name 2" etc