Training and Qualifications

Definitions

With enableHR, an organisation can track Training & Qualification data about their Candidates, Employees, Volunteers and Contractors.

Currently, the Open API only exposes Training & Qualification module for Employees.

Training & Qualification items are called Competencies and are used to track a broad range of functions and role requirements such as the need to attend regular training courses, ensuring relevant qualifications like licenses, proof of vaccination and certificates are always up to date.

Examples of Competencies are:

  • Qualification (e.g. CPR Certification, Diploma of Business, White Card, etc)
  • Training (e.g. Advanced Excel training course, Infection Control Training, WHS inductions)
  • License (e.g. Driver’s License, Forklift License, Working with Children Check)
  • Skills (e.g. Touch typing, Project management, Fire Warden training)
  • Medical (e.g. Vaccination Status, First Aid)
  • Professional Registration / Membership (e.g. Unions, Chartered Accountants, Engineering Technician)
  • Capability (e.g. Problem solving, Leadership, Initiative)

When Competencies are used to track training sessions, they can be assigned Points which are used to denote the weighting of a certain training session that a worker has completed. The point system is more prevalent in accounting, legal and healthcare industries where workers need to complete a certain number of points per year to maintain their Practising Certificate.

To make management of Competencies easier in the User Interface, they can be organised in Groups and Sub-Groups. Groups cannot be allocated to an Employee. Groups are to Competencies what Folders are to Files. An individual Competency can be allocated directly to an Employee, but you can also group several Competencies into a Role and assign the Role to the Employee. When you do this, all the Competencies within that Role are allocated to the Employee, at once.

Roles reflect the organisation’s job types and functions. (Appropriate competencies that are relevant to a specific role or function can be grouped together). For instance, if your organisation has a sales team where all employees require the same Competencies, you can create a Role called ‘Sales’ and assign the relevant Competencies like Sales Qualification, or Driver’s License to that role.

Groups can represent a collection of Roles in the User Interface.

Once Competencies have been allocated to Employees, the final step requires each Competency to be updated to capture the status and details of each skill, training, and qualification requirement. This is a very important step as it ensures compliance and will trigger a range of alerts for any Competencies that have expiry dates.

Competencies

List all Competencies

Use this action to list all the Competencies created in the account.

Competencies can be standalone or part of a Group. Groups are used to organise Competencies together. They are to Competencies what Folders are to Files.
Using Groups makes management through the User Interface easier.
If a Competency is part of a Group (like a file would be sitting in a folder), the “Parent Group” fields in the table below will indicate this. If they are not part of a Group, then the “Parent Group” fields will be empty.
List All Competencies
MethodGET: List Competencies
ParametersAccount ID - Unique identifier of the Account
Response
Field Name on the ScreenDetailsExample
Competency IDUnique ID of the competency37d09580e3e14e62a150189789320eca
NameCompetency nameForklift License
DescriptionDescription of the CompetencyThis Competency allows the user to use forklift to move the items
TypeType of CompetencyAllowed values: Qualification, Training, Skill,
ProfessionalRegistrationMembership, LicenseTicket,
Medical, Capability, Unspecified
Parent Group IdUnique ID of the Parent GroupIf exists – cc27e24987434ee0bb39d410937263c7
If doesn’t exist – null
Parent Group NameName of the Parent GroupIf exists – Licenses
If doesn’t exist – null
Competencies

Create a Competency

Use this action to create a new Competency.

Competencies are created at the Account level and can be standalone or part of a Group (of Competencies). Groups are used to organise Competencies together. They are to Competencies what Folders are to Files.

Using Groups makes management through the User Interface easier. If the Competency you created is part of a Group (like a file would be sitting in a folder), you need to first get the Unique ID of that “Parent Group” provided the Group exists.

Competencies can be assigned a default expiry date and can lapse after a certain amount of time. The expiry date is a combination of ‘Expires after- value' and ‘Expires after- unit'. These two properties will be the default values when the Competency is allocated to an Employee.

  • If there is no date set in the 'Expires after' field of the competency. As soon as an expiry date is added to the competency (through the User Interface), then the competency status will change from Completed, to Expired after the expiry date has elapsed.
  • If there is a date set in the 'Expires after' field of the competency. When a completed date is added to the competency and the ‘Expires after’ date exists then the system will calculate the expiry date and change the status as in #1.

Note: there are automated notification emails to managers regarding expired competencies, see "Training & Qualification" alerts here

