openapi: 3.2.0
info:
  description: 'This API will return a sites collection from either CSP or MDG environments. Sites is a container to group Aramark Profit Centers.


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


    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: Sites 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: Sites
  description: This API will return a list of Aramark Sites
paths:
  /sites:
    get:
      tags:
      - Sites
      summary: Return a collection of sites
      description: 'This API will return a list of Aramark sites


        !This endpoint is in production'
      operationId: getSites
      parameters:
      - $ref: '#/components/parameters/searchParam'
      - $ref: '#/components/parameters/siteIdParam'
      - $ref: '#/components/parameters/formatParam'
      - $ref: '#/components/parameters/pageParam'
      - $ref: '#/components/parameters/sizeParam'
      - $ref: '#/components/parameters/bypassCacheParam'
      - $ref: '#/components/parameters/smokeParam'
      responses:
        '200':
          description: List all Sites.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success' or 'Error'
                    default: Success
                  count:
                    type: string
                    description: Number of records returned in request
                  page:
                    type: string
                    description: Page number of result set
                    default: '1'
                  size:
                    type: string
                    description: Number of records returned with the result set
                    default: '50'
                  sub_locations:
                    type: array
                    items:
                      $ref: '#/components/schemas/sites'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
components:
  parameters:
    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'
    siteIdParam:
      name: site_id
      in: query
      description: Unique ID of Site to return Sites.
      required: false
      schema:
        type: string
    sizeParam:
      name: size
      in: query
      description: Number of records to be returned in each page of result set
      schema:
        type: string
        default: 50
    formatParam:
      name: format
      in: query
      description: File format to return data
      required: false
      schema:
        type: string
        enum:
        - JSON
        - XLS
        - CSV
        default: JSON
    pageParam:
      in: query
      name: page
      escription: Page number of result set
      required: false
      schema:
        type: number
        default: 1
    searchParam:
      name: search
      in: query
      description: Search string to find Sites. Searches against Site Name.
      required: false
      schema:
        type: string
  schemas:
    sites:
      type: object
      properties:
        site_id:
          type: integer
          description: Site ID coming from source system CSP Will be deprecated once MDG application is fully implemented
        site_no:
          type: string
          description: Site No coming from source system CSP
        site:
          type: string
          description: Global Unique identifier coming from MDG system
        site_name:
          type: string
          description: Business name of site
        site_enabled:
          type: string
          description: Indicator of whether site is enabled 'Y/N'
        create_date:
          type: string
          description: Calendar date when Site was created
        last_update_date:
          type: string
          description: Calendar date when Site was last updated
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify permissions.