{"openapi":"3.0.0","info":{"description":"\nThis is a collection of Division 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":"Division Details"},"security":[{"apiKey":[]}],"paths":{"/division/addresses/{org_value}":{"get":{"operationId":"getDivisionDetailsAddressByOrgValue","tags":["Address"],"summary":"Returns a collection of Division Address Attributes for One Division","description":"![This endpoint is in development](/themes/portal/images/statuspngs/statusdev.png)\n","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 Division 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"},"division_address_details":{"type":"array","items":{"$ref":"#/components/schemas/division_address_details"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}},"/division/addresses":{"get":{"operationId":"getDivisionDetailsAddress","tags":["Address"],"summary":"Returns a collection of Division Address Attributes","description":"![This endpoint is in development](/themes/portal/images/statuspngs/statusdev.png)\n","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 Division 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"},"division_address_details":{"type":"array","items":{"$ref":"#/components/schemas/division_address_details"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}},"/division/contacts/{org_value}":{"get":{"operationId":"getDivisionDetailsContactByOrgValue","tags":["Contact"],"summary":"Returns a collection of Contact Attributes for One Division","description":"![This endpoint is in production](/themes/portal/images/statuspngs/statusprod.png)\n","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 Division 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"},"division_contacts_details":{"type":"array","items":{"$ref":"#/components/schemas/division_contacts_details"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}},"/division/contacts":{"get":{"operationId":"getDivisionDetailsContact","tags":["Contact"],"summary":"Returns a collection of Division Contact Attributes","description":"![This endpoint is in production](/themes/portal/images/statuspngs/statusprod.png)\n","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 Division 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"},"division_contacts_details":{"type":"array","items":{"$ref":"#/components/schemas/division_contacts_details"}}}}}}},"404":{"description":"Requested resource does not exist."},"405":{"description":"HTTP Verb / Operation not supported"}}}}},"servers":[{"url":"https://qa-marko.aramark.net/v1/organization","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 Division.  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":{"division_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 Profit Center Address is Active or not"},"address_type":{"type":"string","description":"Description of the Type of Address of the Profit Center"},"attn_line":{"type":"string","description":"Attention Line of the Address of the Profit Center"},"address_line_1":{"type":"string","description":"First Address line of the Profit Center"},"address_line_2":{"type":"string","description":"Second Address line of the Profit Center"},"address_line_3":{"type":"string","description":"Third Address line of the Profit Center"},"address_line_4":{"type":"string","description":"Fourth Address line of the Profit Center"},"address_line_5":{"type":"string","description":"Fifth Address line of the Profit Center"},"city_locality":{"type":"string","description":"City or Locality of the Profit Center"},"state_province":{"type":"string","description":"Sate or Province of the Profit Center"},"postal_code":{"type":"string","description":"Postal Code of the Profit Center"},"country":{"type":"string","description":"Country of the Profit Center"},"country_code":{"type":"string","description":"Code of the Country of the Profit Center"},"longitude":{"type":"string","description":"Longitude value of the Profit Center"},"latitude":{"type":"string","description":"Latitude value of the Profit Center"},"source":{"type":"string","description":"Source system for the Address Longitude and Latitude"},"formatted_address":{"type":"string","description":"Fully formatted Address of the Profit Center"},"is_validated":{"type":"string","description":"Indicator if the Profit Center Address has been validated or not"},"postal_town":{"type":"string","description":"Postal Town of the Profit Center"},"neighborhood":{"type":"string","description":"Neighborhood of the Profit Center"},"establishment":{"type":"string","description":"Establishment of the Profit Center"},"admin_area_level_3":{"type":"string","description":"Admin Area Level 3 description of the Profit Center"}}},"division_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 Division contact is active or not"},"contact_type":{"type":"string","description":"Type of Division 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"}}}}}}