Aramark Labor Daily Forecast API

openapi: 3.2.0
info:
  description: 'This API will return Daily Labor Metrics data from Aramark''s labor management systems.


    The base endpoint URL for this API in production is:

    `https://marko.aramark.net/v1/labor/daily`.


    For testing the API with the "Try" tool on this page or in your app, use

    either our testing server "qa-marko" or our development server "dev-marko".'
  version: 1.0.0-oas3
  title: Labor Daily Forecast API
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
security:
- apiKey: []
tags:
- name: Labor Daily Forecast
paths:
  /forecast/{org_value}:
    get:
      summary: Labor Daily Forecast
      description: 'Returns Labor Daily Forecast


        !This endpoint is in production'
      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
components:
  parameters:
    startDateParam:
      in: query
      name: start_date
      description: Calendar date for daily transactions. "mm/dd/yyyy"
      required: true
      schema:
        type: string
    orgValueParam:
      in: path
      name: org_value
      description: Aramark Business Organization code to filter data set
      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
    bypassCacheParam:
      in: header
      name: bypass-cache
      description: This HTTP Header variable will bypass cache.
      schema:
        type: string
        enum:
        - 'true'
        - 'false'
        default: 'false'
    sortParam:
      in: query
      name: sort
      type: string
      description: Value to determine direction of date range sorting
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: DESC
    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_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
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify permissions.