API Documentation
This is a developer area for the Miami Open211 API, providing access to the raw data behind the Switchboard of Miami website. The purpose of this API is to allow anyone to develop web, mobile, or other types of applications that serve the mission of Switchboard of Miami. This portal is currently under development, and is not product ready yet.
Miami Open211 API OpenAPI: (YAML) (JSON)
base url: https://miamiopen211-api.herokuapp.com
Locations
Locations /locations GET
Location /locations/{location_id} GET
Find Nearby Locations /locations/{location_id}/nearby GET
Services /locations/{location_id}/services GET
Categories
Categories /categories GET
Organizations
Organizations /organizations GET
Organizations /organizations/{organization_id} GET
Organization Locations /organizations/{organization_id}/locations GET
Search
Search /search GET


Definitions JSON Schema
categories
  • id (string) - Each location must have a unique identifier
location
  • id (string) - Each location must have a unique identifier
  • organization_id (string) - Each location must belong to a single organization. The identifier of the organization should be given here.
  • name (string) - The name of the location
  • alternate_name (string) - An alternative name for the location
  • description (string) - A description of this location.
  • transportation (string) - A description of the access to public or private transportation to and from the location.
  • latitude (string) - Y coordinate of location expressed in decimal degrees in WGS84 datum.
  • longitude (string) - X coordinate of location expressed in decimal degrees in WGS84 datum.
phone
  • id (string) - Each entry must have a unique identifier
  • location_id (string) - The identifier of the location where this phone number is located
  • service_id (string) - The identifier of the service for which this is the phone number
  • organization_id (string) - The identifier of the organisation for which this is the phone number
  • contact_id (string) - The identifier of the contact for which this is the phone number
  • number (string) - The phone number
  • extension (string) - The extension of the phone number
  • type (string) - Whether the phone number relates to a fixed or cellular phone
  • department (string) - The department for which this is the phone number
service
  • id (string) - Each service must have a unique identifier.
  • organization_id (string) - The identifier of the organization that provides this service.
  • location_id (string) - The identifier of the location where this service is delivered.
  • program_id (string) - The identifier of the program this service is delivered under.
  • name (string) - The official or public name of the service.
  • alternate_name (string) - Alternative or commonly used name for a service.
  • description (string) - A description of the service.
  • url (string) - URL of the service
  • email (string) - Email address for the service
  • status (string) - The current status of the service.
  • application_process (string) - The steps needed to access the service.
  • wait_time (string) - Time a client may expect to wait before receiving a service.
  • taxonomy_ids (string) - A comma separated list of identifiers from the taxonomy table. Advanced users may also include composite categories, using * to combine two taxonomy terms.
organization
  • id (string) - Each organization must have a unique identifier.
  • name (string) - The official or public name of the organization.
  • alternate_name (string) - Alternative or commonly used name for the organization.
  • description (string) - A brief summary about the organization. It can contain markup such as HTML or Markdown.
  • email (string) - The contact e-mail address for the organization.
  • url (string) - The UR of the organization.
  • tax_status (string) - Government assigned tax designation for for tax-exempt organizations.
  • tax_id (string) - A government issued identifier used for the purpose of tax administration.
  • year_incorporated (string) - The year in which the organization was legally formed.
  • legal_status (string) - The legal status defines the conditions that an organization is operating under.