Open311

Wiki

Collaboration for an Open311 Standard
Personal tools

API

Collaboration for an Open311 Standard

Revision as of 12:52, 28 November 2011 by Philipashlock (Talk | contribs)

Jump to: navigation, search

Open311 APIs

Inquiry/Information beta

Spec: Inquiry v1

The Inquiry/Information API is meant to be accessed to retrieve non-GeoReport-related content. This can be used for information which is typically provided to callers of a 311 system as an answer to their question. It supports three fundamental capabilities: services, facilities, and a "311 today" (RSS) feed.

Spec: Inquiry v2 Draft

Version 2 is meant to provide a more generic version of the Inquiry/Information API with extended features.

GeoReport v2

Spec: GeoReport v2

Service Discovery

GeoReport v2 and following versions are meant to be accessed via the Service Discovery mechanism to identify the status and version number for available endpoints in each jurisdiction. The service discovery mechanism is a requirement of the specification, but is meant to be independent and persistant beyond the GeoReport v2 version of the spec.

Please view the Service Discovery specification.

Servers

Servers receive and manage service requests on behalf of a jurisdiction. A comprehensive list is being maintained on the GeoReport v2 Servers page

Open source developer resources for the GeoReport v2 specification.

Server Software

Server applications provide an API endpoint and can receive and manage reports.

Client Applications

Software that interacts with an Open311 server by connecting to an API.

Dashboards & Data Viz

See also open source libraries for Visualizations

Client Libraries (API Wrappers)

Client libraries make it easier to build client applications that work with the spec.

  • PHP by Ronaldo Barbachano at Code for America
  • Python by Zach Williams at Code for America
  • Ruby Gem by Code for America labs et al (see it on GitHub)
  • Node.js by Mark Headd and Ben Sheldon
  • C# by Mark Headd
  • Clojure by Ryan Briones
  • Java by Santiago Munín at Code for America

Test Suites

Test suites are used to verify that a server is compliant with the specification.

Products & Services

See also GeoReport v2 Support for products and services.

GeoReport v1

Spec: GeoReport v1

Servers

Servers receive and manage reports on behalf of a jurisdiction.

Note that the URLs require a method and jurisdiction_id at the end, the root URL is not intended to be accessed directly.

Name Status API Key city_id Dev API Production API
San Francisco Deprecated August 2013 [Deprecated] sfgov.org [N/A Dev URL] [N/A Production URL]
Miami-Dade County Development Ready Request Key miamidade.gov Beta URL -

Clients (can send and view reports)

Client Libraries (API Wrappers)

Inactive APIs