Create a Competency
MethodPOST: Create Competency
ParametersAccount ID - Unique identifier of the Account
Accepted Fields
Field Name DetailsExample
Name - Mandatory
Name of the competencyForklift License
DescriptionA short description of the CompetencyThis is a mandatory requirement for the Employees who work in certain jobs.
TypeType of CompetencyAllowed values: Qualification, Training, Skill,
ProfessionalRegistrationMembership, LicenceTicket,
Medical, Capability, Unspecified
Default issuing authorityAuthority responsible for issuing this CompetencyService NSW
PointsNumber of points allocated for holding this Competency
CodeA short text to describe CompetencyLicense
Default Date completedBy when the Competency is to be achieved2023-12-31
Expires after - valueThe Competency expires after a certain duration (see next field)8
Expires after - unitDuration typeAllowed values: Days, Weeks, Months, Years
Group IDUnique identifier of the Group for this Competency42e289346bf14ef68cd826ab86336e8b
Create competency

Retrieve a Competency

Use this action to retrieve the details for an existing Competency.

Competencies can be a part of a Group or not. Groups are used to organise Competencies together. They are to Competencies what Folders are to Files.
Using Groups makes management of Competencies through the User Interface easier.
Retrieve competency
MethodGET: Retrieve Competency Details
ParametersAccount ID - Unique identifier of the Account
Competency ID - Unique identifier of the Competency
Response
Field Name DetailsExample
Competency IDUnique ID of the competencydc56c0e53854462a8cfa23e27e6c6c71
NameName of the competencyFirst Aid certificate
DescriptionA short description of the CompetencyFirst Aid certificate
TypeType of CompetencyAllowed values: Qualification, Training, Skill,
ProfessionalRegistrationMembership, LicenceTicket,
Medical, Capability, Unspecified
Group IDUnique ID of the parent training groupIf exists – 42e289346bf14ef68cd826ab86336e8b
If doesn’t exist – null
Group NameName of the parent training groupIf exists – Competency Group
If doesn’t exist – null
Default Issuing AuthorityAuthority responsible for issuing this CompetencyIf exists – First Aid Australia
If doesn’t exist – null
PointsNumber of points allocated for holding this Competency20
CodeCompetency code providedFA
Expires after - valueThe Competency expires after a certain duration (see next field)8
Expires after - unitDuration typeAllowed values: Days, Weeks, Months, Years
Assigned ToNumber of employees record this competency is assigned to4
Retrieve competency

Update a Competency

Use this action to update details for an existing Competency.

Competencies can be a part of a Group or not. Groups are used to organise Competencies together. They are to Competencies what Folders are to Files.

Groups makes management of Competencies through the User Interface easier.

You can use the “Update Competency” action to move a Competency between Groups, provided the destination Group exists.
Competencies can be associated to a default due date and can expire after a certain amount of time. The due date is a combination of ‘Expires after- value' and ‘Expires after- unit'. These two properties will be the default values when the Competency is allocated to an Employee. They can be changed with the “Update Competency” action.

Update competency
MethodPUT: Update Competency
ParametersAccount ID - Unique identifier of the Account
Competency ID - Unique identifier of the Compentency
Accepted Fields
Field Name DetailsExample
Name - Mandatory
Name of the competencyForklift License
DescriptionA short description of the CompetencyThis is a mandatory requirement for the Employees who work in certain jobs.
TypeType of CompetencyAllowed values: Qualification, Training, Skill,
ProfessionalRegistrationMembership, LicenceTicket,
Medical, Capability, Unspecified
Default issuing authorityAuthority responsible for issuing this CompetencyService NSW
PointsNumber of points allocated for holding this Competency
CodeA short text to describe CompetencyLicense
Default Date completedBy when the Competency is to be achieved2023-12-31
Expires after - valueThe Competency expires after a certain duration (see next field)8
Expires after - unitDuration typeAllowed values: Days, Weeks, Months, Years
Group IDUnique identifier of the Group for this Competency42e289346bf14ef68cd826ab86336e8b
Update competency

Delete a Competency

Use this action to delete an existing Competency.

When you delete a Competency at the Account level, it gets disassociated from all the Employees that had that Competency. It is recommended to look for Employees who have been allocated a Competency before deleting it.

When a Competency is deleted, it is also removed from any Role it was assigned to.

