openapi: 3.2.0 info: title: Aramark Hierarchy API version: '1.0' description: 'Operations tagged Hierarchy across 2 of this provider''s published API definitions: aramark-organization-hierarchy-v2-openapi.json, aramark-profile-user-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: https://qa-marko.aramark.net/v2/organization description: Testing server - url: https://dev-marko.aramark.net/v2/organization description: Development server - url: https://qa-marko.aramark.net/v1/profile/user description: Testing server - url: https://dev-marko.aramark.net/v1/profile/user description: Development server security: - apiKey: [] tags: - name: Hierarchy paths: /hierarchy/flat/financial/{org_value}: get: operationId: getFinancialFlatHierarchyV2 tags: - Hierarchy summary: Returns Financial Hierarchy data with new and legacy Org Values in a flattened… description: '!This endpoint is in production' parameters: - $ref: '#/components/parameters/orgValueParam' - $ref: '#/components/parameters/hierarchyGroupParam' - $ref: '#/components/parameters/pageParam' - $ref: '#/components/parameters/sizeParam' - $ref: '#/components/parameters/bypassCacheParam' - $ref: '#/components/parameters/smokeParam' responses: '200': description: Collection of financial organization content: '*/*': schema: type: object properties: status: type: string description: ENUM 'Success' or 'Error' default: Success count: type: string description: Number of records returned page: type: number description: Page number of the response size: type: number description: Size of the response financial_organizations: type: array items: $ref: '#/components/schemas/financial_organizations' '404': description: Requested resource does not exist. '405': description: HTTP Verb / Operation not supported servers: - url: https://qa-marko.aramark.net/v2/organization description: Testing server - url: https://dev-marko.aramark.net/v2/organization description: Development server /my_hierarchy: get: summary: User Hierarchy description: 'Return a Hierarchical collection of organizations to which a user is mapped !This endpoint is in development' operationId: getMyHierarchy parameters: - $ref: '#/components/parameters/userIdNoReqParam' - $ref: '#/components/parameters/bypassCacheParam' - $ref: '#/components/parameters/smokeParam_2' tags: - Hierarchy responses: '200': description: Hierarchical organizations to which a user is mapped. 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 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' user_hierarchy: type: array items: $ref: '#/components/schemas/user_hierarchy' '404': description: Requested resource does not exist. '405': description: HTTP Verb / Operation not supported servers: - url: https://qa-marko.aramark.net/v1/profile/user description: Testing server - url: https://dev-marko.aramark.net/v1/profile/user 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 the API call to the Integration testing environment. Only applicable in QA. schema: type: string hierarchyGroupParam: in: query name: hierarchy_group required: true description: comma separated list of hierarchy levels. This is used to limit the return set to only include specified org levels. Accepted values - CMP, DIV, BSU, LOB, REG, DST, PC, LOC, SLOC schema: type: string orgValueParam: in: path name: org_value required: true description: provide business organization code in URL to filter data set schema: type: string sizeParam: in: query name: size description: Number of records to be returned in each page of result set schema: type: string default: 50 pageParam: in: query name: page description: Page number of result set schema: type: number default: 1 userIdNoReqParam: name: user_id in: query description: Email address of the user required: false schema: type: string smokeParam_2: 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: financial_organizations: type: object properties: country_code: type: string description: corresponding country code for the orgization value company_name: type: string description: Name of the Company company_value: type: string description: Value of the Company division_name: type: string description: Name of the Division division_value: type: string description: Value of the Division division_contact_first_name: type: string description: First Name of the Primary Contact for the Division division_contact_last_name: type: string description: Last Name of the Primary Contact for the Division division_contact_email: type: string description: Email Address of the Primary Contact for the Division business_unit_name: type: string description: Name of the Business Unit business_unit_value: type: string description: Value of the Business Unit business_unit_contact_first_name: type: string description: First Name of the Primary Contact for the Business Unit business_unit_contact_last_name: type: string description: Last Name of the Primary Contact for the Business Unit business_unit_contact_email: type: string description: Email Address of the Primary Contact for the Business Unit line_of_business_name: type: string description: Name of the Line of Business line_of_business_value: type: string description: Value of the Line of the Business line_of_business_contact_first_name: type: string description: First Name of the Primary Contact for the Line of Business line_of_business_contact_last_name: type: string description: Last Name of the Primary Contact for the Line of Business line_of_business_contact_email: type: string description: Email Address of the Primary Contact for the Line of Business region_name: type: string description: Name of the Region region_value: type: string description: Value of the Region region_contact_first_name: type: string description: First Name of the Primary Contact for the Region region_contact_last_name: type: string description: Last Name of the Primary Contact for the Region region_contact_email: type: string description: Email Address of the Primary Contact for the Region district_name: type: string description: Name of the District district_value: type: string description: Value of the District district_contact_first_name: type: string description: First Name of the Primary Contact for the District district_contact_last_name: type: string description: Last Name of the Primary Contact for the District district_contact_email: type: string description: Email Address of the Primary Contact for the District profit_center_name: type: string description: Name of the Profit Center profit_center_value: type: string description: Value of the Profit Center profit_center_contact_first_name: type: string description: First Name of the Primary Contact for the Profit Center profit_center_contact_last_name: type: string description: Last Name of the Primary Contact for the Profit Center profit_center_contact_email: type: string description: Email Address of the Primary Contact for the Profit Center location_name: type: string description: Name of the Location location_value: type: string description: Value of the Location location_contact_first_name: type: string description: First Name of the Primary Contact for the Location location_contact_last_name: type: string description: Last Name of the Primary Contact for the Location location_contact_email: type: string description: Email Address of the Primary Contact for the Location sub_location_name: type: string description: Name of the Sub Location sub_location_value: type: string description: Value of the Sub Location sub_location_contact_first_name: type: string description: First Name of the Primary Contact for the Sub Location sub_location_contact_last_name: type: string description: Last Name of the Primary Contact for the Sub Location sub_location_contact_email: type: string description: Email Address of the Primary Contact for the Sub Location user_hierarchy: type: object properties: email: type: string description: Email address of the user country_code: type: string description: Country Code of the user company: type: string description: Company Value of the user company_name: type: string description: Company Name of the user division: type: string description: Division Value of the user division_name: type: string description: Division Name of the user business_unit: type: string description: Business Unit Value of the user business_unit_name: type: string description: Business Unit Name of the user line_of_business: type: string description: Line of Business Value of the user line_of_business_name: type: string description: Line of Business Name of the user region: type: string description: Region Value of the user region_name: type: string description: Region Name of the user district: type: string description: District Value of the user district_name: type: string description: District Name of the user securitySchemes: apiKey: type: apiKey in: header name: apikey description: This HTTP Header variable will verify permissions. x-refined-from: - aramark-organization-hierarchy-v2-openapi.json - aramark-profile-user-openapi.json