{ "openapi": "3.0.0", "info": { "description": "\nThis is a collection of Location Details\n\nThe base endpoint URL for this API in production is: `https://marko.aramark.net/v1/organization`.\n\nFor 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\".\n", "version": "1.0.0-oas3", "title": "Location Details" }, "security": [ { "apiKey": [] } ], "paths": { "/location/core/{org_value}": { "get": { "operationId": "getLocationDetailsCoreByOrgValue", "tags": [ "Core" ], "summary": "Returns a collection of Location Core Attributes for One Location", "parameters": [ { "$ref": "#/components/parameters/orgValueParam" }, { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/sizeParam" }, { "$ref": "#/components/parameters/bypassCacheParam" }, { "$ref": "#/components/parameters/smokeParam" } ], "responses": { "200": { "description": "Collection of Location Core Attributes", "content": { "*/*": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "ENUM 'Success' or 'Error'", "default": "Success" }, "count": { "type": "string", "description": "Number of records returned" }, "location_core_details": { "type": "array", "items": { "$ref": "#/components/schemas/location_core_details" } } } } } } }, "404": { "description": "Requested resource does not exist." }, "405": { "description": "HTTP Verb / Operation not supported" } } } }, "/location/core": { "get": { "operationId": "getLocationDetailsCore", "tags": [ "Core" ], "summary": "Returns a collection of Location Core Attributes", "parameters": [ { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/sizeParam" }, { "$ref": "#/components/parameters/bypassCacheParam" }, { "$ref": "#/components/parameters/smokeParam" } ], "responses": { "200": { "description": "Collection of Location Core Attributes", "content": { "*/*": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "ENUM 'Success' or 'Error'", "default": "Success" }, "count": { "type": "string", "description": "Number of records returned" }, "location_core_details": { "type": "array", "items": { "$ref": "#/components/schemas/location_core_details" } } } } } } }, "404": { "description": "Requested resource does not exist." }, "405": { "description": "HTTP Verb / Operation not supported" } } } }, "/location/addresses/{org_value}": { "get": { "operationId": "getLocationDetailsAddressByOrgValue", "tags": [ "Address" ], "summary": "Returns a collection of Location Address Attributes for One Location", "parameters": [ { "$ref": "#/components/parameters/orgValueParam" }, { "$ref": "#/components/parameters/addressTypeParam" }, { "$ref": "#/components/parameters/formatParam" }, { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/sizeParam" }, { "$ref": "#/components/parameters/bypassCacheParam" }, { "$ref": "#/components/parameters/smokeParam" } ], "responses": { "200": { "description": "Collection of Location Address Attributes", "content": { "*/*": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "ENUM 'Success' or 'Error'", "default": "Success" }, "count": { "type": "string", "description": "Number of records returned" }, "location_address_details": { "type": "array", "items": { "$ref": "#/components/schemas/location_address_details" } } } } } } }, "404": { "description": "Requested resource does not exist." }, "405": { "description": "HTTP Verb / Operation not supported" } } } }, "/location/addresses": { "get": { "operationId": "getLocationDetailsAddress", "tags": [ "Address" ], "summary": "Returns a collection of Location Address Attributes", "parameters": [ { "$ref": "#/components/parameters/addressTypeParam" }, { "$ref": "#/components/parameters/formatParam" }, { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/sizeParam" }, { "$ref": "#/components/parameters/bypassCacheParam" }, { "$ref": "#/components/parameters/smokeParam" } ], "responses": { "200": { "description": "Collection of Location Address Attributes", "content": { "*/*": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "ENUM 'Success' or 'Error'", "default": "Success" }, "count": { "type": "string", "description": "Number of records returned" }, "location_address_details": { "type": "array", "items": { "$ref": "#/components/schemas/location_address_details" } } } } } } }, "404": { "description": "Requested resource does not exist." }, "405": { "description": "HTTP Verb / Operation not supported" } } } }, "/location/contacts/{org_value}": { "get": { "operationId": "getLocationDetailsContactByOrgValue", "tags": [ "Contact" ], "summary": "Returns a collection of Contact Attributes for One Location", "parameters": [ { "$ref": "#/components/parameters/orgValueParam" }, { "$ref": "#/components/parameters/contactTypeParam" }, { "$ref": "#/components/parameters/formatParam" }, { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/sizeParam" }, { "$ref": "#/components/parameters/bypassCacheParam" }, { "$ref": "#/components/parameters/smokeParam" } ], "responses": { "200": { "description": "Collection of Location Contact Attributes", "content": { "*/*": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "ENUM 'Success' or 'Error'", "default": "Success" }, "count": { "type": "string", "description": "Number of records returned" }, "location_contacts_details": { "type": "array", "items": { "$ref": "#/components/schemas/location_contacts_details" } } } } } } }, "404": { "description": "Requested resource does not exist." }, "405": { "description": "HTTP Verb / Operation not supported" } } } }, "/location/contacts": { "get": { "operationId": "getLocationDetailsContact", "tags": [ "Contact" ], "summary": "Returns a collection of Location Contact Attributes", "parameters": [ { "$ref": "#/components/parameters/contactTypeParam" }, { "$ref": "#/components/parameters/searchParam" }, { "$ref": "#/components/parameters/formatParam" }, { "$ref": "#/components/parameters/pageParam" }, { "$ref": "#/components/parameters/sizeParam" }, { "$ref": "#/components/parameters/bypassCacheParam" }, { "$ref": "#/components/parameters/smokeParam" } ], "responses": { "200": { "description": "Collection of Location Contact Attributes", "content": { "*/*": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "ENUM 'Success' or 'Error'", "default": "Success" }, "count": { "type": "string", "description": "Number of records returned" }, "location_contacts_details": { "type": "array", "items": { "$ref": "#/components/schemas/location_contacts_details" } } } } } } }, "404": { "description": "Requested resource does not exist." }, "405": { "description": "HTTP Verb / Operation not supported" } } } } }, "servers": [ { "url": "https://qa-marko.aramark.net/v1/", "description": "Testing server" }, { "url": "https://dev-marko.aramark.net/v1/organization" } ], "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "apikey", "description": "This HTTP Header variable will verify permissions." } }, "parameters": { "orgValueParam": { "in": "path", "name": "org_value", "required": true, "description": "provide business organization code in URL to filter data set", "schema": { "type": "string" } }, "formatParam": { "in": "query", "name": "format", "required": false, "description": "allows to change the output to a desired format. 'JSON' - JSON, 'CSV' - CSV, 'XLS' - Excel", "schema": { "type": "string", "enum": [ "JSON", "CSV", "XLS" ] } }, "addressTypeParam": { "in": "query", "name": "address_type", "description": "optional parameter to limit results to a specfic address type", "schema": { "type": "string", "enum": [ "billing", "forwarding", "mailing", "physical", "remit", "shipping" ] } }, "contactTypeParam": { "in": "query", "name": "contact_type", "description": "optional parameter to limit results to a specfic address type", "schema": { "type": "string", "enum": [ "manager", "consumer_alert" ] } }, "pageParam": { "in": "query", "name": "page", "description": "Page number of result set", "schema": { "type": "number", "default": 1 } }, "sizeParam": { "in": "query", "name": "size", "description": "Number of records to be returned in each page of result set", "schema": { "type": "string", "default": 50 } }, "searchParam": { "in": "query", "name": "search", "description": "Used to search a specific Location. Will match against Name and Value. Maximum length of 20 characters.", "schema": { "type": "string" } }, "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" } } }, "schemas": { "location_core_details": { "type": "object", "properties": { "org_value": { "type": "string", "description": "Aramark Organization code" }, "org_name": { "type": "string", "description": "Name of the Aramark Organization" }, "status": { "type": "string", "description": "Indicator if the Location is Active or not" }, "status_description": { "type": "string", "description": "Description of whether the Location is Active or not" }, "country": { "type": "string", "description": "Country where the Location operates" }, "profit_center_value": { "type": "string", "description": "Profit Center value for the Location" }, "profit_center_name": { "type": "string", "description": "Name of the Profit Center of the Location" }, "legacy_value": { "type": "string", "description": "Legacy CSP value of the Location" }, "public_name": { "type": "string", "description": "Public name of the Location" }, "short_name": { "type": "string", "description": "Short Name of the Location" }, "payroll_org_value": { "type": "string", "description": "Payroll Org Value of the Location" }, "type_code": { "type": "string", "description": "Code for the Type of Location" }, "type_description": { "type": "string", "description": "Type of Location" }, "wfm_reference": { "type": "string", "description": "WFM Reference for the Location" }, "primary_flag": { "type": "string", "description": "Primary Flag value for the Location" }, "operation_start_date": { "type": "string", "description": "Date on which the Location operations started" }, "operation_close_date": { "type": "string", "description": "Date on which the Location operations closed" }, "bill_code": { "type": "string", "description": "Code for Bill of the Location" }, "bill_description": { "type": "string", "description": "Bill for the Location" }, "intercompany_code": { "type": "string", "description": "Intercompany Code for the Location" }, "intercompany_description": { "type": "string", "description": "Intercompany for the Location" }, "future_code": { "type": "string", "description": "Future Code for the Location" }, "future_description": { "type": "string", "description": "Future for the Location" }, "event_code": { "type": "string", "description": "Event Code for the Location" }, "event_description": { "type": "string", "description": "Event for the Location" }, "tax_code": { "type": "string", "description": "Tax Code for the Location" }, "tax_description": { "type": "string", "description": "Tax for the Location" }, "service_type_code": { "type": "string", "description": "Service Type Code for the Location" }, "service_type_description": { "type": "string", "description": "Service Type for the Location" }, "concept_code": { "type": "string", "description": "Concept Code for the Location" }, "concept_description": { "type": "string", "description": "Concept for the Location" }, "postal_code": { "type": "string", "description": "Postal Code for the Location" }, "calc_contract_type": { "type": "string", "description": "Calc Contract Type for the Location" }, "calc_contract_type_id": { "type": "string", "description": "Calc Contract Type ID for the Location" }, "timezone": { "type": "string", "description": "Timezone for the Location" } } }, "location_address_details": { "type": "object", "properties": { "org_type": { "type": "string", "description": "Type of Aramark Organization" }, "org_value": { "type": "string", "description": "Aramark Organization code" }, "org_name": { "type": "string", "description": "Name of the Aramark Organization" }, "org_address_status": { "type": "string", "description": "Indicator if the Location Address is Active or not" }, "address_type": { "type": "string", "description": "Description of the Type of Address of the Location" }, "attn_line": { "type": "string", "description": "Attention Line of the Address of the Location" }, "address_line_1": { "type": "string", "description": "First Address line of the Location" }, "address_line_2": { "type": "string", "description": "Second Address line of the Location" }, "address_line_3": { "type": "string", "description": "Third Address line of the Location" }, "address_line_4": { "type": "string", "description": "Fourth Address line of the Location" }, "address_line_5": { "type": "string", "description": "Fifth Address line of the Location" }, "street_number": { "type": "string", "description": "Street Number of the Location" }, "street_name": { "type": "string", "description": "Street Name of the Location" }, "city_locality": { "type": "string", "description": "City or Locality of the Location" }, "state_province": { "type": "string", "description": "Sate or Province of the Location" }, "postal_code": { "type": "string", "description": "Postal Code of the Location" }, "country": { "type": "string", "description": "Country of the Location" }, "country_code": { "type": "string", "description": "Code of the Country of the Location" }, "longitude": { "type": "string", "description": "Longitude value of the Location" }, "latitude": { "type": "string", "description": "Latitude value of the Location" }, "source": { "type": "string", "description": "Source system for the Address Longitude and Latitude" }, "formatted_address": { "type": "string", "description": "Fully formatted Address of the Location" }, "is_validated": { "type": "string", "description": "Indicator if the Location Address has been validated or not" }, "postal_town": { "type": "string", "description": "Postal Town of the Location" }, "neighborhood": { "type": "string", "description": "Neighborhood of the Location" }, "establishment": { "type": "string", "description": "Establishment of the Location" }, "admin_area_level_3": { "type": "string", "description": "Admin Area Level 3 description of the Location" }, "timezone_id": { "type": "string", "description": "Timezone ID of the Location" }, "timezone_name": { "type": "string", "description": "Timezone of the Location" } } }, "location_contacts_details": { "type": "object", "properties": { "org_value": { "type": "string", "description": "Aramark Organization code" }, "org_name": { "type": "string", "description": "Name of the Aramark Organization" }, "org_contact_status": { "type": "string", "description": "Indicator if the Location contact is active or not" }, "contact_type": { "type": "string", "description": "Type of Location contact" }, "first_name": { "type": "string", "description": "First name of the contact" }, "last_name": { "type": "string", "description": "Last name of the contact" }, "primary_email": { "type": "string", "description": "Primary email address of the contact" }, "job_title": { "type": "string", "description": "Job title of the contact" }, "country": { "type": "string", "description": "Country in which the contact is located" }, "last_update_date": { "type": "string", "description": "Date on which the information was last updated" } } } } } }