Employee

Returns all employees.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
query Parameters
businessUnitId
string <uuid>

Optionally filter the returned list of employees by business unit

employeeId
integer or null <int32>

Optionally filter the returned list of employees by an employee's integer ID or "Legacy Key"

includeDisabledEmployees
boolean
Default: false

Determines if disabled employees should appear in the list of employees being returned.

Responses
200

Success

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

404

Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.

get/api/v1/employees
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Create a new employee.
First and Last name is required. Payclass is needed if employee is mechanic or fueler.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
Request Body schema: 
required
businessUnitId
string <uuid> 
The employee's business unit ID. Omitting this field will default to the business unit associated with the user performing the call.


 
code
string or null
The employee's Code.


 
firstName
required
string
The employee's first name.


 
lastName
required
string
The employee's last name.


 
types
Array of strings or null
An array of assigned employee type(s).


 
payclass
string or null
The employee's payclass.


 
object (ApiAddressCreate) 
 
hireDate
string or null <date-time> 
The employeees hire date
value is the server time.


 
mobilePhone
string or null
The employee's mobile phone number.


 
homePhone
string or null
The employee's home phone number.


 
officePhone
string or null
The employee's office phone number.


 
homeEmail
string or null
The employee's home email.


 
officeEmail
string or null
The employee's office email.


 
region
string or null
The employee's region code.


 
division
string or null
The employee's division code.


 
accountingCode
string or null
The employee's accounting code.


 
enabled
string or null
The employee records status (whether it's active or has been disabled).


 
onLoanBusinessUnitId
string or null <uuid> 
The ID associated with the business unit the employee is currently on-loan to.


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


post/api/v1/employees
Request samples 
{
  • "businessUnitId": "42686835-dd20-4187-8429-39bcea2b1cfc",
  • "code": "LUPIN,R",
  • "firstName": "Remus",
  • "lastName": "Lupin",
  • "types": [
    ],
  • "payclass": "mechanic-jr",
  • "address": {
    },
  • "hireDate": "2011-11-12T00:00:00Z",
  • "mobilePhone": "",
  • "homePhone": "",
  • "officePhone": "",
  • "homeEmail": "",
  • "officeEmail": "johndoe@gmail.com",
  • "region": "BEASLEY",
  • "division": "02-123",
  • "accountingCode": "EMP123",
  • "enabled": "Y",
  • "onLoanBusinessUnitId": "00000000-0000-0000-0000-000000000000"
}
Response samples 
application/json
{
  • "id": "12c7e9ea-6d67-4f43-9d67-bbf3117d07bd",
  • "employeeId": 1,
  • "businessUnitId": "42686835-dd20-4187-8429-39bcea2b1cfc",
  • "code": "LUPIN,R",
  • "firstName": "Remus",
  • "lastName": "Lupin",
  • "types": [
    ],
  • "payclass": "mechanic-jr",
  • "address": {
    },
  • "hireDate": "2011-11-12T00:00:00Z",
  • "mobilePhone": "",
  • "homePhone": "",
  • "officePhone": "",
  • "homeEmail": "",
  • "officeEmail": "johndoe@gmail.com",
  • "region": "BEASLEY",
  • "division": "02-123",
  • "accountingCode": "EMP123",
  • "enabled": "Y",
  • "onLoanBusinessUnitId": "00000000-0000-0000-0000-000000000000"
}
Returns a single employee record, based on its Id.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The Id of the employee to return.


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


get/api/v1/employees/{id}
Request samples 
Response samples 
application/json
{
  • "id": "12c7e9ea-6d67-4f43-9d67-bbf3117d07bd",
  • "employeeId": 1,
  • "businessUnitId": "42686835-dd20-4187-8429-39bcea2b1cfc",
  • "code": "LUPIN,R",
  • "firstName": "Remus",
  • "lastName": "Lupin",
  • "types": [
    ],
  • "payclass": "mechanic-jr",
  • "address": {
    },
  • "hireDate": "2011-11-12T00:00:00Z",
  • "mobilePhone": "",
  • "homePhone": "",
  • "officePhone": "",
  • "homeEmail": "",
  • "officeEmail": "johndoe@gmail.com",
  • "region": "BEASLEY",
  • "division": "02-123",
  • "accountingCode": "EMP123",
  • "enabled": "Y",
  • "onLoanBusinessUnitId": "00000000-0000-0000-0000-000000000000"
}
Updates employee with corresponding id. If fields are left blank, the corresponding employee field will be blanked out.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The Id of the employee to update.


 
Request Body schema: 
required
code
string or null
The employee's Code.


 
firstName
string or null
The employee's first name.


 
lastName
string or null
The employee's last name.


 
types
Array of strings or null
An array of assigned employee type(s).


 
payclass
string or null
The employee's payclass.


 
object (ApiAddressCreate) 
 
hireDate
string or null <date-time> 
The employeees hire date
value is the server time.


 
mobilePhone
string or null
The employee's mobile phone number.


 
homePhone
string or null
The employee's home phone number.


 
officePhone
string or null
The employee's office phone number.


 
homeEmail
string or null
The employee's home email.


 
officeEmail
string or null
The employee's office email.


 
region
string or null
The employee's region code.


 
division
string or null
The employee's division code.


 
accountingCode
string or null
The employee's accounting code.


 
enabled
string or null
The employee records status (whether it's active or has been disabled).


 
onLoanBusinessUnitId
string or null <uuid> 
The ID associated with the business unit the employee is currently on-loan to.


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


put/api/v1/employees/{id}
Request samples 
{
  • "code": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "types": [
    ],
  • "payclass": "string",
  • "address": {
    },
  • "hireDate": "2019-08-24T14:15:22Z",
  • "mobilePhone": "string",
  • "homePhone": "string",
  • "officePhone": "string",
  • "homeEmail": "string",
  • "officeEmail": "string",
  • "region": "string",
  • "division": "string",
  • "accountingCode": "string",
  • "enabled": "string",
  • "onLoanBusinessUnitId": "eb06ba59-e274-484d-adfe-2207fbfd9c49"
}
Response samples 
application/json
{
  • "id": "12c7e9ea-6d67-4f43-9d67-bbf3117d07bd",
  • "employeeId": 1,
  • "businessUnitId": "42686835-dd20-4187-8429-39bcea2b1cfc",
  • "code": "LUPIN,R",
  • "firstName": "Remus",
  • "lastName": "Lupin",
  • "types": [
    ],
  • "payclass": "mechanic-jr",
  • "address": {
    },
  • "hireDate": "2011-11-12T00:00:00Z",
  • "mobilePhone": "",
  • "homePhone": "",
  • "officePhone": "",
  • "homeEmail": "",
  • "officeEmail": "johndoe@gmail.com",
  • "region": "BEASLEY",
  • "division": "02-123",
  • "accountingCode": "EMP123",
  • "enabled": "Y",
  • "onLoanBusinessUnitId": "00000000-0000-0000-0000-000000000000"
}