20.03.03 Employees

Root Folder > UNItekTIME Documentation > 20 TimeLive API > 20.03 API

20.03.03 Employees

The Employee Object

Object PropertyRequiredObject TypeDescriptionMax Character Length
FirstNameYesStringFirst Name Of Employee150
LastNameYesStringLast Name Of Employee150
EMailAddressYesStringEmail Address Of Employee100
AccountEmployeeIdNoIntegerUnique Id Of Employee10
MiddleNameNoStringMiddle name Of Employee40
AccountDepartmentIdNoIntegerDepartment Id Of Employee10
AccountRoleIdNoIntegerRole Id Of Employee10
AddressLine1NoStringAddress Line 1 Of Employee300
AddressLine2NoStringAddress Line 2 Of Employee300
CityNoStringCity Of Employee100
ZipNoStringZip Of Employee50
CountryIdNoIntegerCountryId Of Employee3
HomePhoneNoNoStringHome Phone No Of Employee40
WorkPhoneNoNoStringWork Phone No Of Employee100
MobilePhoneNoNoStringMobile Phone No Of Employee100
TerminationDateNoDateTimeTermination Date Of Employee19
IsDisabledNoBooleanDisabled Status Of Employee1
TimeZoneIdNoIntegerTimeZone Id Of Employee3
PrefixNoStringPrefix Of Employee50
AccountLocationIdNoIntegerLocation Id Of Employee10
NotesNoStringNotes Of Employee1000
BillingTypeIdNoIntegerBilling Type Id Of Employee10
StateNoStringState Of Employee40
AllowedAccessFromIPNoStringAllowed Access From IP Of Employee40
AccountBillingRateIdNoIntegerBilling Rate Id Of Employee10
EmployeeCodeNoStringEmployee Code Of Employee100
EmployeeManagerIdNoIntegerEmployee Manager Id Of Employee10
JobTitleNoStringJob Title Of Employee200
EmployeePayTypeIdNoGUIDEmployee Pay Type Id Of Employee36
HiredDateNoDateTimeHired Date Of Employee19
StatusIdNoIntegerStatus Id Of Employee10
AccountWorkingDayTypeIdNoGUIDWorking Day Type Id Of Employee36
AccountTimeOffPolicyIdNoGUIDTimeOff Policy Id Of Employee36
TimeOffApprovalTypeIdNoIntegerTimeOff Approval Type Id Of Employee10
AccountHolidayTypeIdNoGUIDHoliday Type Id Of Employee36
IsForcePasswordChangeNoBooleanForce Password Change Status Of Employee1
CustomField1NoStringCustomField 1 Of Employee2000
CustomField2NoStringCustomField 2 Of Employee2000
CustomField3NoStringCustomField 3 Of Employee2000
CustomField4NoStringCustomField 4 Of Employee2000
CustomField5NoStringCustomField 5 Of Employee2000
CustomField6NoStringCustomField 6 Of Employee2000
CustomField7NoStringCustomField 7 Of Employee2000
CustomField8NoStringCustomField 8 Of Employee2000
CustomField9NoStringCustomField 9 Of Employee2000
CustomField10NoStringCustomField 10 Of Employee2000
CustomField11NoStringCustomField 11 Of Employee2000
CustomField12NoStringCustomField 12 Of Employee2000
CustomField13NoStringCustomField 13 Of Employee2000
CustomField14NoStringCustomField 14 Of Employee2000
CustomField15NoStringCustomField 15 Of Employee2000
UserInterfaceLanguageNoStringUser Interface Language Of Employee50
IsShowEmployeeProfilePictureNoBooleanShow Employee Profile Picture Status Of Employee1
IsTimeInOutAvailableNoBooleanTime In Time Out Available Of Employee1
BillingRateNoDecimalBilling Rate Of Employee10
EmployeeRateNoDecimalEmployee Rate Of Employee10
StartDateNoDateTimeStart Date of Billing Of Employee19
EndDateNoDateTimeEnd Date of Billing Of Employee19
AccountWorkTypeIdNoIntegerWork Type Id Of Employee10
BillingRateCurrencyIdNoIntegerCurrency Id Of Billing Rate Of Employee10
EmployeeRateCurrencyIdNoIntegerCurrency Id Of Employee Rate Of Employee10

