Revision as of 17:09, 17 March 2011

Open311 APIs

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

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.

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, see demo (in development)

Client Apps

Client applications can send and/or view reports

• SeeClickFix
• 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.

• Ruby Gem by Dan Melton et al
• Node.js by Mark Headd
• C Sharp by Mark Headd

GeoReport v1

Spec: GeoReport v1

Servers (can receive reports)

Clients (can send and view reports)

• SeeClickFix
• CitySourced
• TweetMy311

Client Libraries (API Wrappers)

• PHP Library by Mark Head

Inactive APIs

• DC Open 311 v1