1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
[% INCLUDE 'header.html', title => 'Open311' %]
<h1>[% loc('Open311 API for the mySociety FixMyStreet server') %]</h1>
[% IF error %]
<p>[% tprintf( loc('Note: <strong>%s</strong>'), error ) %]</p>
[% END %]
<p>[% loc('At the moment only searching for and looking at reports work.') %]</p>
<p>[% loc('This API implementation is work in progress and not yet stabilized. It will change without warnings in the future.') %]</p>
<ul>
<li><a rel="nofollow" href="http://www.open311.org/">[% loc('Open311 initiative web page') %]</a></li>
<li><a rel="nofollow" href="http://wiki.open311.org/GeoReport_v2">[% loc('Open311 specification') %]</a></li>
</ul>
<p>[% tprintf( loc('At most %d requests are returned in each query. The returned requests are ordered by requested_datetime, so to get all requests, do several searches with rolling start_date and end_date.'), c.config.OPEN311_LIMIT ) %]</p>
<p>[% loc('The following Open311 v2 attributes are returned for each request: service_request_id, description, lat, long, media_url, status, requested_datetime, updated_datetime, service_code and service_name.') %]</p>
<p>[% loc('In addition, the following attributes that are not part of the Open311 v2 specification are returned: agency_sent_datetime, title (also returned as part of description), interface_used, comment_count, requestor_name (only present if requestor allowed the name to be shown on this site).') %]</p>
<p>[% loc('The Open311 v2 attribute agency_responsible is used to list the administrations that received the problem report, which is not quite the way the attribute is defined in the Open311 v2 specification.') %]</p>
<p>[% tprintf( loc('With request searches, it is also possible to search for agency_responsible to limit the requests to those sent to a single administration. The search term is the administration ID provided by <a href="%s">MaPit</a>.'), c.config.MAPIT_URL ) %]</p>
<p>[% loc('Examples:') %]</p>
<ul>
[% jurisdiction_id = 'fixamingata.se' %]
[% examples = [
{
url = c.cobrand.base_url _ "/open311/v2/discovery.xml?jurisdiction_id=$jurisdiction_id",
info = 'discovery-information',
},
{
url = c.cobrand.base_url _ "/open311/v2/services.xml?jurisdiction_id=$jurisdiction_id",
info = 'Lista alla feltyper, t ex Trasig lampa, hål i gatan osv',
},
{
url = c.cobrand.base_url _ "/open311/v2/services.xml?jurisdiction_id=$jurisdiction_id&lat=59&long=18",
info = 'Lista feltyper för WGS84 koordinater latityd 59 longityd 18',
},
{
url = c.cobrand.base_url _ "/open311/v2/requests/1.xml?jurisdiction_id=$jurisdiction_id",
info = 'Felrapport nummer 1',
},
{
url = c.cobrand.base_url _ "/open311/v2/requests.xml?jurisdiction_id=$jurisdiction_id&status=open&agency_responsible=37&end_date=2013-04-10",
info = 'Alla öppna felrapporter innan 2013-04-10 för Stockholm (kommun-id 37)',
},
{
url = c.cobrand.base_url _ "/open311/v2/requests.xml?jurisdiction_id=$jurisdiction_id&status=open&agency_responsible=37|38",
info = 'Alla öppna felrapporter för Stockholm (id 37) och Järfälla (id 38)',
},
{
url = c.cobrand.base_url _ "/open311/v2/requests.xml?jurisdiction_id=$jurisdiction_id&service_code=Hål i gatan",
info = "Alla felrapporter av typen 'Hål i gatan'",
},
{
url = c.cobrand.base_url _ "/open311/v2/requests.xml?jurisdiction_id=$jurisdiction_id&status=closed",
info = 'Alla stängda felrapporter',
},
] %]
[% FOREACH examples %]
<li><a href="[% url %]">[% info %]</a>
<br>[% url | html %]</li>
[% END %]
</ul>
<h2>Searching</h2>
<p>The following search parameters can be used:</p>
<dl>
<dt>service_request_id</dt>
<dd>Search for numeric ID of specific request.
Using this is identical to asking for a individual request using
the /requests/number.format URL.</dd>
<dt>service_code</dt>
<dd>Search for the given category / service type string.</dd>
<dt>status</dt>
<dd>Search for open or closed (fixed) requests.</dd>
<dt>start_date<dt>
<dd>Only return requests with requested_datetime set after or at the
date and time specified. The format is YYYY-MM-DDTHH:MM:SS+TZ:TZ.</dd>
<dt>end_date<dt>
<dd>Only return requests with requested_datetime set before the date
and time specified. Same format as start_date.</dd>
<dt>agency_responsible</dt>
<dd>ID of government body receiving the request. Several IDs can be
specified with | as a separator.</dd>
<dt>interface_used<dt>
<dd>Name / identifier of interface used.</dd>
<dt>has_photo<dt>
<dd>Search for entries with or without photos. Use value 'true' to
only get requests created with images, and 'false' to get those
created without images.</dd>
<dt>max_requests</dt>
<dd>Max number of requests to return from the search. If it is larger
than the site specific max_requests value specified in the discovery
call, the value provided is ignored.</dd>
<dl>
<p>The search result might look like this:</p>
<pre>[% "
<requests>
<request>
<agency_responsible>
<recipient>Stockholm</recipient>
</agency_responsible>
<agency_sent_datetime>2012-11-16T10:35:12,534712Z</agency_sent_datetime>
<description>Test: Test</description>
<detail>Test</detail>
<interface_used>Web interface</interface_used>
<lat>59.336044310435</lat>
<long>18.05058735521</long>
<requested_datetime>2012-11-16T10:31:30,702990Z</requested_datetime>
<requestor_name>Jonas Öberg</requestor_name>
<service_code>Trasig gatubelysning</service_code>
<service_name>Trasig gatubelysning</service_name>
<service_request_id>10</service_request_id>
<status>open</status>
<title>Test</title>
<updated_datetime>2012-11-16T10:35:12,534712Z</updated_datetime>
</request>
</requests>
" | html %]</pre>
[% INCLUDE 'footer.html' %]
|
