Frequently Asked Questions

These are the most common questions asked about the Miami Open211 API, grouped into relevant topic areas to help you find the answers you are looking for.

General

  • What is the Miami Open211 project? - The Miami Open211 project is prototyping an 'open platform' for the Miami 2-1-1 community resource referral program.
  • Why is Miami Open211 deploying an API? - Miami's 2-1-1 hotline curates comprehensive directory information about the many health, human, and social services available to Miami-Dade residents in need. This project aims to demonstrate that API access to this data can expand the reach of 2-1-1's information and enhance its sustainability as a public service.
  • What can I build with the APIs? - The possibilities are endless! Check out [the prototype front-end that we built](https://github.com/miami-open-211/miami211), or check out [HelpSteps](https://github.com/codeforboston/helpsteps-mobile) and [Link](https://github.com/zendesk/linksf) for examples of other tools that can be compatible with this API.

Support

  • What is the best way to get support? - Miami Open211 is a prototype, and is not currently supported formally. But please submit issues and reach out, and we'll see if we can help :)
  • Can I email you? - Sure. Reach the project director Greg Bloom at bloom@openreferral.org
  • Can I talk to you on the phone? - Sure. Reach the project director Greg Bloom at 305 962 2859

About Open Referral

  • What is the Open Referral initiative? - Check out Open Referral's [website here](https://openreferral.org), and the Open Referral [FAQ here](http://docs.openreferral.org/en/latest/faq).

Management

  • How do I edit the home page of the Miami Open211 API portal? - The home page of the developer portal is entirely dynamic and generated using the APIs.json (yaml) for this project.
  • How do I edit the getting started page for the Miami Open211 API portal? - The getting started of the developer portal is entirely dynamic and generated using the getting started YAML file for this project.
  • How do I edit the authentication page for the Miami Open211 API portal? - The authentication of the developer portal is entirely dynamic and generated using the authenitcation YAML file for this project.
  • How do I edit the FAQ page for the Miami Open211 API portal? - The FAQ of the developer portal is entirely dynamic and generated using the FAQ YAML file for this project.
  • How do I edit the documentation page for the Miami Open211 API portal? - The documentation of the developer portal is entirely dynamic and generated using the OpenAPI YAML file for this project, following the OpenAPI specification.
  • How do I edit the code page for the Miami Open211 API portal? - The code of the developer portal is entirely dynamic and generated using the FAQ YAML file for this project.
  • How do I edit the road map page for the Miami Open211 API portal? - The road map of the developer portal is entirely dynamic and generated using the road map YAML file for this project.
  • How do I edit the issues page for the Miami Open211 API portal? - The issues of the developer portal is entirely dynamic and generated using the issues YAML file for this project.
  • How do I edit the change log page for the Miami Open211 API portal? - The change log of the developer portal is entirely dynamic and generated using the change log YAML file for this project.
  • How do I edit the terms of service page for the Miami Open211 API portal? - The terms of service of the developer portal is entirely dynamic and generated using the terms of service page for this project.
  • How do I edit the privacy policy page for the Miami Open211 API portal? - The privacy policy of the developer portal is entirely dynamic and generated using the change log YAML file for this project.

We will add new questions to the list as they get asked via support channels. Make sure and also checkout the support page, blog, change log, and road map to see if your question has been answered but not added here yet.