openapi: 3.2.0
info:
  description: 'This API will return Employee information


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


    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 Employee Details API
servers:
- url: https://qa-marko.aramark.net/v1/labor/employee
  description: Testing server
- url: https://dev-marko.aramark.net/v1/labor/employee
  description: Development server
security:
- apiKey: []
tags:
- name: Details
  description: Get Detail information for an Employee
paths:
  /details/{org_value}:
    get:
      summary: Employee detail information
      description: 'Returns a collection of Employee detail information


        !This endpoint is in QA'
      operationId: getEmployeeDetails
      tags:
      - Details
      produces:
      - application/json
      parameters:
      - $ref: '#/components/parameters/orgValueParam'
      - $ref: '#/components/parameters/employeeIdParamNotRequired'
      - $ref: '#/components/parameters/employeeEmailParam'
      - $ref: '#/components/parameters/pageParam'
      - $ref: '#/components/parameters/sizeParam'
      - $ref: '#/components/parameters/bypassCacheParam'
      - $ref: '#/components/parameters/smokeParam'
      responses:
        '200':
          description: Provides detail information of an Employee
          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_details:
                    type: array
                    items:
                      $ref: '#/components/schemas/employee_details'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
components:
  parameters:
    employeeEmailParam:
      in: query
      name: email
      schema:
        type: string
      description: Email address of the employee
      required: false
    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
        enum:
        - 'true'
        - 'false'
    employeeIdParamNotRequired:
      in: query
      name: employee_id
      description: Unique identifier of the employee
      required: false
      schema:
        type: string
    orgValueParam:
      in: path
      name: org_value
      description: provide business organization code in URL to filter data set
      required: true
      schema:
        type: string
    sizeParam:
      in: query
      name: size
      description: Number of rows in each page to return.
      required: false
      schema:
        type: string
        default: 50
    pageParam:
      in: query
      name: page
      description: Page number of result set
      required: false
      schema:
        type: number
        default: 1
  schemas:
    employee_details:
      type: object
      properties:
        employee_id:
          type: string
          description: Unique ID for the employee
        first_name:
          type: string
          description: First name of the employee
        last_name:
          type: string
          description: Last name of the employee
        email:
          type: string
          description: Email address of the employee
        phone_number:
          type: string
          description: Phone Number of the employee
        employee_type:
          type: string
          description: Employment Type of the employee
        employee_status:
          type: string
          description: Employment Status of the employee
        upn:
          type: string
          description: User Principal Name of the employee
        guid:
          type: string
          description: Global Unique ID of the employee
        payroll_employee_id:
          type: string
          description: Unique ID for the employee in payroll systems
        line_of_business_name:
          type: string
          description: Name of the Line of Business
        line_of_business:
          type: string
          description: Line of Business value
        region_name:
          type: string
          description: Name of the Region
        region:
          type: string
          description: Region value
        district_name:
          type: string
          description: Name of the District
        district:
          type: string
          description: District value
        profit_center_name:
          type: string
          description: Name of the Profit Center
        profit_center:
          type: string
          description: Profit Center value
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify permissions.