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   </head>
  10   <body>
  11     <div class="title">
  12  <h1>
  13      <a href="http://people.skolelinux.org/pere/blog/">Petter Reinholdtsen</a>
  14
  15  </h1>
  16
  17 </div>
  18
  19
  20     <div class="entry">
  21       <div class="title">Initial notes on adding Open311 server API on FixMyStreet</div>
  22       <div class="date">29th April 2011</div>
  23       <div class="body"><p>The last few days I have spent some time trying to add support for
  24 the <a href="http://www.open311.org/">Open311 API</a> in the
  25 <a href="http://www.fiksgatami.no/">Norwegian FixMyStreet service</a>.
  26 Earlier I believed Open311 would be a useful API to use to submit
  27 reports to the municipalities, but when I noticed that the
  28 <a href="http://fixmystreet.org.nz/">New Zealand version</a> of
  29 FixMyStreet had implemented Open311 on the server side, it occurred to
  30 me that this was a nice way to allow the public, press and
  31 municipalities to do data mining directly in the FixMyStreet service.
  32 Thus I went to work implementing the Open311 specification for
  33 FixMyStreet.  The implementation is not yet ready, but I am starting
  34 to get a draft limping along.  In the process, I have discovered a few
  35 issues with the Open311 specification.</p>
  36
  37 <p>One obvious missing feature is the lack of natural language
  38 handling in the specification.  The specification seem to assume all
  39 reports will be written in English, and do not provide a way for the
  40 receiving end to specify which languages are understood there.  To be
  41 able to use the same client and submit to several Open311 receivers,
  42 it would be useful to know which language to use when writing reports.
  43 I believe the specification should be extended to allow the receivers
  44 of problem reports to specify which language they accept, and the
  45 submitter to specify which language the report is written in.
  46 Language of a text can also be automatically guessed using statistical
  47 methods, but for multi-lingual persons like myself, it is useful to
  48 know which language to use when writing a problem report.  I suspect
  49 some lang=nb,nn kind of attribute would solve it.</p>
  50
  51 <p>A key part of the Open311 API is the list of services provided,
  52 which is similar to the categories used by FixMyStreet.  One issue I
  53 run into is the need to specify both name and unique identifier for
  54 each category.  The specification do not state that the identifier
  55 should be numeric, but all example implementations have used numbers
  56 here.  In FixMyStreet, there is no number associated with each
  57 category.  As the specification do not forbid it, I will use the name
  58 as the unique identifier for now and see how open311 clients handle
  59 it.</p>
  60
  61 <p>The report format in open311 and the report format in FixMyStreet
  62 differ in a key part.  FixMyStreet have a title and a description,
  63 while Open311 only have a description and lack the title.  I'm not
  64 quite sure how to best handle this yet.  When asking for a FixMyStreet
  65 report in Open311 format, I just merge title an description into the
  66 open311 description, but this is not going to work if the open311 API
  67 should be used for submitting new reports to FixMyStreet.</p>
  68
  69 <p>The search feature in Open311 is missing a way to ask for problems
  70 near a geographic location.  I believe this is important if one is to
  71 use Open311 as the query language for mobile units.  The specification
  72 should be extended to handle this, probably using some new lat=, lon=
  73 and range= options.</p>
  74
  75 <p>The final challenge I see is that the FixMyStreet code handle
  76 several administrations in one interface, while the Open311 API seem
  77 to assume only one administration.  For FixMyStreet, this mean a
  78 report can be sent to several administrations, and the categories
  79 available depend on the location of the problem.  Not quite sure how
  80 to best handle this.  I've noticed
  81 <a href="http://seeclickfix.com/open311/">SeeClickFix</a> added
  82 latitude and longitude options to the services request, but it do not
  83 solve the problem of what to return when no location is specified.
  84 Will have to investigate this a bit more.</p>
  85
  86 <p>My distaste for web forums have kept me from bringing these issues
  87 up with the open311 developer group.  I really wish they had a email
  88 list available via <a href="http://www.gmane.org/">Gmane</a> to use for
  89 discussions instead of only
  90 <a href="http://lists.open311.org/groups/discuss">a forum<a/>.  Oh,
  91 well.  That will probably resolve itself, one way or another.  I've
  92 also tried visiting the IRC channel #open311 on FreeNode, but no-one
  93 seem to reply to my questions there.  This make me wonder if I just
  94 fail to understand how the open311 community work.  It sure do not
  95 work like the free software project communities I am used to.</p>
  96 </div>
  97
  98       <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>
  99
 100
 101     </div>
 102
 103
 104
 105
 106     <div id="sidebar">
 107
 108
 109
 110 <h2>Archive</h2>
 111 <ul>
 112
 113 <li>2012
 114 <ul>
 115
 116 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/01/">January (7)</a></li>
 117
 118 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/02/">February (10)</a></li>
 119
 120 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/03/">March (17)</a></li>
 121
 122 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/04/">April (12)</a></li>
 123
 124 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/05/">May (12)</a></li>
 125
 126 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/06/">June (20)</a></li>
 127
 128 <li><a href="http://people.skolelinux.org/pere/blog/archive/2012/07/">July (12)</a></li>
 129
 130 </ul></li>
 131
 132 <li>2011
 133 <ul>
 134
 135 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/01/">January (16)</a></li>
 136
 137 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/02/">February (6)</a></li>
 138
 139 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/03/">March (6)</a></li>
 140
 141 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/04/">April (7)</a></li>
 142
 143 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/05/">May (3)</a></li>
 144
 145 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/06/">June (2)</a></li>
 146
 147 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/07/">July (7)</a></li>
 148
 149 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/08/">August (6)</a></li>
 150
 151 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/09/">September (4)</a></li>
 152
 153 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/10/">October (2)</a></li>
 154
 155 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/11/">November (3)</a></li>
 156
 157 <li><a href="http://people.skolelinux.org/pere/blog/archive/2011/12/">December (1)</a></li>
 158
 159 </ul></li>
 160
 161 <li>2010
 162 <ul>
 163
 164 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/01/">January (2)</a></li>
 165
 166 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/02/">February (1)</a></li>
 167
 168 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/03/">March (3)</a></li>
 169
 170 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/04/">April (3)</a></li>
 171
 172 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/05/">May (9)</a></li>
 173
 174 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/06/">June (14)</a></li>
 175
 176 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/07/">July (12)</a></li>
 177
 178 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/08/">August (13)</a></li>
 179
 180 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/09/">September (7)</a></li>
 181
 182 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/10/">October (9)</a></li>
 183
 184 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/11/">November (13)</a></li>
 185
 186 <li><a href="http://people.skolelinux.org/pere/blog/archive/2010/12/">December (12)</a></li>
 187
 188 </ul></li>
 189
 190 <li>2009
 191 <ul>
 192
 193 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/01/">January (8)</a></li>
 194
 195 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/02/">February (8)</a></li>
 196
 197 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/03/">March (12)</a></li>
 198
 199 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/04/">April (10)</a></li>
 200
 201 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/05/">May (9)</a></li>
 202
 203 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/06/">June (3)</a></li>
 204
 205 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/07/">July (4)</a></li>
 206
 207 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/08/">August (3)</a></li>
 208
 209 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/09/">September (1)</a></li>
 210
 211 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/10/">October (2)</a></li>
 212
 213 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/11/">November (3)</a></li>
 214
 215 <li><a href="http://people.skolelinux.org/pere/blog/archive/2009/12/">December (3)</a></li>
 216
 217 </ul></li>
 218
 219 <li>2008
 220 <ul>
 221
 222 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/11/">November (5)</a></li>
 223
 224 <li><a href="http://people.skolelinux.org/pere/blog/archive/2008/12/">December (7)</a></li>
 225
 226 </ul></li>
 227
 228 </ul>
 229
 230
 231
 232 <h2>Tags</h2>
 233 <ul>
 234
 235  <li><a href="http://people.skolelinux.org/pere/blog/tags/3d-printer">3d-printer (13)</a></li>
 236
 237  <li><a href="http://people.skolelinux.org/pere/blog/tags/amiga">amiga (1)</a></li>
 238
 239  <li><a href="http://people.skolelinux.org/pere/blog/tags/aros">aros (1)</a></li>
 240
 241  <li><a href="http://people.skolelinux.org/pere/blog/tags/bitcoin">bitcoin (2)</a></li>
 242
 243  <li><a href="http://people.skolelinux.org/pere/blog/tags/bootsystem">bootsystem (12)</a></li>
 244
 245  <li><a href="http://people.skolelinux.org/pere/blog/tags/bsa">bsa (2)</a></li>
 246
 247  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian">debian (55)</a></li>
 248
 249  <li><a href="http://people.skolelinux.org/pere/blog/tags/debian edu">debian edu (109)</a></li>
 250
 251  <li><a href="http://people.skolelinux.org/pere/blog/tags/digistan">digistan (9)</a></li>
 252
 253  <li><a href="http://people.skolelinux.org/pere/blog/tags/drivstoffpriser">drivstoffpriser (4)</a></li>
 254
 255  <li><a href="http://people.skolelinux.org/pere/blog/tags/english">english (141)</a></li>
 256
 257  <li><a href="http://people.skolelinux.org/pere/blog/tags/fiksgatami">fiksgatami (17)</a></li>
 258
 259  <li><a href="http://people.skolelinux.org/pere/blog/tags/fildeling">fildeling (12)</a></li>
 260
 261  <li><a href="http://people.skolelinux.org/pere/blog/tags/frikanalen">frikanalen (6)</a></li>
 262
 263  <li><a href="http://people.skolelinux.org/pere/blog/tags/intervju">intervju (30)</a></li>
 264
 265  <li><a href="http://people.skolelinux.org/pere/blog/tags/kart">kart (16)</a></li>
 266
 267  <li><a href="http://people.skolelinux.org/pere/blog/tags/ldap">ldap (8)</a></li>
 268
 269  <li><a href="http://people.skolelinux.org/pere/blog/tags/lenker">lenker (4)</a></li>
 270
 271  <li><a href="http://people.skolelinux.org/pere/blog/tags/ltsp">ltsp (1)</a></li>
 272
 273  <li><a href="http://people.skolelinux.org/pere/blog/tags/multimedia">multimedia (22)</a></li>
 274
 275  <li><a href="http://people.skolelinux.org/pere/blog/tags/norsk">norsk (188)</a></li>
 276
 277  <li><a href="http://people.skolelinux.org/pere/blog/tags/nuug">nuug (139)</a></li>
 278
 279  <li><a href="http://people.skolelinux.org/pere/blog/tags/offentlig innsyn">offentlig innsyn (4)</a></li>
 280
 281  <li><a href="http://people.skolelinux.org/pere/blog/tags/open311">open311 (2)</a></li>
 282
 283  <li><a href="http://people.skolelinux.org/pere/blog/tags/opphavsrett">opphavsrett (32)</a></li>
 284
 285  <li><a href="http://people.skolelinux.org/pere/blog/tags/personvern">personvern (48)</a></li>
 286
 287  <li><a href="http://people.skolelinux.org/pere/blog/tags/raid">raid (1)</a></li>
 288
 289  <li><a href="http://people.skolelinux.org/pere/blog/tags/reprap">reprap (11)</a></li>
 290
 291  <li><a href="http://people.skolelinux.org/pere/blog/tags/rfid">rfid (2)</a></li>
 292
 293  <li><a href="http://people.skolelinux.org/pere/blog/tags/robot">robot (4)</a></li>
 294
 295  <li><a href="http://people.skolelinux.org/pere/blog/tags/rss">rss (1)</a></li>
 296
 297  <li><a href="http://people.skolelinux.org/pere/blog/tags/ruter">ruter (4)</a></li>
 298
 299  <li><a href="http://people.skolelinux.org/pere/blog/tags/scraperwiki">scraperwiki (2)</a></li>
 300
 301  <li><a href="http://people.skolelinux.org/pere/blog/tags/sikkerhet">sikkerhet (23)</a></li>
 302
 303  <li><a href="http://people.skolelinux.org/pere/blog/tags/sitesummary">sitesummary (4)</a></li>
 304
 305  <li><a href="http://people.skolelinux.org/pere/blog/tags/skepsis">skepsis (1)</a></li>
 306
 307  <li><a href="http://people.skolelinux.org/pere/blog/tags/standard">standard (35)</a></li>
 308
 309  <li><a href="http://people.skolelinux.org/pere/blog/tags/stavekontroll">stavekontroll (1)</a></li>
 310
 311  <li><a href="http://people.skolelinux.org/pere/blog/tags/stortinget">stortinget (4)</a></li>
 312
 313  <li><a href="http://people.skolelinux.org/pere/blog/tags/surveillance">surveillance (10)</a></li>
 314
 315  <li><a href="http://people.skolelinux.org/pere/blog/tags/valg">valg (6)</a></li>
 316
 317  <li><a href="http://people.skolelinux.org/pere/blog/tags/video">video (32)</a></li>
 318
 319  <li><a href="http://people.skolelinux.org/pere/blog/tags/vitenskap">vitenskap (1)</a></li>
 320
 321  <li><a href="http://people.skolelinux.org/pere/blog/tags/web">web (25)</a></li>
 322
 323 </ul>
 324
 325
 326     </div>
 327     <p style="text-align: right">
 328  Created by <a href="http://steve.org.uk/Software/chronicle">Chronicle v4.4</a>
 329 </p>
 330
 331   </body>
 332 </html>