Aramark Operational Day API

openapi: 3.2.0
info:
  description: 'Given a day or date range this API has methods to list:

    * fiscal day attributes

    * operational day attributes


    You can return return the _calendar dates_ for given fiscal day attributes:


    * fiscal year

    * fiscal month

    * week of a fiscal month

    * day of the week in a fiscal month


    **The Aramark Fiscal Year**


    * The first month of the fiscal year is October

    * Fiscal months rarely begin on the first day of their correspoinding calendar month.'
  version: 1.0.0-oas3
  title: Calendar Operational Day API
servers:
- url: https://qa-marko.aramark.net/v1
  description: Testing server
- url: https://dev-marko.aramark.net/v1
  description: Development server
security:
- apiKey: []
tags:
- name: Operational Day
paths:
  /operational/day:
    get:
      operationId: getOperationalDay
      summary: Operational day attributes
      description: 'Return operational day information for given calendar dates.


        !This endpoint is in production


        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".'
      parameters:
      - $ref: '#/components/parameters/startDateParam'
      - $ref: '#/components/parameters/endDateParam'
      - $ref: '#/components/parameters/fieldsParam'
      - $ref: '#/components/parameters/bypassCacheParam'
      - $ref: '#/components/parameters/smokeParam'
      tags:
      - Operational Day
      responses:
        '200':
          description: List of fiscal day information
          content:
            '*/*':
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success' or 'Error'
                    default: Success
                  count:
                    type: string
                    description: Number of records returned in request
                  operational_day:
                    type: array
                    items:
                      $ref: '#/components/schemas/operational_day'
        '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: false
      schema:
        type: string
    fieldsParam:
      in: query
      name: fields
      description: Comma separated list of output parameters used to limit the output model.
      required: false
      schema:
        type: string
    endDateParam:
      in: query
      name: end_date
      description: Calendar date 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'
    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'
  schemas:
    operational_day:
      type: object
      properties:
        calendar_date:
          type: string
          description: Timestamp of calendar date to corresponding operational day
        operational_afs_period:
          type: string
          description: shorthand description of operational month and year
        operational_day_of_year:
          type: number
          description: numeric value of operational day of year
        operational_day_of_month:
          type: number
          description: numeric value of operational day of month
        operational_day_of_quarter:
          type: number
          description: numeric value of operational day of quarter
        operational_day_of_week:
          type: number
          description: numeric value of operational day of week
        operational_max_week_in_month:
          type: number
          description: maximum number of weeks in operational month
        operational_month_abbr:
          type: string
          description: three letter abbreviation for operational month
        operational_month_id:
          type: number
          description: unique id for the operational month
        operational_month_name:
          type: string
          description: name of the operational month
        operational_month_of_year:
          type: number
          description: numeric value of operational month of year
        operational_month_of_quarter:
          type: number
          description: numeric value of operational month of quarter
        operational_period:
          type: string
          description: name of the operational period
        operational_period_week:
          type: string
          description: operational period and week
        operational_quarter_id:
          type: number
          description: unique id for the operational quarter
        operational_quarter_name:
          type: string
          description: name of the operational quarter
        operational_quarter_of_year:
          type: number
          description: numeric value of the operational quarter of year
        operational_week_day:
          type: string
          description: operational period, week and day
        operational_week_id:
          type: number
          description: unique id of operational week
        operational_week_of_month:
          type: number
          description: numeric value of the operational week of month
        operational_week_of_quarter:
          type: number
          description: numeric value of the operational week of quarter
        operational_week_of_year:
          type: number
          description: numeric value of the operational week of year
        operational_year_id:
          type: number
          description: unique id of the operational year
        operational_year_month:
          type: number
          description: operational year and month
        operational_year_name:
          type: string
          description: name of the operational year
        operational_year_number:
          type: string
          description: numeric value of the operational year
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify permissions.