List All Active Employees

Returns a list of your all Active Employees in your UNItekTIME account.
GET /API/Employees

Example Request

curl "https://demo.unitektime.com/api/employees" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
  {
    "AccountEmployeeId": 130,
    "EmployeeCode": "001",
    "FirstName": "Bob",
    "LastName": "Bingham",
    "UserName": "bobbingham@unitektime.com",
    "EMailAddress": "bobbingham@unitektime.com",
    "DepartmentName": "Development",
    "JobTitle": null,
    "Role": "User",
    "AccountLocation": "US(HeadOffice)",
    "BillingType": null,
    "HiredDate": "2018-04-03T00:00:00+00:00",
    "CreatedOn": "2018-04-03T00:00:00+00:00",
    "ModifiedOn": "2018-04-03T00:00:00+00:00",
    "AccountEmployeeType": "accountant",
    "AccountTimeOffPolicyId": null,
    "TimeOffApprovalTypeId": null,
    "AllowedAccessFromIP": null,
    "AccountWorkingDayTypeId": "55dedd23-7d27-4300-be08-2982079da47d",
    "UserInterfaceLanguage": "en-US",
    "Department": "DEV-Development",
    "MobilePhoneNo": null,
    "WorkPhoneNo": "",
    "HomePhoneNo": null,
    "Zip": null,
    "City": null,
    "State": null,
    "AddressLine1": null,
    "AddressLine2": null,
    "TerminationDate": null,
    "CustomField1": null,
    "CustomField2": null,
    "CustomField3": null,
    "CustomField4": null,
    "CustomField5": null,
    "CustomField6": null,
    "CustomField7": null,
    "CustomField8": null,
    "CustomField9": null,
    "CustomField10": null,
    "CustomField11": null,
    "CustomField12": null,
    "CustomField13": null,
    "CustomField14": null,
    "CustomField15": null,
    "IsDisabled": "No",
    "AccountLocationId": 12948,
    "AccountRoleId": 83569,
    "AccountDepartmentId": 15706,
    "EmployeeCountryId": 170,
    "StatusId": 149541,
    "EmployeePayTypeId": "00aa8186-c0f4-4b61-ba25-ddf857c04ffd",
    "EmployeeTimeZoneId": 21,
    "EmployeeManagerId": null,
    "AccountHolidayTypeId": null,
    "IsForcePasswordChange": "No",
    "IsShowEmployeeProfilePicture": "No"
  }
]

Retrieve an Employee

Retrieves the Employee with the given ID. Returns a Employee object and a 200 OK response code if a valid identifier was provided.
GET /API/Employees/{EMPLOYEE_ID}

Example Request

