openapi: 3.2.0
info:
  title: Aramark User API
  version: 1.0.0-oas3
  description: 'Operations tagged User across 2 of this provider''s published API definitions: aramark-marko-users-openapi.json, aramark-service-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dev-marko.aramark.net/v1/marko
  description: Development server
- url: https://qa-marko.aramark.net/v1/service
  description: Testing server
- url: https://dev-marko.aramark.net/v1/service
  description: Development server
tags:
- name: User
  description: Gets, Updates or Creates Marko User information
paths:
  /users:
    get:
      summary: Get all Users
      description: 'Returns All Marko Users


        !This endpoint is in development'
      operationId: getAllMarkoUsers
      tags:
      - User
      parameters:
      - $ref: '#/components/parameters/userIdParamFalse'
      - $ref: '#/components/parameters/bypassCacheParam'
      - $ref: '#/components/parameters/smokeParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success', 'Error' or 'Not Found'
                    default: Success
                    example: Success
                  count:
                    type: string
                    description: Number of records returned
                    default: '0'
                    example: '1'
                  user_details:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
        '404':
          description: Not Found
        '405':
          description: Method Not Allowed
    post:
      summary: Create User
      description: 'Create new Marko user.


        !This endpoint is in development'
      tags:
      - User
      operationId: postUser
      parameters:
      - $ref: '#/components/parameters/userIdParamTrue'
      - $ref: '#/components/parameters/smokeParam'
      responses:
        '200':
          description: Details of the User
          content:
            '*/*':
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success', 'Error' or 'Not Found'
                    default: Success
                    example: Success
                  count:
                    type: string
                    description: Number of records returned
                    default: '0'
                    example: '1'
                  user_details:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
        '404':
          description: Not Found
        '405':
          description: Method Not Allowed
    servers:
    - url: https://dev-marko.aramark.net/v1/marko
      description: Development server
  /user/sites:
    get:
      summary: Get Sites for a User
      description: Returns a collection of Sites for a User
      operationId: getUserSites
      tags:
      - User
      parameters:
      - $ref: '#/components/parameters/emailParam'
      - $ref: '#/components/parameters/sourceSystemParam'
      - $ref: '#/components/parameters/bypassCacheParam_2'
      - $ref: '#/components/parameters/smokeParam_2'
      responses:
        '200':
          description: Lists User Sites
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success', 'Error' or 'Not Found'
                  count:
                    type: string
                    description: Number of records
                  user_sites:
                    type: array
                    items:
                      $ref: '#/components/schemas/user_sites'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
    servers:
    - url: https://qa-marko.aramark.net/v1/service
      description: Testing server
    - url: https://dev-marko.aramark.net/v1/service
      description: Development server
  /user/locations/disabled:
    get:
      summary: Disabled User Service Locations
      description: Returns a collection of Disabled Service Locations for a User
      operationId: getDisabledUserServiceLocations
      tags:
      - User
      parameters:
      - $ref: '#/components/parameters/emailParam'
      - $ref: '#/components/parameters/sourceSystemParam'
      - $ref: '#/components/parameters/bypassCacheParam_2'
      - $ref: '#/components/parameters/smokeParam_2'
      responses:
        '200':
          description: Lists Disabled Service Locations for a User
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success', 'Error' or 'Not Found'
                  count:
                    type: string
                    description: Number of records
                  user_disabled_locations:
                    type: array
                    items:
                      $ref: '#/components/schemas/user_disabled_locations'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
    put:
      summary: Update User Disabled Locations
      description: Allows updates to Disabled User Locations
      operationId: putUserDisabledLocations
      tags:
      - User
      parameters:
      - $ref: '#/components/parameters/sourceSystemParam'
      requestBody:
        description: Details for the Waste that is being updated
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putDisabledUserLocationsBody'
      responses:
        '200':
          description: Status of the Update Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success', 'Error' or 'Not Found'
                  message:
                    type: string
                    description: Status Message for the Update Request
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
    servers:
    - url: https://qa-marko.aramark.net/v1/service
      description: Testing server
    - url: https://dev-marko.aramark.net/v1/service
      description: Development server
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 to the Integration environment.  Only applicable in QA Server
      schema:
        type: string
        enum:
        - 'true'
        - 'false'
        default: 'false'
    userIdParamFalse:
      name: user_id
      in: query
      description: Unique identifier of a Marko User.  Used for returning specific user, otherwise returns all users
      required: false
      schema:
        type: string
    userIdParamTrue:
      name: user_id
      in: query
      description: Unique identifier of a Marko User.  Used for returning specific user, otherwise returns all users
      required: true
      schema:
        type: string
    bypassCacheParam_2:
      in: header
      name: bypass-cache
      description: This HTTP Header variable will bypass cache
      schema:
        type: string
        enum:
        - 'true'
        - 'false'
    smokeParam_2:
      in: header
      name: smoke
      description: 'When set to ''true'' this HTTP Header variable will route to the Integration environment.  Only applicable in QA Server.

        '
      schema:
        type: string
        enum:
        - 'true'
        - 'false'
    sourceSystemParam:
      name: source_system
      in: query
      description: source system
      required: false
      schema:
        type: string
        enum:
        - PRMA
        default: PRMA
    emailParam:
      name: sp_guid
      in: query
      description: sp GUID of the User
      required: true
      schema:
        type: string
  schemas:
    User:
      type: object
      properties:
        user_id:
          type: string
          description: Unique identifier of a user
        first_name:
          type: string
          description: user first name
        last_name:
          type: string
          description: user last name
        name:
          type: string
          description: user name
        email:
          type: string
          description: email address of a user
        cell_number:
          type: string
          description: cell phone number of a user
        valid:
          type: string
          description: boolean determining validity of device
        create_date:
          type: string
          description: date that profile was created
        update_date:
          type: string
          description: date that profile was last updated
    user_sites:
      type: object
      properties:
        site_id:
          type: number
          description: ID for the Site
        site_name:
          type: string
          description: Name of the Site
    putDisabledUserLocationsBody:
      type: object
      properties:
        sp_guid:
          type: string
          description: sp GUID of the user
        location_id:
          type: number
          description: ID of the Location
        enalbed:
          type: string
          description: Status to determine if location is disabled - true or false
    user_disabled_locations:
      type: object
      properties:
        location_id:
          type: number
          description: ID of the Location
        is_disabled:
          type: string
          description: Status to determine if location is disabled - true or false
  securitySchemes:
    apikey:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify security
x-refined-from:
- aramark-marko-users-openapi.json
- aramark-service-openapi.json