openapi: 3.2.0
info:
  description: 'This API will return organization brand information.


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


    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: Organization Brands Brand API
servers:
- url: https://qa-marko.aramark.net/v1/organization
  description: Testing server
- url: https://dev-marko.aramark.net/v1/organization
  description: Development server
tags:
- name: Brand
  description: This API will return a list of Organizational Brand information
paths:
  /brands:
    get:
      summary: Organization brand information
      description: 'Return a collection of organization brand information.


        !This endpoint is in QA'
      operationId: getOrganizationBrand
      parameters:
      - $ref: '#/components/parameters/updateDateParam'
      - $ref: '#/components/parameters/enabledParam'
      - $ref: '#/components/parameters/pageParam'
      - $ref: '#/components/parameters/sizeParam'
      - $ref: '#/components/parameters/bypassCacheParam'
      - $ref: '#/components/parameters/smokeParam'
      tags:
      - Brand
      responses:
        '200':
          description: List of brand 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
                  brands:
                    type: array
                    items:
                      $ref: '#/components/schemas/brands'
        '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
    enabledParam:
      in: query
      name: enabled
      description: Flag to determine if the brand is active or not
      required: false
      schema:
        type: string
        enum:
        - Y
        - N
    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
    updateDateParam:
      in: query
      name: update_date
      description: Calendar date for last update. "mm/dd/yyyy"
      required: false
      schema:
        type: string
  schemas:
    brands:
      type: object
      properties:
        brand_id:
          type: number
          description: Unique ID of the Brand
        brand_name:
          type: string
          description: Name of the Brand
        concept_cd:
          type: string
          description: Unique ID of the Concept
        concept_cd_desc:
          type: string
          description: Description of the Concept CD
        agreement_type_id:
          type: number
          description: Unique ID of the Agreement Type
        agreement_type_desc:
          type: string
          description: Description of the Agreement Type
        brand_type_id:
          type: number
          description: Unique ID of the Brand Type
        brand_type_desc:
          type: string
          description: Description of the Brand Type
        brand_category_id:
          type: number
          description: Unique ID of the Brand Category
        brand_category_desc:
          type: string
          description: Description of the Brand Category
        enabled:
          type: string
          description: Flag to determine if a Brand is active or not 'Y' or 'N'
        last_update_date:
          type: string
          description: Date on which the brand was last updated
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apiKey
      description: This HTTP Header variable will verify permissions.