Delete competency
MethodPOST: Delete Competency
ParametersAccount ID - Unique identifier of the Account
Competency ID - Unique identifier of the Compentency
Accepted FieldsNone                                                                                                                                                                 
Delete competency

Assign a Competency to a Role

Use this action to assign an existing Competency to an existing Role.

Once created, Competencies must be allocated to Employees. There are two ways to do this:

  1. You can allocate an individual Competency to the Employee, or
  2. You can include several Competencies in a Role and allocate the Role (and therefore all the Competencies it includes) to the Employee.

If you want to use a Role, you will first need to create the Role and assign the Competencies to this Role.
This action allows you to assign multiple Competency to a Role, by separating the Competencies IDs with comas as per the table below.

Assign competency to a role
MethodPOST: Assign Competency to a Role
ParametersAccount ID - Unique identifier of the Account
Role ID - Unique identifier of the Role
Accepted Fields
Field Name DetailsExample
Competency ID - Mandatory
List of unique IDs for the Competencies to be assigned to the Role, separated by a “comma”.dc56c0e53854462a8cfa23e27e6c6c71 4f369b08a6724d8d8509d0931cc564a6, 6146ea960f084086ab2594508f86b012
Assign competency to a role

List Competencies allocated to an Employee

Use this action to list all the Competencies assigned to an Employee, including those that were allocated as part of a Role.

Once Competencies are created at the Account level, they can be allocated to Employees. There are two ways to do this:

  1. You can allocate an individual Competency to the Employee, or
  2. You can include several Competencies in a Role and allocate the Role (and therefore all the Competencies it includes) to the Employee.

When you use the “List Competencies allocated to an Employee” action, you see:

  1. The Roles that were allocated to the Employee
  2. The Competencies that were individually allocated to the Employee, and
  3. The Competencies that were allocated to the Employee via a Role.
List competency allocated to an Employee
MethodGET: List Competencies allocated to an Employee
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Response
Field Name DetailsExample
Role IDUnique identifier of a Rolef2fc5a50da4c456abe5ceaef512b7e9b
Role NameName of the RoleStore Managers
Competency IDUnique identifier of a Competencydc56c0e53854462a8cfa23e27e6c6c71
Competency NameName of a CompetencyFirst Aid certificate
StatusStatus of the Competency for the EmployeeAllowed Values: In_Progress, Completed, Inactive,
New_Requirement, Missing, Expired,Not_Applicable
List competency allocated to an Employee

Allocate a Competency to an Employee

Use this action to allocate an existing Competency to an Employee.

Once created, Competencies must be allocated to Employees. There are two ways to do this:

  1. Allocate an individual Competency to the Employee, or
  2. Include several Competencies in a Role and allocate the Role (and therefore all the Competencies it includes) to the Employee.

You can only allocate one Competency at a time to an Employee. To allocate more than one Competency at a time, you must use Roles.
When you allocate a Competency to an Employee, it inherits the “Expiry Date” and “Points” from the Competency. You can overwrite them as you allocate the Competency.
To change any other data, you need to use the Update

Assign competency to an employee
MethodPOST: Allocate Competency to an Employee
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Accepted Fields
Field Name DetailsExample
Competency ID - Mandatory
Unique ID of the Competency to be allocated to the Employee.dc56c0e53854462a8cfa23e27e6c6c71
StatusCompetency status of the EmployeeAllowed Values: In_Progress, Completed, Inactive, New_Requirement, Missing, Expired, Not_Applicable
Issuing AuthorityIssuing Authority for the CompetencyService NSW
Issuer IdentifierIssuer identityService NSW
Date CompletedDate the Competency is completed2022-01-15
Expiry DateDate the Competency expires2023-01-14
PointsPoints allocated for this Competency40

Retrieve the details of a Competency for an Employee

Use this action to get the details of a Competency that is allocated to an Employee.

You can use this action for Competencies that were allocated to an Employee either individually or as part of a Role.

Retrieve the details of a Competency for an Employee
MethodGET: List Competency details for an Employee
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Competency ID - Unique identifier of the Competency
Response
Field Name DetailsExample
Competency IDUnique ID of the competencydc56c0e53854462a8cfa23e27e6c6c71
Competency NameName of the competencyFirst Aid certificate
Issuing AuthorityIssuing Authority for the CompetencyAustralian Training Institute
Issuer IdentifierIssuer identityTraining Provider
Date CompletedDate when the Competency is completed2021-08-31
Expiry DateDate the Competency expires2022-09-29
PointsPoints allocated for this Competency40
StatusCompetency status for the EmployeeAllowed Values: In_Progress, Completed, Inactive, New_Requirement, Missing,
Expired, Not_Applicable
Role IDUnique identifier of a RoleIf the Competency was allocated to the Employee via a role: c524532f5628418eb6c5146476e8d2f3
If not: Empty
Role NameName of the RoleIf the Competency was allocated to the Employee via a role: Store Managers
If not: Empty
Retrieve competency allocated to an Employee

