The VAIRKKO API allows Authorized Data Distribution Partners (ADDP) to consume our REST style webservices over unique URLs. Below is a list of the available scheduling functions and their parameters.
Schedule Jobs
This function returns the names of the active jobs on your platform. This will not return schedule data, only the job name. You can use the URL and Parameters below.
https://api.vairkko.com/API/index.cfm/schedule/getScheduleJobs?PK=[Insert Your Partner Key]&CK=[Insert Client Key]
Parameters:
| Parameter | Required | Description |
| RF | Optional | The format the data is returned in
|
Example:
https://api. vairkko.com/API/index.cfm/schedule/getScheduleJobs?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&RF=JSON
Data That is Returned
| Data point | Description |
| Auto Change to Instant Fill | Number of days in the future when openings will be made instant fill
|
| Color ID | The Hex color code of the job |
| Description | Job Name |
| Disabled | All returned rows are from active jobs |
| Instant Fill | Are all openings set to be instant fill
|
| Job ID | VAIRKKO ID assigned to job |
| Job Type |
|
| Loation ID | Location ID |
| Vehicle | Vehicle Name assigned to job |
Staff Roles
This function returns the names of the staff roles on your platform. This will not return schedule data, only the job name. You can use the URL and Parameters below.
https://api. vairkko.com/API/index.cfm/schedule/getStaffRoles?PK=[Insert Your Partner Key]&CK=[Insert Client Key]
Parameters:
| Parameter | Required | Description |
| RF | Optional | The format the data is returned in
|
Example:
https://api. vairkko.com/API/index.cfm/schedule/getStaffRoles?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&RF=JSON
Returned Data
| Data Point | Description |
| Role Name | Name of the Staff Role |
| Role ID | VAIRKKO ID assigned to staff role |
Schedule Roster
The schedule roster function returns a list of all scheduling data within the system that is generated and published. You can use the URL and Parameters below.
https://api. vairkko.com/API/index.cfm/schedule/getSchedule?PK=[Insert Your Partner Key]&CK=[Insert Client Key]
Parameters:
| Parameter | Required | Description |
| RF | Optional | The format the data is returned in
|
| Start Date | Optional | The start date of the schedule data you want to return
|
| End Date | Optional | The end date of the schedule data you want to return
|
| Badge ID | Optional | The employee's badge ID. This will return data for that employee only. |
| Job | Optional | The name of the schedule Job. This will return data for that schedule job only |
| Shift Group | Optional | The name of the shift group, This will return data for that shift group only |
Example:
https://api. vairkko.com/API/index.cfm/schedule/getSchedule?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&RF=JSON&StartDate=XX-XX-XXXX&EndDate=XX-XX-XXXX&BadgeID=1234ABC&Job=Medic 505&ShiftGroup=0700-0700
Returned Data
| Data Point | Description |
| Badge ID | The badge ID of the employee assigned to the slot |
| End Date Time | Shift End (YYYY-MM-DD HH:MM:SS format) |
| Fname | First name of employee on shift |
| Group Name | Name of the Shift Group linked to position |
| Job | Name of job linked to the position |
| Lname | Last name of the employee on shift |
| Location Name | Name of location assigned to the job |
| Shift Hours | Total hours of scheduled shift |
| Shift Type | Shift Type |
| Start Date Time | Shift Start (YYYY-MM-DD HH:MM:SS format) |
| Vehicle | Vehicle assigned to shift |