curl "https://demo.unitektime.com/api/Employees/00001" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
  {
    "AccountEmployeeId": 130,
    "EmployeeCode": "001",
    "FirstName": "Bob",
    "LastName": "Bingham",
    "UserName": "bobbingham@unitektime.com",
    "EMailAddress": "bobbingham@unitektime.com",
    "DepartmentName": "Development",
    "JobTitle": null,
    "Role": "User",
    "AccountLocation": "US(HeadOffice)",
    "BillingType": null,
    "HiredDate": "2018-04-03T00:00:00+00:00",
    "CreatedOn": "2018-04-03T00:00:00+00:00",
    "ModifiedOn": "2018-04-03T00:00:00+00:00",
    "AccountEmployeeType": "accountant",
    "AccountTimeOffPolicyId": null,
    "TimeOffApprovalTypeId": null,
    "AllowedAccessFromIP": null,
    "AccountWorkingDayTypeId": "55dedd23-7d27-4300-be08-2982079da47d",
    "UserInterfaceLanguage": "en-US",
    "Department": "DEV-Development",
    "MobilePhoneNo": null,
    "WorkPhoneNo": "",
    "HomePhoneNo": null,
    "Zip": null,
    "City": null,
    "State": null,
    "AddressLine1": null,
    "AddressLine2": null,
    "TerminationDate": null,
    "CustomField1": null,
    "CustomField2": null,
    "CustomField3": null,
    "CustomField4": null,
    "CustomField5": null,
    "CustomField6": null,
    "CustomField7": null,
    "CustomField8": null,
    "CustomField9": null,
    "CustomField10": null,
    "CustomField11": null,
    "CustomField12": null,
    "CustomField13": null,
    "CustomField14": null,
    "CustomField15": null,
    "IsDisabled": "No",
    "AccountLocationId": 12948,
    "AccountRoleId": 83569,
    "AccountDepartmentId": 15706,
    "EmployeeCountryId": 170,
    "StatusId": 149541,
    "EmployeePayTypeId": "00aa8186-c0f4-4b61-ba25-ddf857c04ffd",
    "EmployeeTimeZoneId": 21,
    "EmployeeManagerId": null,
    "AccountHolidayTypeId": null,
    "IsForcePasswordChange": "No",
    "IsShowEmployeeProfilePicture": "No"
  }
]

Retrieve an Employee by Employee Code

Retrieves the Employee with the given Code. Returns a Employee object and a 200 OK response code if a valid identifier was provided.
GET /API/Employees/GetEmployeeByEmployeeCode/{Employee_Code}

Example Request

curl "https://demo.unitektime.com/api/Employees/GetEmployeeByEmployeeCode/001" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
  {
    "AccountEmployeeId": 130,
    "EmployeeCode": "001",
    "FirstName": "Bob",
    "LastName": "Bingham",
    "UserName": "bobbingham@unitektime.com",
    "EMailAddress": "bobbingham@unitektime.com",
    "DepartmentName": "Development",
    "JobTitle": null,
    "Role": "User",
    "AccountLocation": "US(HeadOffice)",
    "BillingType": null,
    "HiredDate": "2018-04-03T00:00:00+00:00",
    "CreatedOn": "2018-04-03T00:00:00+00:00",
    "ModifiedOn": "2018-04-03T00:00:00+00:00",
    "AccountEmployeeType": "accountant",
    "AccountTimeOffPolicyId": null,
    "TimeOffApprovalTypeId": null,
    "AllowedAccessFromIP": null,
    "AccountWorkingDayTypeId": "55dedd23-7d27-4300-be08-2982079da47d",
    "UserInterfaceLanguage": "en-US",
    "Department": "DEV-Development",
    "MobilePhoneNo": null,
    "WorkPhoneNo": "",
    "HomePhoneNo": null,
    "Zip": null,
    "City": null,
    "State": null,
    "AddressLine1": null,
    "AddressLine2": null,
    "TerminationDate": null,
    "CustomField1": null,
    "CustomField2": null,
    "CustomField3": null,
    "CustomField4": null,
    "CustomField5": null,
    "CustomField6": null,
    "CustomField7": null,
    "CustomField8": null,
    "CustomField9": null,
    "CustomField10": null,
    "CustomField11": null,
    "CustomField12": null,
    "CustomField13": null,
    "CustomField14": null,
    "CustomField15": null,
    "IsDisabled": "No",
    "AccountLocationId": 12948,
    "AccountRoleId": 83569,
    "AccountDepartmentId": 15706,
    "EmployeeCountryId": 170,
    "StatusId": 149541,
    "EmployeePayTypeId": "00aa8186-c0f4-4b61-ba25-ddf857c04ffd",
    "EmployeeTimeZoneId": 21,
    "EmployeeManagerId": null,
    "AccountHolidayTypeId": null,
    "IsForcePasswordChange": "No",
    "IsShowEmployeeProfilePicture": "No"
  }
]

Create an Employee

Creates an Employee in your UNItekTIME account and returns the Response Message.
POST /API/Employees
Object PropertyRequiredObject TypeDescriptionMax Character Length
FirstNameYesStringFirst name of the newly created employee150
LastNameYesStringLast name of the newly created employee150
EmailAddressYesStringEmail of the newly created employee100

