API Docs

Waffle House OLS API Help Page

Introduction

Provide a general description of your APIs here.

BoA

API	Description
POST api/boa/authenticate	No documentation available.
POST api/boa/validateAccount	No documentation available.

OLSApi

API	Description
GET Api/Units/{unit_id}/AllSchedules	Returns list of future schedules.
GET Api/Units/{unit_id}/Schedules/{current_schedule_id}/Previous	Returns previous schedule.
GET Api/Units/{unit_id}/Schedules/{current_schedule_id}/Previous10	Returns previous ten schedules.
GET Api/Units/{unit_id}/Schedules/{current_schedule_id}/Next	Returns next schedule.
GET Api/Units/{unit_id}/Shifts/{schedule_id}	Returns shifts and timing details and dates of each day for the week
GET Api/Units/{unit_id}/Employees	Returns all employees from unit.
GET Api/Units/{unit_id}/Employees/{prss_id}	Returns particular employee from unit.
GET Api/Units/{unit_id}/Schedules/{schedule_id}/EmployeeTotalHours	Returns list of employees with total hours working during this schedule.
GET Api/Units/{unit_id}/Schedules/{schedule_id}	Returns schedule details for a unit.
GET Api/Units/{unit_id}/Schedules/{schedule_id}/ValidationMessages	Returns schedule validation messages.
GET Api/Units/{unit_id}/Schedules/{schedule_id}/ScheduleItems/{schedule_item_id}	Returns a schedule item.
GET Api/Units/{unit_id}/Schedules/{schedule_id}/Days/{day_number}/ScheduleItems	Returns all schedule items for a day.
GET Api/Units/{unit_id}/Schedules/{schedule_id}/Employees/{prss_id}/ScheduleItems	Returns all schedule items for an employee.
GET Api/Units/{unit_id}/Schedules/{schedule_id}/Days/{day_number}/OLRSales	Returns OLRSales for a schedule day.
GET Api/Units/{unit_id}/Schedules/{schedule_id}/Days/{day_number}/OLRSchedule	Returns OLRSchedule for scheduled day.
POST Api/Units/{unit_id}/Schedules/{schedule_id}/ScheduleItems	Add a new scheduled item.
PUT Api/Units/{unit_id}/Schedules/{schedule_id}/ScheduleItems/{schedule_item_id}	Update scheduled item.
DELETE Api/Units/{unit_id}/Schedules/{schedule_id}/ScheduleItems/{schedule_item_id}	Remove scheduled item.
POST Api/Units/{unit_id}/Schedules/{schedule_id}/Publish	Publish Schedule.
POST Api/Units/{unit_id}/Schedules/{schedule_id}/Unpublish	Unpublish Schedule.
POST Api/Units/{unit_id}/Schedules/{schedule_id}/Clear	Clear Schedule.
POST Api/Units/{unit_id}/Schedules/{current_schedule_id}/Copy	Copy Schedule.
POST Api/Units/{unit_id}/Schedules/{schedule_id}/SyncOLR	Sync latest OLR with schedule.
GET Api/Units/{unit_id}/Schedules/{schedule_id}/DownloadMasterBudgetScheduleReport	Donwload Master Budget Schedule Report.

BlueFletchApi

API	Description
POST api/auth/token	No documentation available.

CommonApi

API	Description
GET Api/OLR/Units	No documentation available.
GET Api/Jobs	Returns all scheduled jobs.
GET Api/OLR/Breakdowns	Get all staffing breakdowns

OLRApi

API	Description
GET Api/OLR/{unitId}/{fyopWeekId}/Staffing	Get staffing for a specific week, fyop and unit
GET Api/OLR/{unitId}/{fyopWeekId}/Sales	Get the catering and merchandise sales for a specific week
GET Api/OLR/{unitId}/{fyopWeekId}/Metrics	Get all the metrics for a specific week
GET Api/OLR/{unitId}/{fyopWeekId}/Favorites	Get all copyable favorites for unit
GET Api/OLR/{unitId}/{fyopWeekId}/Copy	Get all copyable staffing items for unit
GET Api/OLR/{unitId}/{fyopWeekId}/NextAndPreviousWeeks	Get previous and next weeks for a specific week
GET Api/OLR/{unitId}/FYOPs	Get all FYOPs available for a unit
GET Api/OLR/{unitId}/ProfileBreakdown?ProjectedSales={ProjectedSales}&ShiftId={ShiftId}	Get profile breakdown for projected sales
GET Api/OLR/{unitId}/ProfileBreakdown/Threshold	Get profile breakdown thresholds for unit
GET Api/OLR/{unitId}/Chart	Get chart data for unit
POST Api/OLR/{unitId}/{fyopWeekId}/View	Set view staffing for a specific job and shift
POST Api/OLR/{unitId}/{fyopWeekId}/Staffing	Adjust staffing for a specific job and shift
POST Api/OLR/{unitId}/{fyopWeekId}/Sales	Adjust staffing for a specific job and shift
POST Api/OLR/{unitId}/{fyopWeekId}/Favorite	Mark a staffing week as a favorite
PUT Api/OLR/{unitId}/{fyopWeekId}/Note	Add or update a note for a specific week
PUT Api/OLR/{unitId}/{fyopWeekId}/Day/{dayId}/Shift/{shiftId}/Note	Add or update a note for a specific shift on a specific day.
POST Api/OLR/{unitId}/{fyopWeekId}/Certify	Certify the staffing for a specific week
POST Api/OLR/{unitId}/{fyopWeekId}/Copy/Favorite	Copy a favorite staffing week into the specified week
POST Api/OLR/{unitId}/{fyopWeekId}/Copy	Copy staffing from one week to another (regular copy)
DELETE Api/OLR/{unitId}/{fyopWeekId}/Favorite	Remove favorite from a staffing week
POST Api/OLR/{unitId}/{fyopWeekId}/Reset	Reset staffing for a specific week back to base staffing

Schoox

API	Description
GET api/Schoox	No documentation available.
POST api/Schoox	No documentation available.

Olo

API	Description
GET api/Olo	No documentation available.
POST api/Olo	No documentation available.