openapi: 3.0.0
info:
  description: | 

    This API will return Employee Scheduled Shift information

    The base endpoint URL for this API in production is: `https://marko.aramark.net/v1/labor/schedule`.

    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 Schedule
tags:
  - name: Schedule
    description: Get Employee Scheduled Shifts
paths:
  /employee/shifts:
    # proxy name: Labor-Scheduled-Shifts
    # proxy display name: Labor-Scheduled-Employee-Shift-API
    get:
      summary: Scheduled shift information for employee
      description: |
        
        Returns a collection of scheduled shift information for an employee

        ![This endpoint is in production](/themes/portal/images/statuspngs/statusprod.png)
      operationId: getScheduledShifts
      tags:
        - Schedule
      parameters:
        - $ref: '#/components/parameters/employeeIdParam'
        - $ref: '#/components/parameters/bypassCacheParam'
      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
                  scheduled_shifts:
                    type: array
                    items:
                      $ref: '#/components/schemas/scheduled_shifts'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
  /employee/timecard:
    # proxy name: Labor-Time-Card-API
    # proxy display name: Labor-Employee-Time-Card-API
    get:
      summary: Timecard information for employee
      description: |

        Returns a collection of timecard information for an employee

        ![This endpoint is in production](/themes/portal/images/statuspngs/statusprod.png)
      operationId: getTimecard
      tags:
        - Schedule
      parameters:
        - $ref: '#/components/parameters/employeeIdParam'
        - $ref: '#/components/parameters/payPeriodParam'
        - $ref: '#/components/parameters/bypassCacheParam'
      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
                  scheduled_shifts:
                    type: array
                    items:
                      $ref: '#/components/schemas/scheduled_shifts'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
servers:
  - url: https://qa-marko.aramark.net/v1/labor/schedule
    description: Testing server
  - url: https://dev-marko.aramark.net/v1/labor/schedule
    description: Development server
components:
  parameters:
    employeeIdParam:
      in: query
      name: employee_id
      description: Unique identifier of the employee
      required: true
      schema:
        type: string
    payPeriodParam:
      in: query
      name: pay_period
      description: Pay period code for the timecard. P-Previous; C-Current
      required: true
      schema:
        type: string
        enum:
          - P
          - C
    bypassCacheParam:
      name: bypass-cache
      in: header
      description: This HTTP Header variable will bypass cache.
      schema:
        type: string
        enum:
          - 'true'
          - 'false'
        default: false
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify permissions.
  schemas:
    scheduled_shifts:
      type: object
      properties:
        shift_assignment_id:
          type: string
          description: Unique ID for the assigned shift
        employee_id:
          type: string
          description: Unique ID for the employee
        employee_name:
          type: string
          description: First and Last name of the employee
        manager_id:
          type: string
          description: Unique ID for the manager of the employee
        manager_name:
          type: string
          description: First and Last name of the manager of the employee
        manager_email:
          type: string
          description: Email address of the manager
        shift_start_time:
          type: string
          description: Start time of the shift in Local Time Zone
        shift_end_time:
          type: string
          description: End time of the shift in Local Time Zone
        shift_duration:
          type: string
          description: Length of the shift in hours
        shift_segment:
          type: array
          items:
            $ref: '#/components/schemas/shift_segments'
    shift_segments:
      type: object
      properties:
        segment_id:
          type: string
          description: Unique ID for the segment of the shift
        segment_number:
          type: string
          description: Ordinal number of the segment in the shift
        segment_type:
          type: string
          description: Work type for the segment
        start_date_time:
          type: string
          description: Start date and time of the shift segment
        end_date_time:
          type: string
          description: End date and time of the shift segment
        org_path:
          type: string
          description: Full Aramark Organization path of the shift segment location
        site_name:
          type: string
          description: Name of Aramark Site for the shift segment
        profit_center:
          type: string
          description: Aramark Profit Center code for the shift segment
        profit_center_name:
          type: string
          description: Name of Aramark Profit Center for the shift segment
        location_name:
          type: string
          description: Name of Aramark Location for the shift segment
        department_name:
          type: string
          description: Name of Aramark Department for the shift segment
        job_name:
          type: string
          description: Name of Aramark Job for the shift segment
    timecard:
      type: object
      properties:
        employee_id:
          type: string
          description: Unique ID for the employee
        employee_name:
          type: string
          description: First and Last name of the employee
        date:
          type: string
          description: Day of the punch in
        in_punch:
          type: string
          description: Time of the Punch In by the employee
        out_punch:
          type: string
          description: Time of the Punch Out by the employee
        in_punch_exception:
          type: string
          description: Status description of the Punch In by the employee
        out_punch_exception:
          type: string
          description: Status description of the Punch Out by the employee