Example Request

curl "https://demo.unitektime.com/api/employees" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X POST \
      -H "Content-Type: application/json" \
      -d "{'EmailAddress':'someone@example.com','FirstName':'john','LastName':'Doe'}"

Example Response

[            
    {            
        "id": "00001",            
        "message": "Employee Added Successfully"            
    }            
]

Update an Employee

Update an Employee in your UNItekTIME account and returns the Response Message.
POST /API/Employees/{EMPLOYEE_ID}

Example Request

curl "https://demo.unitektime.com/api/employees/00003" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X POST \
      -H "Content-Type: application/json" \
      -d "{'LastName':'Smith'}"

Example Response

[            
    {            
        "id": "00003",            
        "message": "Employee Updated Successfully"            
    }            
]

Delete an Employee

Delete an Employee. Returns a 200 OK response code if the call succeeded.
DELETE /API/Employee/{EMPLOYEE_ID}

Example Request

curl "https://demo.unitektime.com/api/employees/00003" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X DELETE \
      -H "Content-Type: application/json"

Example Response

[
    {
        "id": "00003",
        "message": "Employee Deleted Successfully"
    }
]

List All Active/In-Active Employees

Returns a list of your all Active/In-Active Employees in your UNItekTIME account.
GET /API/Employees/AllEmployees

Example Request

curl "https://demo.unitektime.com/api/employees/allemployees" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
  {
        "AccountEmployeeId": 93166,
        "EmployeeCode": "",
        "FirstName": "Bob",
        "LastName": "Bingham",
        "UserName": "bobbingham@unitektime.com",
        "EMailAddress": "bobbingham@unitektime.com",
        "DepartmentName": "Default Department",
        "JobTitle": null,
        "Role": "Administrator",
        "AccountLocation": "Default Location",
        "BillingType": "Hourly",
        "HiredDate": "2019-08-16T00:00:00+00:00",
        "CreatedOn": "2019-08-16T09:16:41.053+00:00",
        "ModifiedOn": "2019-10-24T11:01:59.857+00:00",
        "AccountEmployeeType": "Full-time Hourly",
        "AccountTimeOffPolicy": "Standard",
        "TimeOffApprovalTypeId": null,
        "AllowedAccessFromIP": "",
        "AccountWorkingDayTypeId": "ed5385db-3e70-43a1-8786-e82b98bd0f83",
        "UserInterfaceLanguage": "en-US",
        "Department": "Default - Default Department",
        "MobilePhoneNo": "",
        "WorkPhoneNo": "",
        "HomePhoneNo": "",
        "Zip": "",
        "City": "",
        "State": "",
        "AddressLine2": "",
        "AddressLine1": "",
        "TerminationDate": null,
        "CustomField1": null,
        "CustomField2": null,
        "CustomField3": null,
        "CustomField4": null,
        "CustomField5": null,
        "CustomField6": null,
        "CustomField7": null,
        "CustomField8": null,
        "CustomField9": null,
        "CustomField10": null,
        "CustomField11": null,
        "CustomField12": null,
        "CustomField13": null,
        "CustomField14": null,
        "CustomField15": null,
        "AccountLocationId": 14915,
        "AccountRoleId": 95081,
        "AccountDepartmentId": 18523,
        "EmployeeCountryId": 233,
        "StatusId": 173875,
        "EmployeePayTypeId": "0c83b25f-84cb-4abe-9885-b510842e20b1",
        "EmployeeTimeZoneId": 21,
        "AccountTimeOffPolicyId": "f58974f9-5468-4c12-9ea4-a4c7ef76531c",
        "EmployeeManagerId": null,
        "AccountHolidayTypeId": null,
        "Disabled": "No",
        "IsForcePasswordChange": "No",
        "IsShowEmployeeProfilePicture": "No"
    }
]
Article ID: 107, , Modified: 3/24/2021 at 3:06 AM

Share this article