The VAIRKKO API allows Authorized Data Distribution Partners (ADDP) to access our RESTful web services through unique URLs. Below is a list of the available scheduling functions along with their respective parameters.
Employee Certifications API
This function provides access to a detailed result set containing some employee information along with their assigned certifications. You can retrieve data by entering either an employee’s Badge ID or a specific certification. To return certifications for all employees, use the URL below. To return specific certification details, use the listed parameters.
https://api.vairkko.com/API/index.cfm/CertificationCloud/Certifications?PK=[Insert Your Partner Key]&CK=[Insert Client Key]
Parameters:
| Parameter | Required / Optional | Description |
| PK | Required | Partner Key |
| CK | Required | Client Key |
| RF | Optional |
Determines the return format of the data
|
| SI | Optional |
Scope Identity
|
| SC | Optional |
Scope
|
| ES | Optional |
Employment Status
|
Example: https://api.vairkko.com/API/index.cfm/CertificationCloud/Certifications?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&RF=JSON&SI=12345&SC=1&ES=Active
Data That is Returned
| Data Point | Description |
| Badge ID | The Employee's Badge / Staff ID in VAIRKKO |
| Can Login | Is the employee able to login |
| Cell Phone | Listed cell phone number for employee |
| Certification Activation Date | The date the certification was awarded |
| Certification Description | Certification Description found in the certification template |
| Certification Expiration Date | Date the certification expires |
| Certification ID | Certification Template ID |
| Certification Name | Name of Certification |
| Certification Number | Certification Number |
| CEU | Continuing Education Units |
| Department Name | Employee's home Department |
| Does Certification expire |
|
| ECUE | Elective Education Units |
| Email Address | Employee's Primary Email in VAIRKKO |
| Gender | Employee's listed gender in VAIRKKO |
| Home Phone | Employee's home phone listed in VAIRKKO |
| Is Active Certification |
|
| Job Title | Employee's Primary Job Title |
| Last Login | Employee's last login date |
| Location Code | Code associated with the employee's location |
| Location Name | Name of employee's home location |
| Employee Name | Last Name, First Name |
| Skill Level | Skill level of current certification |
| Trainer | Trainer listed on certification |
| Employement Status |
|
Certification Templates
The Templates function provides access to a set of certification template details, based on the input of either a Provider ID or a specific Template ID. To return certifications for all employees, please use the following URL. To return specific certification details, use the listed parameters.
https://api.vairkko.com/API/index.cfm/CertificationCloud/Templates?PK=[Insert Your Partner Key]&CK=[Insert Client Key]
Parameters:
| Parameter | Required / Optional | Description |
| PK | Required | Partner Key |
| CK | Required | Client key |
| RF | Optional |
Return Format
|
| SI | Optional |
Scope Identity
|
| SC | Optional |
Scope
|
Example: https://api.vairkko.com/API/index.cfm/CertificationCloud/Templates?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&RF=XML&SI=123&SC=2
Data that is returned
| Data Point | Description |
| Certification Description | Certification Description from template |
| Certification ID | ID number assigned to the template |
| Certification Name | Name of certification template |
| CEU | Continuing Education Credits |
| Disabled |
|
| Expires |
|
| ECEU | Elective Continuing Education Credits |
| Pause In Days | Number of days the employee can pause certification alerts |
| Provider ID | Company ID |
| Record Type | Type of certification record. |
| Renewal Frequency | Value certification is valid for |
Certification Custom Fields
The Custom Field function provides access to certification custom fields, based on the Scope Identity and Certification Template ID. This API process has required fields and will not return data if any of the required fields are left blank.
Parameters:
| Parameter | Required / Optional | Description |
| PK | Required | Partner Key |
| CK | Required | Client Key |
| SI | Required |
Scope Identity
|
| CI | Required | Template ID |
| BI | Required if using a SI of 4 | Employee Badge ID |
Example: https://api.vairkko.com/API/index.cfm/CertificationCloud/CustomFields?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&SI=1&CI=256
Data That is Returned
| Data Point | Description |
| Certification ID | Certification Template ID |
| Custom Note | Note related to custom field |
| Field Title | Name of custom field |
| Field Value | Data in field |
| Template Field |
|
Is Employee Compliant
Is the Employment Compliance function allow you to validate an individual employee against an individual compliance rule? This function returns a value of True for Compliant and False for Non-Compliant
Parameters:
| Parameter | Required / Optional | Description |
| PK | Required | Partner Key |
| Ck | Required | Client Key |
| EI | Required | Employee Badge ID |
| CI | Required | Compliance Rule ID |
Example: https://api.vairkko.com/API/index.cfm/CertificationCloud/CustomFields?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&EI=1&CI=256
Department Compliance
The Department Compliance function allows you to validate an individual Department against an individual compliance rule. This function returns a percentage value for the department.
Parameters:
| Parameter | Required / Optional | Description |
| PK | Required | Partner Key |
| Ck | Required | Client Key |
| DI | Required | Department ID |
| CI | Required | Compliance Rule ID |
Example: https://api.vairkko.com/API/index.cfm/CertificationCloud/CustomFields?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&DI=1&CI=256
Issue a Certification
The Issue Certification function allows you to award a certification to an individual employee. This function will also update Roadmaps, Assignments, and follow any configurations of the certification template.
Parameters:
| Parameter | Required / Optional | Description |
| PK | Required | Partner Key |
| CK | Required | Client Key |
| EI | Required if Using Employee ID | This is the Employee ID found in the URL when viewing an employee in VAIRKKO |
| BI | Required if Using Badge ID | Employee's Badge ID in VAIRKKO |
| CI | Required | Certification Template ID. Can be one ID or multiple IDs separated by a comma |
| EX | Optional | Expiration Date. If left blank Expiration date will be determined by the Template Renewal Frequency. yyyy-mm-dd format |
| CN | Optional | Certification Number |
| RF | Optional | Return Format JSON or XML |
Example when using Employee ID: https://api.vairkko.com/API/index.cfm/CertificationCloud/Issue?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&EI=2233&CI=6543&EX=2026-09-09
Example when using Badge ID: https://api.vairkko.com/API/index.cfm/CertificationCloud/Issue?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&BI=2233&CI=6543&EX=2026-09-09
Get Roadmaps
The GET ROADMAPS function returns the roadmap name, all prerequisites required for completing the roadmap, and any certification that is issued upon completion of the roadmap. It can take a roadmap ID; otherwise, it returns all roadmaps for the authenticated provider.
Parameters:
| Parameter | Required / Optional | Description |
| PK | Required | Partner Key |
| CK | Required | Client Key |
| SI | Optional | Roadmap ID |
| RF | Optional | Return Format JSON or XML |
Example https://api.vairkko.com/API/index.cfm/CertificationCloud/getRoadmaps?PK=[Partner Key]&CK=[Client Key]&SI=[roadmapID]&RF=XML
Roadmap Audit
The AUDIT ROADMAP function returns the overall completion of the roadmap for each individual that is assigned to the roadmap and a list of all that individual's acquired (and missing) certifications that are a part of the roadmap. It requires a roadmap ID.
Parameters:
| Parameter | Required / Optional | Description |
| PK | Required | Partner Key |
| CK | Required | Client Key |
| SI | Required | Roadmap ID |
| RF | Optional | Return Format JSON or XML |