{"openapi":"3.0.0","info":{"description":"\nThis API will return Daily Labor Metrics data from Aramark's labor management systems.\n\nThe base endpoint URL for this API in production is:\n`https://marko.aramark.net/v1/labor/daily`.\n\nFor testing the API with the \"Try\" tool on this page or in your app, use\neither our testing server \"qa-marko\" or our development server \"dev-marko\".\n","version":"1.0.0-oas3","title":"Labor Daily"},"tags":[{"name":"Labor Daily Summary"},{"name":"Employee Daily Summary"},{"name":"Employee Daily Schedule"},{"name":"Labor Daily Forecast"}],"security":[{"apiKey":[]}],"paths":{"/summary/{org_value}":{"get":{"summary":"Labor daily summary","description":"\nReturns ALL Labor Daily Summary\n\n![This endpoint is in production](/themes/portal/images/statuspngs/statusprod.png)\n","operationId":"getDailyLaborSummary","tags":["Labor Daily Summary"],"parameters":[{"$ref":"#/components/parameters/orgValueParam"},{"$ref":"#/components/parameters/startDateParam"},{"$ref":"#/components/parameters/endDateParam"},{"$ref":"#/components/parameters/bypassCacheParam"},{"$ref":"#/components/parameters/smokeParam"}],"responses":{"200":{"description":"Provides the labor summary data","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success', 'Error' or 'Not Found'","default":"Success"},"count":{"type":"integer","description":"Number of records being returned"},"labor_summary":{"type":"array","items":{"$ref":"#/components/schemas/labor_summary"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}},"/employee/summary/{org_value}":{"get":{"summary":"Employee daily summary","description":"Returns Employee Daily Summary\n\n![This endpoint is in production](/themes/portal/images/statuspngs/statusprod.png)\n","operationId":"getDailyEmployeeSummaryByOrgValue","tags":["Employee Daily Summary"],"parameters":[{"$ref":"#/components/parameters/orgValueParam"},{"$ref":"#/components/parameters/startDateParam"},{"$ref":"#/components/parameters/endDateParam"},{"$ref":"#/components/parameters/bypassCacheParam"},{"$ref":"#/components/parameters/smokeParam"}],"responses":{"200":{"description":"Provides employee summary data","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success', 'Error' or 'Not Found'","default":"Success"},"count":{"type":"integer","description":"Number of records being returned"},"employee_summary":{"type":"array","items":{"$ref":"#/components/schemas/employee_summary"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}},"/employee/schedule/{org_value}":{"get":{"summary":"Employee daily schedule","description":"Returns Employee Daily Schedule\n\n![This endpoint is in development](/themes/portal/images/statuspngs/statusdev.png)\n","operationId":"getDailyEmployeeScheduleByOrgValue","tags":["Employee Daily Schedule"],"parameters":[{"$ref":"#/components/parameters/orgValueParam"},{"$ref":"#/components/parameters/startDateParam"},{"$ref":"#/components/parameters/endDateParam"},{"$ref":"#/components/parameters/employeeIdParam"},{"$ref":"#/components/parameters/bypassCacheParam"},{"$ref":"#/components/parameters/smokeParam"}],"responses":{"200":{"description":"Provides daily employee schedule data","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success', 'Error' or 'Not Found'","default":"Success"},"count":{"type":"integer","description":"Number of records being returned"},"employee_schedule":{"type":"array","items":{"$ref":"#/components/schemas/employee_schedule"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}},"/forecast/{org_value}":{"get":{"summary":"Labor Daily Forecast","description":"\nReturns Labor Daily Forecast\n\n![This endpoint is in production](/themes/portal/images/statuspngs/statusprod.png)\n","operationId":"getDailyLaborForecast","tags":["Labor Daily Forecast"],"parameters":[{"$ref":"#/components/parameters/orgValueParam"},{"$ref":"#/components/parameters/startDateParam"},{"$ref":"#/components/parameters/endDateParam"},{"$ref":"#/components/parameters/sortParam"},{"$ref":"#/components/parameters/bypassCacheParam"},{"$ref":"#/components/parameters/smokeParam"}],"responses":{"200":{"description":"Provides the labor forecast data","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"ENUM 'Success', 'Error' or 'Not Found'","default":"Success"},"count":{"type":"integer","description":"Number of records being returned"},"labor_forecast":{"type":"array","items":{"$ref":"#/components/schemas/labor_forecast"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}}},"servers":[{"url":"https://qa-marko.aramark.net/v1/labor/daily","description":"Testing server"},{"url":"https://dev-marko.aramark.net/v1/labor/daily","description":"Development server"}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"apikey","description":"This HTTP Header variable will verify permissions."}},"parameters":{"orgValueParam":{"in":"path","name":"org_value","description":"Aramark Business Organization code to filter data set","required":true,"schema":{"type":"string"}},"startDateParam":{"in":"query","name":"start_date","description":"Calendar date for daily transactions. \"mm/dd/yyyy\"","required":true,"schema":{"type":"string"}},"endDateParam":{"in":"query","name":"end_date","description":"Calendar end date for daily transactions. Will use start_date if not provided. \"mm/dd/yyyy\"","required":false,"schema":{"type":"string"}},"employeeIdParam":{"in":"query","name":"employee_id","description":"Unique identifier for an individual employee","required":false,"schema":{"type":"string"}},"sortParam":{"in":"query","name":"sort","type":"string","description":"Value to determine direction of date range sorting","schema":{"type":"string","enum":["ASC","DESC"],"default":"DESC"}},"bypassCacheParam":{"in":"header","name":"bypass-cache","description":"This HTTP Header variable will bypass cache.","schema":{"type":"string","enum":["true","false"],"default":"false"}},"smokeParam":{"in":"header","name":"smoke","description":"When set to 'true' this HTTP header variable will route the API call to the Integration testing environment. Only applicable in QA.","schema":{"type":"string","default":"false"}}},"schemas":{"labor_summary":{"type":"object","properties":{"calendar_date":{"type":"string","description":"Date or transactional rollup"},"fiscal_period":{"type":"string","description":"Fiscal Month of data"},"fiscal_week_no":{"type":"string","description":"Fiscal Week of Month"},"fiscal_day":{"type":"string","description":"Fiscal Day of Week"},"org_value":{"type":"string","description":"Aramark Organization code for rollup"},"org_name":{"type":"string","description":"Name or Aramark Organization rollup"},"scheduled_ot_hours":{"type":"number","description":"Scheduled OT Hours"},"scheduled_ot_wages":{"type":"number","description":"Scheduled OT Wages"},"scheduled_prod_hours":{"type":"number","description":"Scheduled Productive Hours"},"scheduled_prod_wages":{"type":"number","description":"Scheduled Productive Wages"},"actual_ot_hours":{"type":"number","description":"Actual OT Hours"},"actual_ot_wages":{"type":"number","description":"Actual OT Wages"},"actual_prod_hours":{"type":"number","description":"Actual Productive Hours"},"actual_prod_wages":{"type":"number","description":"Actual Productive Wages"},"actual_non_prod_hours":{"type":"number","description":"Actual Non Productive Hours"},"actual_non_prod_wages":{"type":"number","description":"Actual Non Productive Wages"},"very_early_hours":{"type":"number","description":"Very Early Hours"},"very_early_wages":{"type":"number","description":"Very Early Wages"},"late_hours":{"type":"number","description":"Late Hours"},"late_wages":{"type":"number","description":"Late Wages"},"very_late_hours":{"type":"number","description":"Very Late Hours"},"very_late_wages":{"type":"number","description":"Very Late Wages"},"short_lunch_hours":{"type":"number","description":"Short Lunch Hours"},"short_lunch_wages":{"type":"number","description":"Short Lunch Wages"},"unscheduled_ot_hours":{"type":"number","description":"Unscheduled OT Hours"},"unscheduled_ot_wages":{"type":"number","description":"Unscheduled OT Wages"},"unscheduled_prod_hours":{"type":"number","description":"Unscheduled Productive Hours"},"unscheduled_prod_wages":{"type":"number","description":"Unscheduled Productive Wages"},"unscheduled_non_prod_hours":{"type":"number","description":"Unscheduled Non Productive Hours"},"unscheduled_non_prod_wages":{"type":"number","description":"Unscheduled Non Productive Hours"},"add_edits":{"type":"number","description":"Number of Add Edits"},"existing_edits":{"type":"number","description":"Number of Existing Edits"},"punch_count":{"type":"number","description":"Number of Clock Punches"}}},"employee_summary":{"type":"object","properties":{"source_site_code":{"type":"string","description":"Code referencing the Source Site"},"source_site_name":{"type":"string","description":"Name of the Site"},"source_pc_code":{"type":"string","description":"PC code of Source"},"source_pc_name":{"type":"string","description":"Name of PC"},"org_value":{"type":"string","description":"Aramark Organization code for rollup"},"source_location_code":{"type":"string","description":"Code for source location"},"source_location_name":{"type":"string","description":"Name of source location"},"source_department_code":{"type":"string","description":"Code for source department"},"source_department_name":{"type":"string","description":"Name of source department"},"source_job_code":{"type":"string","description":"Code for job"},"source_job_name":{"type":"string","description":"Name of job"},"source_employee_id":{"type":"string","description":"ID of employee"},"first_name":{"type":"string","description":"First name of employee"},"last_name":{"type":"string","description":"Last name of employee"},"employment_status":{"type":"string","description":"status of employment"},"full_time_indicator":{"type":"string","description":"indicator of full time status"},"employee_status":{"type":"string","description":"status of employee"},"seasonal_flag":{"type":"string","description":"indicator of seasonal employee"},"union_flag":{"type":"string","description":"indicator of union status of employee"},"agency_flag":{"type":"string","description":"indicator of agency status of employee"},"fiscal_day_id":{"type":"number","description":"ID of fiscal day of year"},"fiscal_month_id":{"type":"number","description":"ID of fiscal month of year"},"calendar_date":{"type":"string","description":"date of employee data"},"non_aramark_employee_flag":{"type":"string","description":"indicator of aramark employement status"},"actual_early_in_hours":{"type":"number","description":"Actual Early in Hours"},"actual_early_in_wages":{"type":"number","description":"Actual Early in Wages"},"actual_early_out_hours":{"type":"number","description":"Actual Early Out Hours"},"actual_early_out_wages":{"type":"number","description":"Actual Early Out Wages"},"actual_late_out_hours":{"type":"number","description":"Actual Late Out Hours"},"actual_late_out_wages":{"type":"number","description":"Actual Late Our Wages"},"actual_non_prod_hours":{"type":"number","description":"Actual Non Prod Hours"},"actual_non_prod_wages":{"type":"number","description":"Actual Non Prod Wages"},"actual_overtime_hours":{"type":"number","description":"Actual Non Overtime Hours"},"actual_overtime_wages":{"type":"number","description":"Actual Overtime Wages"},"actual_prod_hours":{"type":"number","description":"Actual Prod Hours"},"actual_prod_Wages":{"type":"number","description":"Actual Prod Wages"},"actual_short_lunch_hours":{"type":"number","description":"Actual Short Lunch Hours"},"actual_short_lunch_wages":{"type":"number","description":"Actual Short Lunch Wages"},"actual_very_early_in_hours":{"type":"number","description":"Actual Very Early In Hours"},"actual_very_early_in_wages":{"type":"number","description":"Actual Very Early In Wages"},"actual_very_late_out_hours":{"type":"number","description":"Actual Very Late Out Hours"},"actual_very_late_out_wages":{"type":"number","description":"Actual Very Late Out Wages"},"sched_non_prod_hours":{"type":"number","description":"Scheduled Non Prod Hours"},"sched_non_prod_wages":{"type":"number","description":"Scheduled Non Prod Wages"},"sched_overtime_hours":{"type":"number","description":"Scheduled Overtime Hours"},"sched_overtime_wages":{"type":"number","description":"Scheduled Overtime Wages"},"sched_prod_hours":{"type":"number","description":"Scheduled Prod Hours"},"sched_prod_wages":{"type":"number","description":"Scheduled Prod Wages"},"unsched_non_prod_hours":{"type":"number","description":"Unscheduled Non Prod Hours"},"unsched_non_prod_wages":{"type":"number","description":"Unscheduled Non Prod Wages"},"unsched_overtime_hours":{"type":"number","description":"Unscheduled Overtime Hours"},"unsched_overtime_wages":{"type":"number","description":"Unscheduled Overtime Wages"},"unsched_prod_hours":{"type":"number","description":"Unscheduled Prod Hours"},"unsched_prod_wages":{"type":"number","description":"Unscheduled Prod Wages"}}},"employee_schedule":{"type":"object","properties":{"calendar_date":{"type":"string","description":"Date or transactional rollup"},"org_value":{"type":"string","description":"Aramark Organization code for rollup"},"source_site_id":{"type":"string","description":"unique ID of the source site"},"source_site_code":{"type":"string","description":"code of the source site"},"source_site_name":{"type":"string","description":"name of the source site"},"source_pc_id":{"type":"string","description":"unique ID of the source profit center"},"source_pc_code":{"type":"string","description":"code of the source profit center"},"source_pc_name":{"type":"string","description":"name of the profit center"},"source_location_id":{"type":"string","description":"unique ID of the source location"},"source_location_code":{"type":"string","description":"code of the source location"},"source_location_name":{"type":"string","description":"name of the source location"},"source_department_id":{"type":"string","description":"unique ID of the source department"},"source_department_code":{"type":"string","description":"code of the source department"},"source_department_name":{"type":"string","description":"name of the source department"},"source_job_id":{"type":"string","description":"unique ID of the source job"},"source_job_code":{"type":"string","description":"code of the source job"},"source_job_name":{"type":"string","description":"name of the source job"},"first_name":{"type":"string","description":"first name of the employee"},"last_name":{"type":"string","description":"last name of the employee"},"employment_status":{"type":"string","description":"active status of the employee"},"full_time_indicator":{"type":"string","description":"indicator of the employee's full time status"},"employee_status":{"type":"string","description":"status of the employee"},"seasonal_flag":{"type":"string","description":"indicator of whether or not the employee is seasonal"},"union_flag":{"type":"string","description":"T or F indicator of whether or not the employee is a union member"},"agency_flag":{"type":"string","description":"T or F indicator of whether or not the employee is an agency worker"},"non_aramark_employee_flag":{"type":"string","description":"T or F indicator of whether or not the employee works for Aramark"},"actual_prod_hours":{"type":"number","description":"Actual Productive Hours"},"actual_non_prod_hours":{"type":"number","description":"Actual Non Productive Hours"},"actual_overtime_hours":{"type":"number","description":"Actual Overtime Hours"},"sched_prod_hours":{"type":"number","description":"Scheduled Productive Hours"},"sched_non_prod_hours":{"type":"number","description":"Scheduled Non Productive Hours"},"sched_overtime_hours":{"type":"number","description":"Scheduled Overtime Hours"}}},"labor_forecast":{"type":"object","properties":{"calendar_date":{"type":"string","description":"Date of returned data MM/dd/yyy Format"},"org_value":{"type":"string","description":"Aramark Organization code"},"actual_hours":{"type":"number","description":"Actual Hours"},"actual_revenue":{"type":"number","description":"Actual Revenue"},"actual_transactions":{"type":"number","description":"Actual Transactions.  Only applicable to Location"},"actual_wages":{"type":"number","description":"Actual Wages"},"allocated_hours":{"type":"number","description":"Allocated Hours"},"allocated_hours_template":{"type":"number","description":"Allocated hours Template. Only applicable to Location"},"allocated_wages":{"type":"number","description":"Allocated Wages"},"allocated_wages_template":{"type":"number","description":"Allocated Wages Templated. Only applicable to Location"},"allowable_hours":{"type":"number","description":"Allowable Hours"},"allowable_wages":{"type":"number","description":"Allowable Wages"},"custom_count":{"type":"number","description":"Custom Count"},"earned_hours":{"type":"number","description":"Earned Hours"},"earned_wages":{"type":"number","description":"Earned Wages"},"labor_cost_pct_adjusted":{"type":"number","description":"Labor Cost Percent Adjusted"},"labor_cost_pct_proj":{"type":"number","description":"Labor Cost Percent Projected"},"lst_day_completed_act":{"type":"number","description":"Labor Scheduling Tool Completed Actual Count"},"lst_day_completed_proj":{"type":"number","description":"Labor Scheduling Tool Completed Projected Count"},"lst_day_required_act":{"type":"number","description":"Labor Scheduling Tool Required Actual Count"},"lst_day_required_proj":{"type":"number","description":"Labor Scheduling Tool Required Projected Count"},"non_kronos_hours":{"type":"number","description":"Non Kronos Hours"},"non_kronos_wages":{"type":"number","description":"Non Kronos Wages"},"plan_hours":{"type":"number","description":"Plan Hours"},"plan_wages":{"type":"number","description":"Plan Wages"},"planned_count":{"type":"number","description":"Planned Count"},"projected_count":{"type":"number","description":"Projected Count"},"projected_revenue":{"type":"number","description":"Projected Revenue"},"projected_transactions":{"type":"number","description":"Projected Transactions. Only applicable to Location"},"scheduled_hours":{"type":"number","description":"Scheduled Hours"},"scheduled_wages":{"type":"number","description":"Scheduled Wages"},"taxes_and_benefits_rate":{"type":"number","description":"Rate of Benefits and Taxes"},"wage_percent":{"type":"number","description":"Percent of Wage. Only applicable to Location"}}}}}}