webservice.txt
1 ********Service Overview:***********
2 The  311 Requests Service consists of a RESTful webservice  that allows developers and the public to retrieve  311 Requests data. Clients need to input three parameters in the request URL:
3 1) REQUEST TYPE: request_type ( valid request types listed below)
4 2) START DATE : start_date ( in the format YYYY-MM-DD)
5 3) END DATE : end_date (in the format YYYY-MM-DD)
6 The following attributes of a request will be displayed for each successful response: id, type,date, time, address,lon(longitude), lat(latitude) , district.
7
8 ******Valid Request Types:***********
9 1) all (to retrieve all requests)
10 2) Blocked Street or Sidewalk (to retrieve "Blocked Street or Sidewalk" requests only)
11 3) Catch Basin Maintenance (to retrieve "Catch Basin Maintenance" requests only)
12 4) Damaged Property (to retrieve "Damaged Property requests" only)
13 5) Graffiti Complaint Public Property (to retrieve "Graffiti Complaint - Public Property" requests only)
14 6) Graffiti Complaint Private Property (to retrieve "Graffiti Complaint  Private Property" requests only)
15 7) Illegal Postings (to retrieve "Illegal Postings" requests only)
16 8) Request for City Services (to retrieve "Request for City Services" only)
17 9) Sewer Issues (to retrieve "Sewer Issues" requests only)
18 10) Sidewalk and Curb Issues (to retrieve "Sidewalk and Curb Issues" requests only)
19 11) Street and Sidewalk Cleaning (to retrieve "Street and Sidewalk Cleaning" requests only)
20 12) Street Defect (to retrieve "Street Defect" requests only)
21 13) Tree Maintenance or Damage (to retrieve "Tree Maintenance or Damage" requests only)
22 14) Volunteer Request (To retrieve "Volunteer Request" requests only)
23 Note : request type is not case sensitive
24
25 *********Sample Request URLs:**********
26 http://crmproxy.sfgov.org/status/ReportService/ProxyService/ReportCommandHandler?request_type=all&start_date=2009-09-18&end_date=2009-09-25
27 (will retrieve all 311 service requests from 09/18/2009 to 09/25/2009)
28 http://crmproxy.sfgov.org/status/ReportService/ProxyService/ReportCommandHandler?request_type=Street Defect&start_date=2009-09-18&end_date=2009-09-25
29 (will retrieve "Street Defect" requests from 09/18/2009 to 09/25/2009)
30 http://crmproxy.sfgov.org/status/ReportService/ProxyService/ReportCommandHandler?request_type=Graffiti Complaint Public Property&start_date=2009-09-18&end_date=2009-09-25
31 (will retrieve "Graffiti Complaint - Public Property" requests from 09/18/2009 to 09/25/2009)
32
33 *********HTTP method(s):*************
34 GET
35
36 **********HTTP Status Code:**********
37 200 OK: The request has succeeded.
38 400 Bad Request: The request was invalid. An accompanying error message will explain why
39 403 Forbidden: The request is understood, but it has been refused. An accompanying error message will explain why.
40 404 Not Found: The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent.
41 500 Internal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request
42
43 **********Requires Authentication:**********
44 false
45
46 **********Response Format:**********
47 xml
48
49 **********Sample Response:**********
50 <?xml version="1.0" encoding="utf-8" ?> 
51    <Sf311ServiceRequests xmlns:m="http://org/sfgov/report/services" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
52         By using this data you are agreeing to the terms of use http://DataSF.org/page.php?page=TOU&nbsp;
53        <request id="507356" type="Street and Sidewalk Cleaning" date="2009-09-18" time="00:43:56"     address="6TH ST and FOLSOM ST" lon="-122.4056155" lat="37.778505123" district="6" /> 
54       <request id="507355" type="Sewer Issues" date="2009-09-18" time="00:11:24" address="26TH ST and DOLORES ST" lon="-122.4248449" lat="37.748632521" district="8" /> 
55 </Sf311ServiceRequests>
56
57 **********Terms of Service:**********
58 1. By using this data you are agreeing to the terms of use http://DataSF.org/page.php?page=TOU
59 2. Only make requests that are necessary by setting request type, start and end dates correctly. Note that 311 requests are retrieved from  tables that only keep data up to 90 days prior to the current date
60 3. In case of any error while using the service "Contact Us" on http://datasf.org
61
62

http://apps.sfgov.org/datafiles//311/webservice.txt