|
|
| (36 intermediate revisions by 6 users not shown) |
| Line 1: |
Line 1: |
| − | === General Description ===
| + | '''Overview and revision history for San Francisco:''' |
| − | Notes from [http://etherpad.com/wCotZZ0OCE Open311 DevCamp Etherpad]: 311 twitter integration, exciting about participating in Open311 api, been considering for a while. Agrees with not just looking at request, but also disseminating information. Happy to focus just on requests for now, but then getting to how to answer questsion. Draft api is modeled after DC api. Fast tracking this, next few months . Using Lagan system, the vision is to route that to departments that do the work. Have a middleware system, using Oracle, thinking of changing that model, so 311 is a central hub, so other depts poll system. rather than pushing data out, just wnt to make sure that information will flow out. Very optimistic
| + | |
| | | | |
| − | [http://apps.sfgov.org/Open311API/ Information on San Francisco's Open311 implementation]
| + | Get API Keys: |
| | + | http://apps.sfgov.org/Open311API/?page_id=486 |
| | | | |
| | + | Current APIs |
| | + | * [[GeoReport v2]] |
| | + | * [[GeoReport v1]] |
| | | | |
| − | === Interested in our Open311 Efforts===
| + | '''Implementation History''' |
| | | | |
| − | We’d like to invite anyone interested in moving the Open311 API forward to this public meeting. So we have an idea of your areas of interest and some background we ask that you fill out a [http://apps.sfgov.org/Open311API/?page_id=448 simple form].
| + | '''April 2011''' |
| | | | |
| − | Here are the details:
| + | We've posted our Discovery service on the Open311 GeoReport v2 Servers page [http://wiki.open311.org/GeoReport_v2/Servers] |
| − | When: Dec 3rd, 5:30PM PST
| + | |
| − | Where: 641.715.3625 Pin: 813951#
| + | |
| | | | |
| − | Agenda:
| + | We have added a few new services related to Blight, clarified services related to trees, and removed some that really should be called in to the center (like water main break!) |
| − | 1. Present to the public our [http://apps.sfgov.org/Open311API/?page_id=382 draft design spec]
| + | |
| − | 2. Identify gaps in design
| + | |
| − | 3. Brainstorm
| + | |
| | | | |
| − | === Proposed Architecture ===
| + | '''Feb 2011''' |
| − | [[File:achitecture2010.jpg]]
| + | |
| | | | |
| − | === <h2>SF Open 311 API</h2> ===
| + | We have launched our own Facebook application using the Open311 API [http://www.facebook.com/SF311#!/SF311?sk=app_128760367192739] |
| − | <h2>Description</h2>
| + | |
| − | Open311 will make public APIs for developers to build applications to report issues such as graffiti, potholes, and street cleaning directly to city departments.
| + | |
| − | <h3>Service Lifecycle</h3>
| + | |
| − | The following describes the user experience for submitting a 311 service request:
| + | |
| | | | |
| − | Service Request >> Select Location >> Service Details>> Citizen Information (optional): >> Service Request # and Service Level Agreement >> Status Update
| + | '''Production API Keys have been issued to:''' |
| − | | + | *Blockboard[http://blockboard.org/] |
| − | <h3>Select Service</h3>
| + | *Citysourced[http://www.citysourced.com/default.aspx] |
| − | <ul><strong>Purpose:</strong> provide a list of acceptable 311 services and associated service code<br>
| + | *HeyGov[http://www.heygov.com/default.aspx?MapID=SanFran311] |
| − | <strong>Method name:</strong> service_list<br>
| + | *Mojipage[http://mojipage.com/] |
| − | <strong>URL:</strong><br>
| + | *SeeClickFix[http://www.seeclickfix.com/] |
| − | <strong>Formats: </strong>xml<br>
| + | *TweetMy311[http://tweetmy311.org/] |
| − | <strong>HTTP Method: </strong>GET<br>
| + | |
| − | <strong>Requires Authentication: </strong>false<br>
| + | |
| − | <strong>Arguments: </strong><ul><li>api_key</li><li>city_id</li></ul><br>
| + | |
| − | <strong>Response:</strong> <ul><br>
| + | |
| − | list with the following:
| + | |
| − | <li>service_name</li>
| + | |
| − | <li>service_code</li>
| + | |
| − | <li>service_description</li></ul>
| + | |
| − | </ul>
| + | |
| − | <strong>
| + | |
| − | <h3>Create Request</h3> </strong>
| + | |
| − | <ul><strong>Purpose:</strong> Create services<br>
| + | |
| − | <strong>Method name:</strong> services<br>
| + | |
| − | <strong>URL:</strong><br>
| + | |
| − | <strong>Formats:</strong> xml<br>
| + | |
| − | <strong>HTTP Method:</strong> POST<br>
| + | |
| − | <strong>Requires Authentication:</strong> true<br>
| + | |
| − | <strong>Arguments:</strong>
| + | |
| − | <ul>
| + | |
| − | <li>api_key</li>
| + | |
| − | <li>city_id</li>
| + | |
| − | <li>service_code (obtained from method service_list)</li>
| + | |
| − | <li>lat [http://en.wikipedia.org/wiki/World_Geodetic_System (WGS84)] (required - either lat/lon or address string, both are preferred)</li>
| + | |
| − | <li>lon [http://en.wikipedia.org/wiki/World_Geodetic_System (WGS84)] (required - either lat/lon or address string, both are preferred)</li>
| + | |
| − | <li> address_string (human entered description of location)(if no lat/lon must provide this information)</li>
| + | |
| − | <li>customer_email (optional)</li>
| + | |
| − | <li>device_id (optional)</li>
| + | |
| − | <li>account_id (optional)</li>
| + | |
| − | <li>first_name (optional)</li>
| + | |
| − | <li>last_name (optional)</li>
| + | |
| − | <li>phone_number (optional)</li>
| + | |
| − | <li>description (free form limited to 4,000 characters) (optional)</li>
| + | |
| − | <li>media_url (url to the page that contains the media)(optional)</li>
| + | |
| − | </ul>
| + | |
| − | <strong>Response: </strong>
| + | |
| − | <ul><li>service_request_id</li>
| + | |
| − | <li>service_level_agreement (may not be returned)</li>
| + | |
| − | <li>account_id (may not be returned)</li>
| + | |
| − | <li>error codes</li>
| + | |
| − | </ul></ul>
| + | |
| − | <h3>Status Update</h3>
| + | |
| − | <ul><strong>Purpose:</strong> provide a status update for service request<br>
| + | |
| − | <strong>Method name:</strong> status_update<br>
| + | |
| − | <strong>URL:</strong><br>
| + | |
| − | <strong>Formats: </strong>xml<br>
| + | |
| − | <strong>HTTP Method: </strong>GET<br>
| + | |
| − | <strong>Requires Authentication: </strong>true<br>
| + | |
| − | <strong>Arguments: </strong>
| + | |
| − | <ul><li>api_key</li><li>city_id</li>
| + | |
| − | <li>service_request_id</li>
| + | |
| − | </ul>
| + | |
| − | <strong>Response:</strong>
| + | |
| − | <ul><li>service_request_id</li>
| + | |
| − | <li>status</li>
| + | |
| − | <li>status_notes (may not be returned)</li>
| + | |
| − | <li>service_name</li></ul>
| + | |
| − | </ul>
| + | |
We have added a few new services related to Blight, clarified services related to trees, and removed some that really should be called in to the center (like water main break!)
