Latest revision as of 16:12, 27 February 2013

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.

uReport Open311 Server. PHP-based Open311 Server & CRM by Bloomington
GeoReport v2 Server - Python-based middleware/server by Miami-Dade County
GeoReport v2 Server by Diptanu - Python-based CRM server in early stages of development
Mark-a-Spot Drupal Distribution. There's also Integration for the older standalone Mark-a-Spot CakePHP code.
Open311 on Joget. See Blog post. (in development).
(Deprecated) Open311 API in PHP - raw API with no UI - refer to fms-endpoint and Ushahidi plugin below which have improved this code
Open311 Plugin for Ushahidi (in development. More background on the Ushahidi wiki)
FMS-Endpoint Open311 API for FixMyStreet - "fms-endpoint" using Codeigniter PHP - by MySociety (Doesn't require FixMyStreet. Based on two codebases listed above)
FixMyStreet integration. See FixMyStreet.com/open311 and example of support within a city: Southampton UK
Shareabouts has planned support in the future.
I think there may also be some ongoing work for Kajoo integration

Client Applications

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

GeoReporter Open311 Android app - download GeoReporter from Google play
GeoReporter Open311 iPhone app - download GeoReporter from the Apple App Store
Open311 Proxy - a PHP/HTML/javascript client that doesn't expose API keys
Open311 Facebook app
Open311 Plugin for Ushahidi - can reroute issues from Ushahidi to an external Open311 endpoint.
OpenBlock is not an Open311 client per se, but can consume and display Open311 reports on a map; see Boston demo

Dashboards & Data Viz

The Daily Brief - See live at dailybrief.311labs.org
311.fm - see live at 311.fm and also forked for chicagoworksforyou.com
Open311 Data Analysis Proxy used for 311.fm
Open311 Dashboard See the Blog post (in development)

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.

https://github.com/seeclickfix/open311-validator/ (ruby based, initial release Nov 2011)
http://github.com/open311/open311-validator-py (python based, not up to date)
GeoReporter Client can be used to test GeoReport v2 endpoints.
https://github.com/ryanbriones/open311-api-tests

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)

SeeClickFix
CitySourced
Facebook App (for San Francisco's Open311 API)

Client Libraries (API Wrappers)

PHP Library by Mark Head

Inactive APIs

DC Open 311 v1

@@ Line 1: / Line 1: @@
 =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]]===
-Here is a proposal for doing specifying metadata about Open311 endpoints. It is expected that a version of this will be included in v2.
+====Service Discovery====
-[[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 reports on behalf of a jurisdiction.
+{{:GeoReport v2}}
+{{:GeoReport v2/Resources}}
-''Note that the URLs require a method and jurisdiction_id at the end, the root URL is not intended to be accessed directly.''
-{| class="wikitable sortable"
-! Name
-! Status
-! API Key
-! Dev API
-! Production API
-|-
-| '''San Francisco'''
-| ''Development Ready''
-| [http://apps.sfgov.org/Open311API/?page_id=486 Request Key]
-| [https://open311.sfgov.org/dev/V2/ Dev URL]
-| [https://open311.sfgov.org/v2 Production URL]
-|-
-| '''Washington D.C.'''
-| ''Development Ready''
-|  -
-| -
-| [http://311.dc.gov/cwi/Open311/v2/ Production URL]
-|}
-====Server Software====
-Server applications can receive and manage reports
-* http://svn.ashlock.us/public/georeport-v2-api-php/ (in development)
-* http://svn.ashlock.us/public/georeport_ushahidi/v2/ - Ushahidi integration, [http://ushahidi.georeport.org/georeport/v2/requests.xml see demo] (in development)
-===Client Apps===
-Client applications can send and/or view reports
-* [http://help.seeclickfix.com/kb/api/api-overview SeeClickFix]
-* [http://www.facebook.com/SF?sk=app_128760367192739 Facebook App] (for San Francisco's Open311 API)
-====Test Suites====
-Test suites are used to verify that a server is compliant with the specification.
-* http://github.com/open311/open311-validator (in development)
-====Client Libraries (API Wrappers)====
-Client libraries make it easier to build client applications that work with the spec.
-* [http://rubygems.org/gems/open311 Ruby Gem] by Dan Melton et al
-* [https://github.com/mheadd/node-open311 Node.js]  by Mark Headd
-* [https://github.com/mheadd/CSharpOpen311-v2 C Sharp] by Mark Headd
 ==GeoReport v1==
 ===Spec: [[GeoReport v1]]===
-===Servers (can receive reports)===
+===Servers===
-{|
+{{:GeoReport v1}}
-! Name
-! Status
-! API Key
-! Dev API
-! Production API
-|-
-| '''City of San Francisco'''
-| ''Production Ready''
-| [http://apps.sfgov.org/Open311API/?page_id=486 Request Key]
-| [https://open311.sfgov.org/dev/V1 Dev URL]
-| [https://open311.sfgov.org/V1 Production URL]
-|}
 ===Clients (can send and view reports)===
 * [http://seeclickfix.blogspot.com/2010/05/seeclickfix-integrates-data-with-san.html SeeClickFix]
 * [http://blog.citysourced.com/index.php/54/citysourced-integrates-san-franciscos-open-311-system/ CitySourced]
-* [http://tweetmy311.org/ TweetMy311]
+* [http://www.facebook.com/SF?sk=app_128760367192739 Facebook App] (for San Francisco's Open311 API)
 ====Client Libraries (API Wrappers)====

Open311

Wiki

Personal tools

Views

Difference between revisions of "API"

Collaboration for an Open311 Standard

Latest revision as of 16:12, 27 February 2013

Contents

Open311 APIs

Inquiry/Information beta

Spec: Inquiry v1

Spec: Inquiry v2 Draft

GeoReport v2

Spec: GeoReport v2

Service Discovery

Servers

Server Software

Client Applications

Dashboards & Data Viz

Client Libraries (API Wrappers)

Test Suites

Products & Services

GeoReport v1

Spec: GeoReport v1

Servers

Clients (can send and view reports)

Client Libraries (API Wrappers)

Inactive APIs

Search

Tools

Navigation

Meta

Open311