Update the details of a Competency for an Employee

Use this action to update the details of a Competency that is allocated to an Employee.

Update competency of an employee
MethodPUT: Update Competency details for an Employee
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Competency ID - Unique identifier of the Competency
Accepted Fields
Field Name DetailsExample
Competency ID - Mandatory
Unique ID of the competencyb5431414c5bb41caa7f79dd4b17221b4
Status - Mandatory
Competency statusAllowed Values: In_Progress, Completed, Inactive, New_Requirement, Missing,
Expired, Not_Applicable
Issuing AuthorityIssuing Authority for the CompetencyAustralian Training Institute
Issuer IdentifierIssuer identityTraining Provider
Date CompletedDate when the Competency is completed2021-08-31
Expiry DateDate the Competency expires2022-09-29
PointsPoints allocated for this Competency40
Update competency of an Employee

Unassign a Competency from an Employee

Use this action to remove a Competency assigned to an Employee.

You can only unassign a Competency that was allocated individually and not as part as a Role.
If the Competency was allocated as part of a Role, you need to unassign the Role, and all the Competencies within that Role.
Alternatively, you could also update the status of the Competency to 'Not applicable' for that Employee.

Unassign competency of an employee
MethodDEL: Unassign Competency from an Employee
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Competency ID - Unique identifier of the Competency
Accepted FieldsNone                                                                                                                                                                 
Unassign competency of an employee

Roles

List all roles

Use this action to list all Roles in the account.

Competencies, once created, must be allocated to Employees. There are two ways to do this:

  1. Allocate an individual Competency to the Employee, or
  2. Include several Competencies in a Role and allocate the Role (and therefore all the Competencies it includes) to the Employee.

To use a Role, you will first need to create the Role and assign Competencies to this Role.

Roles can also be organised into Groups, just like Files can be organised into Folders. Groups are used to make Role management easier in the User Interface.

List Roles
MethodGET: List Roles
ParametersAccount ID - Unique identifier of the Account
Response
Field Name on the ScreenDetailsExample
Role IDUnique ID of the rolec524532f5628418eb6c5146476e8d2f3
NameName of the RoleStore Manager
DescriptionDescription of the RoleCompetencies necessary for the Store Manager
Parent Group IdUnique ID of the Parent GroupIf exists – 082a674d0b314dee9e59f3ee1070c153
If doesn’t exist – null
Parent Group NameName of the Parent GroupIf exists – Employee Roles group
If doesn’t exist – null
List Roles

Retrieve a Role

Use this action to retrieve the details of a Role.

Competencies must be created at the account level before they can be allocated to Employees. There are two ways to do this:

  1. Allocate an individual Competency to the Employee, or
  2. Include several Competencies in a Role and allocate the Role (and therefore all the Competencies it includes) to the Employee.

To use a Role, you will first need to create the Role and assign the Competencies to this Role.

When you create a Role, you can associate a tag to it (identifier). This is useful in the User Interface.

Retrieve Role
MethodGET: Retrieve details about a Role
ParametersAccount ID - Unique identifier of the Account
Role ID - Unique identifier of the Role
Response
Field Name on the ScreenDetailsExample
Role IDUnique ID of the rolec524532f5628418eb6c5146476e8d2f3
NameName of the RoleStore Manager
DescriptionDescription of the RoleCompetencies necessary for the Store Manager
Parent Group IdUnique ID of the Parent GroupIf exists – 082a674d0b314dee9e59f3ee1070c153
If doesn’t exist – null
Parent Group NameName of the Parent GroupIf exists – Employee Roles group
If doesn’t exist – null
IdentifierAdditional tag on the training roleManager Role
Assigned toNumber of employee records to which this role is assigned1
Assigned Competency IDUnique ID of the competency assigned to roledc56c0e53854462a8cfa23e27e6c6c71
Assigned Competency NameName of the competency assigned to roleFirst Aid certificate
Retrieve Roles
Retrieve Roles

Create a Role

