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:

ParameterRequiredDescription
RFOptional

The format the data is returned in

  • XML(Default)
  • JSON

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 pointDescription
Auto Change to Instant Fill

Number of days in the future when openings will be made instant fill

  • -1 = Never
  • Positive numbers indicate number of days in the future
Color IDThe Hex color code of the job
DescriptionJob Name
DisabledAll returned rows are from active jobs
Instant Fill

Are all openings set to be instant fill

  • -1 = No
  • 1 = Yes
Job IDVAIRKKO ID assigned to job
Job Type
  • 1 = Core
  • 2 = Overflow
Loation IDLocation ID
VehicleVehicle 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:

ParameterRequiredDescription
RFOptional

The format the data is returned in

  • XML(Default)
  • JSON

Example: 

https://api. vairkko.com/API/index.cfm/schedule/getStaffRoles?PK=[Insert Your Partner Key]&CK=[Insert Client Key]&RF=JSON

Returned Data

Data PointDescription
Role NameName of the Staff Role
Role IDVAIRKKO 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:

ParameterRequiredDescription
RFOptional

The format the data is returned in

  • XML(Default)
  • JSON
Start DateOptional

The start date of the schedule data you want to return

  • Default date is one month prior to current date
  • Date formatted as MM-DD-YYYY
End DateOptional

The end date of the schedule data you want to return

  • Default is current day at 23:59:59
  • Date formatted as MM-DD-YYYY
Badge IDOptionalThe employee's badge ID. This will return data for that employee only.
JobOptionalThe name of the schedule Job. This will return data for that schedule job only
Shift GroupOptionalThe 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 PointDescription
Badge IDThe badge ID of the employee assigned to the slot
End Date TimeShift End (YYYY-MM-DD HH:MM:SS format)
FnameFirst name of employee on shift
Group NameName of the Shift Group linked to position
JobName of job linked to the position
LnameLast name of the employee on shift
Location NameName of location assigned to the job
Shift HoursTotal hours of scheduled shift
Shift TypeShift Type
Start Date TimeShift Start (YYYY-MM-DD HH:MM:SS format)
VehicleVehicle assigned to shift