API Design For Pantry Finder
JSON Object - updated 20200325 based on wireframe exercise, and continuing to think about use case for MOF
We want to produce data that will be used to render the following views (provision and awaiting nicer versions from ZoCo)
Key components:
-
Foodbank - Large distribution centers that provide food to local agencies. There are ~220 foodbanks across the United States. One or more returned per zip code submitted. 99% of searches will return 1 foodbank, but some counties are served by two or more foodbanks. (E.g. 43123 should return Mid-Ohio Foodbank, where 45320 should return 2 foodbanks [The Foodbank, Inc. (Dayton) & Shared Harvest])
-
Agency- Broad term encompassing all types of organizations that work with foodbanks to distribute food to customers. Specific types of agencies include Food pantries, produce markets, Mid-Ohio Markets, soup kitchens, meal sites, etc… There are ~40k agencies across the nation. Additional data is returned belonging to an agency.
2.1 Events - Events are generally used by agencies to segment data within their account and will carry information about schedules, services, location of service, etc... Each agency has 1 or more events.
2.1.1 - Event Dates - These are the specific dates and times that each event is scheduled to operation. E.g. Kroger Community Food Pantry is scheduled to Operation Monday 3/23 3-7, Tuesday 3/24 4-8, etc... Each event has multiple event dates it is scheduled to operate
2.1.1.1 Event Slots - These are the specific windows of time that an appointment can be scheduled into. Each event date may or may not have event slots. This can be used to determine if they take appointments.
Interactive JSON Model Can be Found Here
JSON Object Preview:
Conceptual Mapping of how this extracted information will be used
