]> pere.pagekite.me Git - homepage.git/blob - blog/Initial_notes_on_adding_Open311_server_API_on_FixMyStreet.html
Generated.
[homepage.git] / blog / Initial_notes_on_adding_Open311_server_API_on_FixMyStreet.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" dir="ltr">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
6 <title>Petter Reinholdtsen: Initial notes on adding Open311 server API on FixMyStreet</title>
7 <link rel="stylesheet" type="text/css" media="screen" href="http://people.skolelinux.org/pere/blog/style.css" />
8 <link rel="stylesheet" type="text/css" media="screen" href="http://people.skolelinux.org/pere/blog/vim.css" />
9
10
11 </head>
12 <body>
13 <div class="title">
14 <h1>
15 <a href="http://people.skolelinux.org/pere/blog/">Petter Reinholdtsen</a>
16
17 </h1>
18
19 </div>
20
21
22 <div class="entry">
23 <div class="title">Initial notes on adding Open311 server API on FixMyStreet</div>
24 <div class="date">29th April 2011</div>
25 <div class="body"><p>The last few days I have spent some time trying to add support for
26 the <a href="http://www.open311.org/">Open311 API</a> in the
27 <a href="http://www.fiksgatami.no/">Norwegian FixMyStreet service</a>.
28 Earlier I believed Open311 would be a useful API to use to submit
29 reports to the municipalities, but when I noticed that the
30 <a href="http://fixmystreet.org.nz/">New Zealand version</a> of
31 FixMyStreet had implemented Open311 on the server side, it occurred to
32 me that this was a nice way to allow the public, press and
33 municipalities to do data mining directly in the FixMyStreet service.
34 Thus I went to work implementing the Open311 specification for
35 FixMyStreet. The implementation is not yet ready, but I am starting
36 to get a draft limping along. In the process, I have discovered a few
37 issues with the Open311 specification.</p>
38
39 <p>One obvious missing feature is the lack of natural language
40 handling in the specification. The specification seem to assume all
41 reports will be written in English, and do not provide a way for the
42 receiving end to specify which languages are understood there. To be
43 able to use the same client and submit to several Open311 receivers,
44 it would be useful to know which language to use when writing reports.
45 I believe the specification should be extended to allow the receivers
46 of problem reports to specify which language they accept, and the
47 submitter to specify which language the report is written in.
48 Language of a text can also be automatically guessed using statistical
49 methods, but for multi-lingual persons like myself, it is useful to
50 know which language to use when writing a problem report. I suspect
51 some lang=nb,nn kind of attribute would solve it.</p>
52
53 <p>A key part of the Open311 API is the list of services provided,
54 which is similar to the categories used by FixMyStreet. One issue I
55 run into is the need to specify both name and unique identifier for
56 each category. The specification do not state that the identifier
57 should be numeric, but all example implementations have used numbers
58 here. In FixMyStreet, there is no number associated with each
59 category. As the specification do not forbid it, I will use the name
60 as the unique identifier for now and see how open311 clients handle
61 it.</p>
62
63 <p>The report format in open311 and the report format in FixMyStreet
64 differ in a key part. FixMyStreet have a title and a description,
65 while Open311 only have a description and lack the title. I'm not
66 quite sure how to best handle this yet. When asking for a FixMyStreet
67 report in Open311 format, I just merge title an description into the
68 open311 description, but this is not going to work if the open311 API
69 should be used for submitting new reports to FixMyStreet.</p>
70
71 <p>The search feature in Open311 is missing a way to ask for problems
72 near a geographic location. I believe this is important if one is to
73 use Open311 as the query language for mobile units. The specification
74 should be extended to handle this, probably using some new lat=, lon=
75 and range= options.</p>
76
77 <p>The final challenge I see is that the FixMyStreet code handle
78 several administrations in one interface, while the Open311 API seem
79 to assume only one administration. For FixMyStreet, this mean a
80 report can be sent to several administrations, and the categories
81 available depend on the location of the problem. Not quite sure how
82 to best handle this. I've noticed
83 <a href="http://seeclickfix.com/open311/">SeeClickFix</a> added
84 latitude and longitude options to the services request, but it do not
85 solve the problem of what to return when no location is specified.
86 Will have to investigate this a bit more.</p>
87
88 <p>My distaste for web forums have kept me from bringing these issues
89 up with the open311 developer group. I really wish they had a email
90 list available via <a href="http://www.gmane.org/">Gmane</a> to use for
91 discussions instead of only
92 <a href="http://lists.open311.org/groups/discuss">a forum<a/>. Oh,
93 well. That will probably resolve itself, one way or another. I've
94 also tried visiting the IRC channel #open311 on FreeNode, but no-one
95 seem to reply to my questions there. This make me wonder if I just
96 fail to understand how the open311 community work. It sure do not
97 work like the free software project communities I am used to.</p>
98 </div>
99
100 <div class="tags">Tags: <a href="http://people.skolelinux.org/pere/blog/tags/english">english</a>, <a href="http://people.skolelinux.org/pere/blog/tags/fiksgatami">fiksgatami</a>, <a href="http://people.skolelinux.org/pere/blog/tags/open311">open311</a>.</div>
101
102
103 </div>
104
105
106
107
108 <div id="sidebar">
109
110
111
112 <h2>Archive</h2>
113 <ul>
114
115 <li>2016
116 <ul>
117
118 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/01/">January (3)</a></li>
119
120 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/02/">February (2)</a></li>
121
122 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/03/">March (3)</a></li>
123
124 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/04/">April (8)</a></li>
125
126 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/05/">May (8)</a></li>
127
128 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/06/">June (2)</a></li>
129
130 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/07/">July (2)</a></li>
131
132 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/08/">August (5)</a></li>
133
134 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/09/">September (2)</a></li>
135
136 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/10/">October (3)</a></li>
137
138 <li><a href="http://people.skolelinux.org/pere/blog/archive/2016/11/">November (5)</a></li>
139
140 </ul></li>
141
142 <li>2015
143 <ul>
144
145 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/01/">January (7)</a></li>
146
147 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/02/">February (6)</a></li>
148
149 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/03/">March (1)</a></li>
150
151 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/04/">April (4)</a></li>
152
153 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/05/">May (3)</a></li>
154
155 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/06/">June (4)</a></li>
156
157 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/07/">July (6)</a></li>
158
159 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/08/">August (2)</a></li>
160
161 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/09/">September (2)</a></li>
162
163 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/10/">October (9)</a></li>
164
165 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/11/">November (6)</a></li>
166
167 <li><a href="http://people.skolelinux.org/pere/blog/archive/2015/12/">December (3)</a></li>
168
169 </ul></li>
170
171 <li>2014
172 <ul>
173
174 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/01/">January (2)</a></li>
175
176 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/02/">February (3)</a></li>
177
178 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/03/">March (8)</a></li>
179
180 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/04/">April (7)</a></li>
181
182 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/05/">May (1)</a></li>
183
184 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/06/">June (2)</a></li>
185
186 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/07/">July (2)</a></li>
187
188 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/08/">August (2)</a></li>
189
190 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/09/">September (5)</a></li>
191
192 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/10/">October (6)</a></li>
193
194 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/11/">November (3)</a></li>
195
196 <li><a href="http://people.skolelinux.org/pere/blog/archive/2014/12/">December (5)</a></li>
197
198 </ul></li>
199
200 <li>2013
201 <ul>
202
203 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/01/">January (11)</a></li>
204
205 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/02/">February (9)</a></li>
206
207 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/03/">March (9)</a></li>
208
209 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/04/">April (6)</a></li>
210
211 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/05/">May (9)</a></li>
212
213 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/06/">June (10)</a></li>
214
215 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/07/">July (7)</a></li>
216
217 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/08/">August (3)</a></li>
218
219 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/09/">September (5)</a></li>
220
221 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/10/">October (7)</a></li>
222
223 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/11/">November (9)</a></li>
224
225 <li><a href="http://people.skolelinux.org/pere/blog/archive/2013/12/">December (3)</a></li>
226
227 </ul></li>
228
229 <li>2012
230 <ul>
231
232 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/01/">January (7)</a></li>
233
234 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/02/">February (10)</a></li>
235
236 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/03/">March (17)</a></li>
237
238 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/04/">April (12)</a></li>
239
240 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/05/">May (12)</a></li>
241
242 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/06/">June (20)</a></li>
243
244 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/07/">July (17)</a></li>
245
246 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/08/">August (6)</a></li>
247
248 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/09/">September (9)</a></li>
249
250 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/10/">October (17)</a></li>
251
252 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/11/">November (10)</a></li>
253
254 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/12/">December (7)</a></li>
255
256 </ul></li>
257
258 <li>2011
259 <ul>
260
261 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/01/">January (16)</a></li>
262
263 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/02/">February (6)</a></li>
264
265 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/03/">March (6)</a></li>
266
267 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/04/">April (7)</a></li>
268
269 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/05/">May (3)</a></li>
270
271 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/06/">June (2)</a></li>
272
273 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/07/">July (7)</a></li>
274
275 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/08/">August (6)</a></li>
276
277 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/09/">September (4)</a></li>
278
279 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/10/">October (2)</a></li>
280
281 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/11/">November (3)</a></li>
282
283 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/12/">December (1)</a></li>
284
285 </ul></li>
286
287 <li>2010
288 <ul>
289
290 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/01/">January (2)</a></li>
291
292 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/02/">February (1)</a></li>
293
294 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/03/">March (3)</a></li>
295
296 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/04/">April (3)</a></li>
297
298 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/05/">May (9)</a></li>
299
300 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/06/">June (14)</a></li>
301
302 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/07/">July (12)</a></li>
303
304 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/08/">August (13)</a></li>
305
306 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/09/">September (7)</a></li>
307
308 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/10/">October (9)</a></li>
309
310 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/11/">November (13)</a></li>
311
312 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/12/">December (12)</a></li>
313
314 </ul></li>
315
316 <li>2009
317 <ul>
318
319 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/01/">January (8)</a></li>
320
321 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/02/">February (8)</a></li>
322
323 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/03/">March (12)</a></li>
324
325 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/04/">April (10)</a></li>
326
327 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/05/">May (9)</a></li>
328
329 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/06/">June (3)</a></li>
330
331 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/07/">July (4)</a></li>
332
333 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/08/">August (3)</a></li>
334
335 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/09/">September (1)</a></li>
336
337 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/10/">October (2)</a></li>
338
339 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/11/">November (3)</a></li>
340
341 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/12/">December (3)</a></li>
342
343 </ul></li>
344
345 <li>2008
346 <ul>
347
348 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/11/">November (5)</a></li>
349
350 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/12/">December (7)</a></li>
351
352 </ul></li>
353
354 </ul>
355
356
357
358 <h2>Tags</h2>
359 <ul>
360
361 <li><a href="http://people.skolelinux.org/pere/blog/tags/3d-printer">3d-printer (13)</a></li>
362
363 <li><a href="http://people.skolelinux.org/pere/blog/tags/amiga">amiga (1)</a></li>
364
365 <li><a href="http://people.skolelinux.org/pere/blog/tags/aros">aros (1)</a></li>
366
367 <li><a href="http://people.skolelinux.org/pere/blog/tags/bankid">bankid (4)</a></li>
368
369 <li><a href="http://people.skolelinux.org/pere/blog/tags/bitcoin">bitcoin (9)</a></li>
370
371 <li><a href="http://people.skolelinux.org/pere/blog/tags/bootsystem">bootsystem (16)</a></li>
372
373 <li><a href="http://people.skolelinux.org/pere/blog/tags/bsa">bsa (2)</a></li>
374
375 <li><a href="http://people.skolelinux.org/pere/blog/tags/chrpath">chrpath (2)</a></li>
376
377 <li><a href="http://people.skolelinux.org/pere/blog/tags/debian">debian (139)</a></li>
378
379 <li><a href="http://people.skolelinux.org/pere/blog/tags/debian edu">debian edu (157)</a></li>
380
381 <li><a href="http://people.skolelinux.org/pere/blog/tags/digistan">digistan (10)</a></li>
382
383 <li><a href="http://people.skolelinux.org/pere/blog/tags/dld">dld (16)</a></li>
384
385 <li><a href="http://people.skolelinux.org/pere/blog/tags/docbook">docbook (23)</a></li>
386
387 <li><a href="http://people.skolelinux.org/pere/blog/tags/drivstoffpriser">drivstoffpriser (4)</a></li>
388
389 <li><a href="http://people.skolelinux.org/pere/blog/tags/english">english (332)</a></li>
390
391 <li><a href="http://people.skolelinux.org/pere/blog/tags/fiksgatami">fiksgatami (23)</a></li>
392
393 <li><a href="http://people.skolelinux.org/pere/blog/tags/fildeling">fildeling (12)</a></li>
394
395 <li><a href="http://people.skolelinux.org/pere/blog/tags/freeculture">freeculture (29)</a></li>
396
397 <li><a href="http://people.skolelinux.org/pere/blog/tags/freedombox">freedombox (9)</a></li>
398
399 <li><a href="http://people.skolelinux.org/pere/blog/tags/frikanalen">frikanalen (18)</a></li>
400
401 <li><a href="http://people.skolelinux.org/pere/blog/tags/h264">h264 (20)</a></li>
402
403 <li><a href="http://people.skolelinux.org/pere/blog/tags/intervju">intervju (42)</a></li>
404
405 <li><a href="http://people.skolelinux.org/pere/blog/tags/isenkram">isenkram (13)</a></li>
406
407 <li><a href="http://people.skolelinux.org/pere/blog/tags/kart">kart (19)</a></li>
408
409 <li><a href="http://people.skolelinux.org/pere/blog/tags/ldap">ldap (9)</a></li>
410
411 <li><a href="http://people.skolelinux.org/pere/blog/tags/lenker">lenker (8)</a></li>
412
413 <li><a href="http://people.skolelinux.org/pere/blog/tags/lsdvd">lsdvd (2)</a></li>
414
415 <li><a href="http://people.skolelinux.org/pere/blog/tags/ltsp">ltsp (1)</a></li>
416
417 <li><a href="http://people.skolelinux.org/pere/blog/tags/mesh network">mesh network (8)</a></li>
418
419 <li><a href="http://people.skolelinux.org/pere/blog/tags/multimedia">multimedia (39)</a></li>
420
421 <li><a href="http://people.skolelinux.org/pere/blog/tags/nice free software">nice free software (8)</a></li>
422
423 <li><a href="http://people.skolelinux.org/pere/blog/tags/norsk">norsk (281)</a></li>
424
425 <li><a href="http://people.skolelinux.org/pere/blog/tags/nuug">nuug (182)</a></li>
426
427 <li><a href="http://people.skolelinux.org/pere/blog/tags/offentlig innsyn">offentlig innsyn (26)</a></li>
428
429 <li><a href="http://people.skolelinux.org/pere/blog/tags/open311">open311 (2)</a></li>
430
431 <li><a href="http://people.skolelinux.org/pere/blog/tags/opphavsrett">opphavsrett (61)</a></li>
432
433 <li><a href="http://people.skolelinux.org/pere/blog/tags/personvern">personvern (95)</a></li>
434
435 <li><a href="http://people.skolelinux.org/pere/blog/tags/raid">raid (1)</a></li>
436
437 <li><a href="http://people.skolelinux.org/pere/blog/tags/reactos">reactos (1)</a></li>
438
439 <li><a href="http://people.skolelinux.org/pere/blog/tags/reprap">reprap (11)</a></li>
440
441 <li><a href="http://people.skolelinux.org/pere/blog/tags/rfid">rfid (3)</a></li>
442
443 <li><a href="http://people.skolelinux.org/pere/blog/tags/robot">robot (10)</a></li>
444
445 <li><a href="http://people.skolelinux.org/pere/blog/tags/rss">rss (1)</a></li>
446
447 <li><a href="http://people.skolelinux.org/pere/blog/tags/ruter">ruter (4)</a></li>
448
449 <li><a href="http://people.skolelinux.org/pere/blog/tags/scraperwiki">scraperwiki (2)</a></li>
450
451 <li><a href="http://people.skolelinux.org/pere/blog/tags/sikkerhet">sikkerhet (52)</a></li>
452
453 <li><a href="http://people.skolelinux.org/pere/blog/tags/sitesummary">sitesummary (4)</a></li>
454
455 <li><a href="http://people.skolelinux.org/pere/blog/tags/skepsis">skepsis (5)</a></li>
456
457 <li><a href="http://people.skolelinux.org/pere/blog/tags/standard">standard (49)</a></li>
458
459 <li><a href="http://people.skolelinux.org/pere/blog/tags/stavekontroll">stavekontroll (4)</a></li>
460
461 <li><a href="http://people.skolelinux.org/pere/blog/tags/stortinget">stortinget (10)</a></li>
462
463 <li><a href="http://people.skolelinux.org/pere/blog/tags/surveillance">surveillance (43)</a></li>
464
465 <li><a href="http://people.skolelinux.org/pere/blog/tags/sysadmin">sysadmin (2)</a></li>
466
467 <li><a href="http://people.skolelinux.org/pere/blog/tags/usenix">usenix (2)</a></li>
468
469 <li><a href="http://people.skolelinux.org/pere/blog/tags/valg">valg (8)</a></li>
470
471 <li><a href="http://people.skolelinux.org/pere/blog/tags/video">video (59)</a></li>
472
473 <li><a href="http://people.skolelinux.org/pere/blog/tags/vitenskap">vitenskap (4)</a></li>
474
475 <li><a href="http://people.skolelinux.org/pere/blog/tags/web">web (38)</a></li>
476
477 </ul>
478
479
480 </div>
481 <p style="text-align: right">
482 Created by <a href="http://steve.org.uk/Software/chronicle">Chronicle v4.6</a>
483 </p>
484
485 </body>
486 </html>