EmployeeSkills

Returns all skills that the specified employee has.

Returns all skills that the specified employee has.

A response header called "Pagination-MorePagesAvailable" will be sent in the response with a value of "yes" or "no", indicating whether more pages are available after this one. That is, if the header value is "yes", the client should request the next page.

Securitybearer
Request
path Parameters
employeeCode
required
string

The employee code

query Parameters
dateAfterUtc
string <date-time>

Limits the results to employee skills that have been updated after the specified UTC time.

limit
integer <int32>

The number of results returned. Default 1000.

offset
integer <int32>

The page offset. The response header "Pagination-MorePagesAvailable" indicates whether the call should be made again with an incremented offset.

usePayrollCode
boolean

Specifies whether or not to include the HeavyJob payroll code for each employee in the response. The default value is false.

Responses
200

Ok

400

Bad Request

get/v1/employeeSkills/employee/{employeeCode}
Request samples 
Response samples 
[
  • {
    }
]
Returns all employees having the specified skill.
Returns all employees having the specified skill.


A response header called "Pagination-MorePagesAvailable" will be sent in the response with a value of "yes" or "no", indicating whether more pages are available after
this one.  That is, if the header value is "yes", the client should request the next page.


Securitybearer 
Request 
path Parameters
courseCodeOrName
required
string
The course code or skill name


 
query Parameters
dateAfterUtc
string <date-time> 
Limits the results to employee skills that have been updated after the specified UTC time.


 
limit
integer <int32> 
The number of results returned.  Default 1000.


 
offset
integer <int32> 
The page offset.  The response header "Pagination-MorePagesAvailable" indicates whether the call should be made again with an incremented offset.


 
usePayrollCode
boolean
Specifies whether or not to include the HeavyJob payroll code for each employee in the response. The default value is false.


 
Responses 
200
Ok


400
Bad Request


get/v1/employeeSkills/skill/{courseCodeOrName}
Request samples 
Response samples 
[
  • {
    }
]
Gets the cartesian product of employees and skills.
Returns a cross join of employees and skills, with each result representing a single skill for a single employee.  For example, if there are 10 employees and
each employee has 10 skills, this call will return 100 results.


A response header called "Pagination-MorePagesAvailable" will be sent in the response with a value of "yes" or "no", indicating whether more pages are available after
this one.  That is, if the header value is "yes", the client should request the next page.


Securitybearer 
Request 
query Parameters
dateAfterUtc
string <date-time> 
Limits the results to employee skills that have been updated after the specified UTC time.


 
limit
integer <int32> 
The number of results returned.  Default 1000.


 
offset
integer <int32> 
The page offset.  The response header "Pagination-MorePagesAvailable" indicates whether the call should be made again with an incremented offset.


 
includeDismissed
boolean
Specifies whether or not to include dismissed skills in the response. The default value is false.


 
usePayrollCode
boolean
Specifies whether or not to include the HeavyJob payroll code for each employee in the response. The default value is false.


 
Responses 
200
Ok


get/v1/employeeSkills
Request samples 
Response samples 
[
  • {
    }
]
Creates or updates a skill for an existing employee, using the skill's course code or name as a unique identifier.
Creates or updates a skill for an existing employee, using the skill's course code or name as a unique identifier.


If the skill does not exist, it is simply created.  If the skill already exists, the old skill is "dismissed" but retained
for record-keeping, and a new, non-dismissed skill is created.


Securitybearer 
Request 
query Parameters
usePayrollCode
boolean
Specifies whether or not to use the HeavyJob payroll code as the unique identifier for an employee. If true, EmployeePayrollCode is required and will be used instead of EmployeeCode to identify the employee that should receive the skill. The default value is false.


 
Request Body schema: 
The skill to be upserted for an existing employee.


EmployeeCode
required
string
A unique string identifier for this employee


 
EmployeePayrollCode
string
The payroll code for the employee from HeavyJob. This value is only provided or used if the usePayrollCode
URL parameter is specified.


 
SkillName
string
The display name for the skill


 
CourseCode
string
A unique string identifier for this skill's course code, can be the course name or course number in your LMS system, if this is not specified SkillName will be used unique identifier


 
CertificationDate
string <date-time> 
A datetime of when the employee was certified in this skill


 
ExpirationDate
string <date-time> 
A datetime of when this skill expires for this employee


 
TrainingTime
integer <int32> 
TrainingTime is the amount of minutes it took the employee to complete the skill


 
Note
string
Note or description for this employee's skill


 
IsDismissed
boolean
If the employee skill has been archived/dismissed if it is invalid, no longer in use, can be manually archived in Skills system


 
LastModified
string <date-time> 
Optional: when the employee skill was last modified


 
CreatedDate
string <date-time> 
Optional: when the employee skill was created


 
Array of objects (ApiESAttachment) 
Attachments to the employees skill


 
Responses 
202
Accepted


post/v1/employeeSkills
Request samples 
{
  • "EmployeeCode": "string",
  • "EmployeePayrollCode": "string",
  • "SkillName": "string",
  • "CourseCode": "string",
  • "CertificationDate": "2019-08-24T14:15:22Z",
  • "ExpirationDate": "2019-08-24T14:15:22Z",
  • "TrainingTime": 0,
  • "Note": "string",
  • "IsDismissed": true,
  • "LastModified": "2019-08-24T14:15:22Z",
  • "CreatedDate": "2019-08-24T14:15:22Z",
  • "Attachments": [
    ]
}
Response samples 
"string"
Imports a list of employee skills, using the skill's course code or name as a unique identifier on each employee.
Imports a list of employee skills, using the skill's course code or name as a unique identifier on each employee.


This call does not create any new employees; all specified employee codes must belong to pre-existing employees.


If the skill does not exist for a particular employee, it is simply created.  If the skill already exists, the old
skill is "dismissed" but retained for record-keeping, and a new, non-dismissed skill is created.


Securitybearer 
Request 
query Parameters
usePayrollCode
boolean
Specifies whether or not to use the HeavyJob payroll code as the unique identifier for an employee. If true, EmployeePayrollCode is required and will be used instead of EmployeeCode to identify the employee that should receive the skill. The default value is false.


 
Request Body schema: 
A list of employee skills


 Array 
EmployeeCode
required
string
A unique string identifier for this employee


 
EmployeePayrollCode
string
The payroll code for the employee from HeavyJob. This value is only provided or used if the usePayrollCode
URL parameter is specified.


 
SkillName
string
The display name for the skill


 
CourseCode
string
A unique string identifier for this skill's course code, can be the course name or course number in your LMS system, if this is not specified SkillName will be used unique identifier


 
CertificationDate
string <date-time> 
A datetime of when the employee was certified in this skill


 
ExpirationDate
string <date-time> 
A datetime of when this skill expires for this employee


 
TrainingTime
integer <int32> 
TrainingTime is the amount of minutes it took the employee to complete the skill


 
Note
string
Note or description for this employee's skill


 
IsDismissed
boolean
If the employee skill has been archived/dismissed if it is invalid, no longer in use, can be manually archived in Skills system


 
LastModified
string <date-time> 
Optional: when the employee skill was last modified


 
CreatedDate
string <date-time> 
Optional: when the employee skill was created


 
Array of objects (ApiESAttachment) 
Attachments to the employees skill


 
Responses 
200
Ok


400
Bad Request


post/v1/employeeSkills/import
Request samples 
[
  • {
    }
]
Response samples 
{ }