Use this action to create a new Role.

Competencies must be created at the Account level before they can be allocated to Employees. There are two ways to do this:

  1. Allocate an individual Competency to the Employee, or
  2. Include several Competencies in a Role and allocate the Role (and therefore all the Competencies it includes) to the Employee.

To use a Role, you will first need to create the Role and assign the Competencies to this Role.

When you create a Role, you can associate a tag to it (identifier). This is useful in the User Interface.

Create Role
MethodPOST: Create a new Role
ParametersAccount ID - Unique identifier of the Account
Accepted Fields
Field NameDetailsExample
Name - Mandatory
Name of the RoleStore Managers
DescriptionA short description of the RoleCompetencies necessary for the Store Manager
IdentifierAdditional tag on the training roleManagers
Group IdUnique identifier of the role group for this role to be under.42e289346bf14ef68cd826ab86336e8b
Create Role
Create Role

Update a Role

Use this action to update an existing role.

Roles are used to group Competencies together to make allocation to Employees easier. Instead of having to allocate each Competency separately, you can allocate the Role and every Competency included in the Role to an employee at the same time.
You can update the Name, Description, Identifier and Group ID of a Role.
This action cannot be used to change the Competencies assigned to a Role. Instead, you need to use the “Assign a Competency to a Role” or “Unassign a Competency from a Role” action.
Update Role
MethodPUT: Update Role
ParametersAccount ID - Unique identifier of the Account
Role ID - Unique identifier of the Role
Accepted Fields
Field NameDetailsExample
Name - Mandatory
Name of the RoleStore Managers
DescriptionA short description of the RoleCompetencies necessary for the Store Manager
IdentifierAdditional tag on the training roleManagers
Group IdUnique identifier of the role group for this role to be under.42e289346bf14ef68cd826ab86336e8b
Update Role

Delete a Role

Use this action to delete an existing role.

Roles are used to group Competencies together to make allocation to Employees easier. Instead of having to allocate each Competency separately, you can allocate the Role and every Competency included in the Role to an employee at the same time.
When you delete a Role that has been allocated to an Employee, the Competencies within this Role remains allocated to the Employee.
Delete Role
MethodDEL: Delete Role
ParametersAccount ID - Unique identifier of the Account
Role ID - Unique identifier of the Role
Accepted FieldsNone                                                                                                                                                                 
Delete Role

Allocate a Role to an Employee

Use this action to allocate a Role to an Employee.

Roles are used to group Competencies together to make allocation to Employees easier. Instead of having to allocate each Competency separately, you can allocate the Role to the Employee, and all the Competencies included in the Role will be allocated to the Employee at the same time.

Note: If you allocate a Competency individually to an Employee and later allocate a Role that includes the same Competency, then the Employee will have this Competency twice.

Allocate Role to Employee
MethodPOST: Allocate Role to Employee
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Accepted Fields
Field NameDetailsExample
Role ID - Mandatory
Unique ID of the Role to be allocated to the Employee.8049e35984f04812b42cb109ae7a58a3
Allocate Role to Employee
Allocate Role to Employee

Unassign a Role from an Employee

Use this action to unassign a Role form an Employee.

Roles are used to group Competencies together to make allocation to Employees easier. Instead of having to allocate each Competency separately, you can allocate the Role to the Employee, and all the Competencies included in the Role will be allocated to the Employee at the same time.
When you unassign a Role from an Employee, the Competencies in the Role will remain allocated to the Employee.
Unassign a Role from an Employee
MethodDEL: Unassign Role from an Employee
ParametersAccount ID - Unique identifier of the Account
Employee ID - Unique identifier of the Employee
Role ID - Unique identifier of the Role
Accepted FieldsNone                                                                                                                                                                 
Unassign a Role from an Employee
Unassign a Role from an Employee

Groups

Definitions

Groups are used in the User Interface to make the management of Roles and Competencies easier.

Groups are like folders in which you would organize your files.

A Group can be of one of two types:

  • Competency Groups are used to group Competencies together.
  • Role Groups are used to group Roles together.

Using Groups makes management of Competencies through the User Interface easier

List all Groups

Use this action to list all Groups in the account.

Competencies and Roles can be organised in Groups, just like files can be organised in folders.
Both Competencies and Roles cannot co-exist in a Group: it is either for Competencies or for Roles.

