Skip to main content

API - using GetShiftsV3

Nelson Walker

We use the API to weekly download scheduling information - method GetSchedulesV3() which we import into a DB.

Our sales people tell us the schedule information is incomplete so we also want to use GetShiftsV3 and see if it returns more data.

For example if I run GetSchedulesV3, it returns 2982 rows for a specific week.  But I can't figure out exactly how the flags IsHouse, IsScheduled, and IsPosted work, they seem to interact with each other is some kind of and/or/not logic etc.

If I run GetShiftsV3 InHouse false, IsSch true IsPost true, it returns the same count as GetSchedulesV3 - I'm not sure if it is exactly the same data but it is the same count.   

I don't fully understand the interaction of the 3 boolean values, and I am asking if the community can provide some insight on how GetShiftsV3 can be called to return a more complete data set than GetSchedulesV3.

Thank you for your help

0 votes

Linked Ideas

Comments

Nelson Walker

More information on my request:

We were using GetSchedulesV3 and the API documentation didn’t mention if it included schedules that were saved but not posted.  So we wanted to try GetShiftsV3 to see if there was a difference in the data.  We found there was a difference, but we ran some experiments with the eight possible combinations of the three flags and couldn’t figure out what the data meant.  We are looking for schedules that are saved and (posted or not posted). 

Here are my experiment counts:

 

IsHouse, IsScheduled, IsPosted

Dates 10/02-10/08

 

#records             

2982       Baseline GetSchedules

1037       FFF

1371       FFT

25           FTF

2982       FTT  - same count as GetSchedules

0              TFF

1              TFT

0              TTF

54           TTT

Brandon Buettner

Hello Nelson,

The flags you mentioned (isHouse, isScheduled, isPosted) do not exist in getScheduleV3. These are only available in getShiftsV3, so there is no logic or interactions in your first call.

I believe the following documentation should provide what you are looking for:


If you have any further questions it may be best to send an email to support@hotschedules.com so we can create a case for you.

Please sign in to leave a comment.