API Functions for Assignments

Created by Jason Gaines, Modified on Tue, 7 Jul at 5:20 PM by Jason Gaines

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 Assignments API

To return all data for employees and assignments, use the link below.

https://api.vairkko.com/API/index.cfm/Assignments/activeAssignments?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&providerid=[insertproviderid]

Data That Is Returned

Data Point	Description
Assignment Type	Dynamic Group, Static Group, or Individual
Badge ID	Employee's staff / badge ID
Company ID	Internal VAIRKKO Company ID
Company Name	Name of Company associated with internal VAIRKKO Company ID
Complete	Is assignment complete [Complete or Incomplete]
Course Complete	If assignment is an individually assigned course [Complete or Incomplete]
Date Created	Date assignment was created
Date Due	Date the assignment is due
Date Updated	Last time assignment was updated
Department ID	Internal VAIRKKO Department ID
Department Name	Name of Department associated with internal VAIRKKO Company ID
Disabled	Is the employee disabled, all return data will be Nondisabled users [-1]
Email Address	Employee's email address
Excluded Names	Names of employees excluded from the assignment
Full Name	Last Name, First Name
Is Active	Internal VAIRKKO Number
Is Complete	Internal VAIRKKO Number
Is Dynamic	Internal VAIRKKO Number
Item ID	Internal VAIRKKO Number
Item Label	Name of Assignment [Compliance Rule Name, Course Name, Etc]
Item Type ID	Internal VAIRKKO Number
Item Type Label	Type of assignment [Compliance Rule,eLearning, Certification]
Location ID	Internal VAIRKKO Number
Location Name	Name of Location associated with Internal VAIRKKO Number
Notify Create	Employee, Supervisor, Mentor
Notify Create Names	Names of those notified
Notify Overdue	Employee, Supervisor, Mentor
Notify Overdue Name	Names of those notified
Parent Assignment ID	Internal VAIRKKO Number
PCA Status	Status of Post Course Action
Region ID	Internal VAIRKKO Number
Region Name	Name of Region associated with Internal VAIRKKO Number
Row ID	Internal VAIRKKO Number
Score	Score awarded to eLearning Course
Sub Track Name	Name of eLearning Sub Track
Sup Email	Supervisor Email
Sup Name	Last Name, First Name of Supervisor
Tags	Internal VAIRKKO Number
Tags Raw	Names of tags
Track Name	Name of eLearning Track