Groups can be organised in a “tree-like hierarchy”, where each Group can have multiple Sub-Groups.
All Groups withing a hierarchy must be of the same type. In other words, a “Competency-type Group” cannot have a Parent or Child Group that is a “Role-type Group”.

List all Groups
MethodGET: List Groups
ParametersAccount ID - Unique identifier of the Account
Accepted Fields
Field Name on the ScreenDetailsExample
Group IDUnique ID of the Group42e289346bf14ef68cd826ab86336e8b
NameName of the GroupDriving Licenses
TypeType of the GroupPossible values: Role, Competency
Parent Group IdUnique ID of the Parent GroupIf exists – cc27e24987434ee0bb39d410937263c7
If doesn’t exist – null
Parent Group NameName of the Parent GroupIf exists – Licenses
If doesn’t exist – null
Child Group IdUnique ID of the Child GroupIf exists – cc27e24987434ee0bb39d410937299d4
If doesn’t exist – null
Child Group NameName of the Child GroupIf exists – Forklift Licences
If doesn’t exist – null
List all Groups

Create a Group

Use this action to create a Group.

Competencies and Roles can be organised in Groups, just like files can be organised in folders.

When you create a Group, you need to specify its type: Competency or Role.

A “tree-like hierarchy” can be created between Groups:

  • A Group can have only one “Parent Group”
  • A Parent Group can have several “Child Groups”

When you create a Group, you can attach it underneath a Parent of the same type only.

A Parent Group and Child Group cannot be linked at the same time instead,

  1. Create the Parent Group
  2. Create each Child Group separately and attach them to the Parent.

If you don’t indicate a Parent Group ID, then the Group will sit at the top level. There can be as many Groups as you want at the top level.

Create Group
MethodPOST: Create Group
ParametersAccount ID - Unique identifier of the Account
Accepted Fields
Field NameDetailsExample
NameName of the GroupDriving Licenses
Group TypeType of the GroupPossible values: Role, Competency
Parent Group IDUnique ID of the Parent Groupcc27e24987434ee0bb39d410937263c7
Create Group

Retrieve the details of a Group

Use this action to retrieve the details of a Group.

Competencies and Roles can be organised in Groups, just like files can be organised in folders.
A Group can have several Sub-Groups, but only one Parent.
Retrieving the details of the Group doesn’t give you the list of Competencies (or Roles) it includes.

Retrieve Group
MethodGET: Retrieve Group
ParametersAccount ID - Unique identifier of the Account
Group ID - Unique identifier of the Group
Parameters
Field NameDetailsExample
Group IDUnique ID of the Group42e289346bf14ef68cd826ab86336e8b
NameName of the GroupDriving Licenses
Parent Group IDUnique ID of the Parent GroupIf exists – cc27e24987434ee0bb39d410937263c7
If doesn’t exist – null
Parent Group NameUnique ID of the Parent GroupIf exists – Licences
If doesn’t exist – null
Child Group IDUnique ID of the Child GroupIf exists – cc27e24987434ee0bb39d410937263c7
If doesn’t exist – null
Child Group NameUnique ID of the Child GroupIf exists – Licences
If doesn’t exist – null
Retrieve Group

Update a Group

Use this action to update a Group.

Competencies and Roles can be organised in Groups, just like files can be organised in folders.

You can update the ‘Name’ and ‘Type’ of a Group

This action is used to move a Group from one Parent Group to another Parent Group of the same type (so the Group and its Parent are of the same type).

If you don’t indicate a Parent Group ID, then the Group will move to the top level.

Update Group
MethodPUT: Update Group
ParametersAccount ID - Unique identifier of the Account
Group ID - Unique identifier of the Group
Accepted Parameters
Field NameDetailsExample
Name - Mandatory
Name of the GroupForklift license
Type - Mandatory
Type of the GroupPossible values: Role, Competency
Parent Group IDUnique ID of the Parent Group42e289346bf14ef68cd826ab86336e8b
Update Group

Delete a Group

Use this action to delete a Group.

Competencies and Roles can be organised in Groups, just like files can be organised in folders.

Deleting the Group will also delete any Child Group attached to it.

When a Group is deleted, the Competencies (or Roles) that were associated to it remain in the system.
If these Competencies (or Roles) were allocated to Employees, these allocations remain.

Delete Group
MethodPOST: Delete Group
ParametersAccount ID - Unique identifier of the Account
Group ID - Unique identifier of the Group
Accepted ParametersNone                                                                                                                                                                 
Delete Group
© 2022 enableHR · All rights reserved