The VAIRKKO API allows Authorized Data Distribution Partners (ADDP) to consume our REST-style web services over unique URLs. Below is a list of the available scheduling functions and their parameters.
Return One or More Employee Records:
https://api.vairkko.com/API/index.cfm/users/getUsers?PK=[Insert Your Partner Key]&CK=[Insert Client Key]
Parameters:
| Parameter | Required/Optional | Description |
| RF | Optional | Determines the return format of requested data:
|
| BadgeID | Optional | A unique employee number assigned to the employee by your organization. Allows searching for a single user/employee record; if not included in your request, all users within your VAIRKKO platform are returned. |
| emailAddr | Optional | Employee's email address in VAIRKKO. |
| UserStatus | Optional |
|
| WorkStatus | Optional | Active, In-Active, Leave (Medical), Leave (Personal), Light Duty, Suspended |
Example: https://api.vairkko.com/API/index.cfm/users/getUsers?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&RF=JSON&BadgeID=ABC123&empstatus=active
Data That is Returned
| Parameter | Description |
| fname | First Name of the user record being created |
| middleName | Middle Name of the user record being created |
| lname | Last Name of the user record being created |
| primaryjob | Primary Job Title of the user record being created |
| badgeID | Unique number assigned to employee created by your Agency |
| emailAddr | Unique Email Address assigned to employee created by your Agency |
| locationID | Location associated with the employee. If not used employee will be linked to the first location created in the system. |
| dept | Department associated with the employee. If not used employee will be linked to the first department created in the system. |
| gender | Male, Female, Other |
| ftptpd | Full Time, Part Time, Per Diem, Casual, Volunteer |
| workStatus | Active, In-Active, Leave (Medical), Leave (Personal), Light Duty, Suspended |
| personalEmail | Employee's Personal Email Address |
| addr | Employee's Street address |
| addr2 | Additional address information (Suite, Apt) |
| City | City portion of employee's address |
| State | State portion of employee's address |
| Zip | Zip Code portion of employee's address |
| dob | Employee's birthday MM/DD/YYYY format |
| cellNum | 9195551234 format |
| homePhone | 9195551234 format |
| workPhone | 9195551234 format |
| workExt | Employee's work Ext |
| hireDate | Employee's Hire Date MM/DD/YYYY format |
| seniorityDate | Full time start date of an employee that was previously part time. MM/DD/YYYY format |
| cmpyID | Company associated with the employee. If not used employee will be linked to the first company created in the system. |
| userSup | Last Name, First Name |
| userstatus | Active or Disabled |
| terminationdate | will only return values for disabled accounts |
Create New Employee / User Record:
https://api.vairkko.com/API/index.cfm/users/Create?PK=[Insert Your Partner Key]&CK=[Insert Client Key]
| Parameter | Required/Optional | Description |
| fname | Required | First Name of the user record being created |
| middleName | Optional | Middle Name of the user record being created |
| lname | Required | Last Name of the user record being created |
| primaryjob | Optional | Primary Job Title of the user record being created |
| badgeID | Required if NOT using Email Address | Unique number assigned to employee created by your Agency |
| emailAddr | Required if NOT using Badge ID | Unique Email Address assigned to employee created by your Agency |
| password | Optional | If not provided the system will generate password |
| locationID | Optional | Location associated with the employee. If not used employee will be linked to the first location created in the system. |
| dept | Optional | Department associated with the employee. If not used employee will be linked to the first department created in the system. |
| gender | Optional | Male, Female, Other |
| ftptpd | Optional | Full Time, Part Time, Per Diem, Casual, Volunteer |
| workStatus | Optional | Active, In-Active, Leave (Medical), Leave (Personal), Light Duty, Suspended |
| personalEmail | Optional | Employee's Personal Email Address |
| addr | Optional | Employee's Street address |
| addr2 | Optional | Additional address information (Suite, Apt) |
| City | Optional | City portion of employee's address |
| State | Optional | State portion of employee's address |
| Zip | Optional | Zip Code portion of employee's address |
| dob | Optional | Employee's birthday MM/DD/YYYY format |
| cellNum | Optional | 9195551234 format |
| homePhone | Optional | 9195551234 format |
| workPhone | Optional | 9195551234 format |
| workExt | Optional | Employee's work Ext |
| hireDate | Optional | Employee's Hire Date MM/DD/YYYY format |
| seniorityDate | Optional | Full time start date of an employee that was previously part time. MM/DD/YYYY format |
| cmpyID | Optional | Company associated with the employee. If not used employee will be linked to the first company created in the system. |
| userSup | Optional | Email address of Employee's Supervisor |
| customfield_XX | Optional | To assign values to custom fields in a user record within VAIRKKO, use the following format: customfield_[custom field ID] = "value". For example, if the custom field has an ID of 99, and you want to set its value to "blue", you would use: customfield_99=blue |
Example: https://api.vairkko.com/API/index.cfm/users/Create?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&RF=JSON&BadgeID=ABC123&fname=John&lname=Doe........
Returns: Success: Status Code of 200 along with JSON String
Update Existing Employee / User Record:
https://api.vairkko.com/API/index.cfm/users/edit?PK=[Insert Your Partner Key]&CK=[Insert Client Key]
| Parameter | Required/Optional | Description |
| fname | Required | First Name of the user record being created |
| middleName | Optional | Middle Name of the user record being created |
| lname | Required | Last Name of the user record being created |
| primaryjob | Optional | Primary Job Title of the user record being created |
| badgeID | Required if NOT using Email Address | Unique number assigned to employee created by your Agency |
| emailAddr | Required if NOT using Badge ID | Unique Email Address assigned to employee created by your Agency |
| password | Optional | If not provided the system will generate password |
| locationID | Optional | Location associated with the employee. If not used employee will be linked to the first location created in the system. |
| dept | Optional | Department associated with the employee. If not used employee will be linked to the first department created in the system. |
| gender | Optional | Male, Female, Other |
| ftptpd | Optional | Full Time, Part Time, Per Diem, Casual, Volunteer |
| workStatus | Optional | Active, In-Active, Leave (Medical), Leave (Personal), Light Duty, Suspended |
| personalEmail | Optional | Employee's Personal Email Address |
| addr | Optional | Employee's Street address |
| addr2 | Optional | Additional address information (Suite, Apt) |
| City | Optional | City portion of employee's address |
| State | Optional | State portion of employee's address |
| Zip | Optional | Zip Code portion of employee's address |
| dob | Optional | Employee's birthday MM/DD/YYYY format |
| cellNum | Optional | 9195551234 format |
| homePhone | Optional | 9195551234 format |
| workPhone | Optional | 9195551234 format |
| workExt | Optional | Employee's work Ext |
| hireDate | Optional | Employee's Hire Date MM/DD/YYYY format |
| seniorityDate | Optional | Full time start date of an employee that was previously part time. MM/DD/YYYY format |
| cmpyID | Optional | Company associated with the employee. If not used employee will be linked to the first company created in the system. |
| userSup | Optional | Email address of Employee's Supervisor |
| customfield_XX | Optional | To assign values to custom fields in a user record within VAIRKKO, use the following format: customfield_[custom field ID] = "value". For example, if the custom field has an ID of 99, and you want to set its value to "blue", you would use: customfield_99=blue |
Example: https://api.vairkko.com/API/index.cfm/users/edit?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&RF=JSON&BadgeID=ABC123&fname=John&lname=Doe........
Returns: Success: Status Code of 200 along with JSON String