-
Notifications
You must be signed in to change notification settings - Fork 1
/
ReportApi.htm
2385 lines (2372 loc) · 106 KB
/
ReportApi.htm
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Open311 v.Future</title>
<link rel="stylesheet" href="http://open311.org/wp-content/themes/open311/css/tripoli.visual.css" />
<link rel="stylesheet" href="http://open311.org/wp-content/themes/open311/css/tripoli.type.css" />
<link href="http://open311.org/wp-content/themes/open311/css/tripoli.base.css" rel="stylesheet" media="all" />
<link rel="stylesheet" href="http://wiki.open311.org/skins/open311/main.css?270" media="screen" />
<style>
@import url( http://open311.org/wp-content/themes/open311/style.css?v=2 );
html {
background: #fff;
}
body {
background: #fff;
padding: 0 2em 2em;
}
.change {
padding: 15px;
margin-bottom: 20px;
border: 1px solid transparent;
border-radius: 4px;
color: #a94442;
background-color: #f2dede;
border-color: #ebccd1;
margin-bottom: 0;
}
tr.change-add > td,
span.change-add
{
background-color: #f2dede !important;
}
tr.change-update > td,
span.change-update {
background-color: #fcf8e3 !important;
}
.strikethrough
{
text-decoration: line-through;
}
.intro
{
background: #f5f5f5;
border-bottom: 1px solid #ccc;
margin: 0 -2em;
padding: 1em 2em 2em;
}
.intro h1 {
border-bottom: 0;
font-size: 36px;
line-height: 1.1;
margin-bottom: 0.2em;
}
.intro p {
font-size: 16px;
font-weight: 200;
line-height: 1.4;
}
p {
margin: 0 0 10px;
}
.content > h2:first-child {
margin-top: 1em;
}
.intro .change
{
margin: 0;
padding: 2px;
}
</style>
</head>
<body>
<div class="intro">
<h1>Open311 Reporting API</h1>
<p>This document includes suggested changes to the Open311 GeoReport v2 API to make it a more generic <em>report it</em> API for government.</p>
<p>Changes are highlighted in <span class="change">red</span>. Within the API Methods section new attributes or elements are highlighted with a <span class="change-add">red background</span>. Updates to existing elements are highlighted with a <span class="change-update">yellow background</span>.</p>
</div>
<div class="content">
<h2>API</h2>
<div id="bodyContent">
<h3 id="siteSub">Collaboration for an Open311 Standard</h3>
<p>
The GeoReport API v2 allows developers to build applications to both view and report issues which government entities like cities are responsible for addressing. These interactions are often referred to as "service requests" or "calls for service" and have traditionally been handled by custom web forms or phone based call centers (sometimes using the 311 phone number or other short-code). The GeoReport API is designed to allow both government and third party developers to create new applications and technologies that can integrate directly with these same official contact centers in any government that supports the standard. The current specification is focused on location-based non-emergency issues such as graffiti, potholes, and street cleaning.
</p><p>
The API consists of two main kinds of resources: <span class="strict-value">services</span> and service <span class="strict-value">requests</span>, but some servers that can't generate a realtime service request may also rely on a <span class="strict-value">token</span> resource. In total there are six methods used to interact with these resources: GET services, GET a service definition (a specific service_code id), POST a request, GET requests, GET a request (a specific service_request_id). The documentation below (starting from the API Methods section) is ordered based on a common sequence of interactions where a person first sees a list of available service types, selects one and creates a new service request, and then is able to track the status of that request and other requests. However each method can be accessed independently and some applications may only be focused on querying existing service requests to do analytics.
</p>
<h2> <span class="mw-headline" id="Service_Discovery">Service Discovery</span></h2>
<p>
GeoReport v2 and subsequent Open311 APIs are also required to have a standard service discovery file associated with them to provide routing between versions and types of APIs. See the <a href="/Service_Discovery" title="Service Discovery">Service Discovery</a> page for details of the specification.
</p>
<h2> <span class="mw-headline" id="Internationalization_and_Encoding">Internationalization and Encoding</span></h2>
<h3> <span class="mw-headline" id="Date.2Ftime_format"> Date/time format </span></h3>
<p>
All date/time fields must be formatted in a common subset of ISO 8601 as per the <a href="http://www.w3.org/TR/NOTE-datetime" class="external text" rel="nofollow">w3 note</a>.
Timezone information (either Z meaning UTC, or an HH:MM offset from UTC) <b>must</b> be included.
</p><p>
Examples:
</p>
<ul>
<li>
1994-11-05T08:15:30-05:00 corresponds to November 5, 1994, 8:15:30 am, US Eastern Standard Time.
</li>
<li>
1994-11-05T13:15:30Z corresponds to the same instant.
</li>
</ul>
<h3> <span class="mw-headline" id="Encoding">Encoding</span></h3>
<p>
UTF-8 is required everywhere.
</p><p>
All text returned by the service, whether in XML, JSON, or any other text-based content-type, MUST be encoded as UTF-8. Appropriate HTTP headers must be set, and the root element must be preceded with the XML declaration including the encoding="UTF-8" attribute. All text received by the service from the client will be assumed to be UTF-8 and must be decoded accordingly. Examples of the HTTP content-type headers for each format are shown below under Format Support.
</p>
<h2> <span class="mw-headline" id="Format_Support">Format Support</span></h2>
<p>
XML is a required format, but JSON can be provided at the discretion of the API provider. The output formats supported by the provider are indicated through the <a href="/Service_Discovery" title="Service Discovery">Service Discovery</a> formats field for the API endpoint being used. The client can specify the desired format by appending the format name to the resource. For example a GET request to /services.xml for text/xml output from the services resource and /services/01.json for application/json (<a href="http://www.ietf.org/rfc/rfc4627.txt" class="external text" rel="nofollow">RFC 4627</a>) output for a specific service definition.
</p><p>
The HTTP content-type headers should look like this for each format:
</p><p>
<b>POST Service Request:</b>
Content-Type: application/x-www-form-urlencoded; charset=utf-8
</p><p>
<b>XML:</b>
Content-Type: text/xml; charset=utf-8
</p><p>
<b>JSON:</b>
Content-Type: application/json; charset=utf-8
</p>
<h3> <span class="mw-headline" id="XML_Support">XML Support</span></h3>
<p>
XML for the API should be Content-Type: text/xml. The XML output currently defined is schemaless and without a namespace declaration. For now, extending the output with additional namespaces should be done at your own risk. To guarantee that all clients can support the XML output, it is recommended that you adhere to the specification strictly and do not include foreign tags or namespaces. It is also assumed that the default namespace is not specified, but if it must be specified, the XMLNS URI is the URL of the specification: <a href="http://wiki.open311.org/GeoReport_v2" class="external free" rel="nofollow">http://wiki.open311.org/GeoReport_v2</a>
</p>
<h3> <span class="mw-headline" id="JSON_Support">JSON Support</span></h3>
<p>
JSON for the API should be Content-Type: application/json. JSON support is based on a programmatic mapping of the XML format using the <a href="http://wiki.open311.org/JSON_and_XML_Conversion#The_Spark_Convention" class="external text" rel="nofollow">Spark Convention</a>. This means that if you have an XML file, you can easily generate the JSON version with XSL. This can be done using a server side XSLT (<a href="http://sandbox.georeport.org/tools/sparkjson/xml2json_spark_php.txt" class="external text" rel="nofollow">php example</a>).
</p>
<div class="change">
The service should also support content negotiation using the Accept HTTP header for extenionless URLs.
</div>
<h2> <span class="mw-headline" id="Definitions">Definitions</span></h2>
<h4> <span class="mw-headline" id="jurisdiction_id">jurisdiction_id</span></h4>
<p>
As a means to allow this API to distinguish multiple jurisdictions within one API endpoint we've included a "jurisdiction_id" which will be the unique identifier for cities. It has been suggested that we use the jurisdiction's main website root url (without the www) as the "jurisdiction_id". For San Francisco, the jurisdiction_id is sfgov.org. Implementations can ignore this parameter and treat it as an "Optional Argument" if the implementation only serves one jurisdiction.
</p>
<h4> <span class="mw-headline" id="Optional_Arguments">Optional Arguments</span></h4>
<p>
"Optional" means that the response should be the same whether a parameter is passed and is empty or is not passed at all. A null parameter should be treated as equivalent to a non-declared parameter in processing the request.
</p>
<h2> <span class="mw-headline" id="API_methods">API methods</span></h2>
<h3> <span class="mw-headline" id="GET_Service_List">GET Service List</span></h3>
<table class="method-table">
<tbody>
<tr>
<th scope="row">
Purpose
</th>
<td>
provide a list of acceptable 311 service request types and their associated service codes. These request types can be unique to the city/jurisdiction.
</td>
</tr>
<tr>
<th scope="row">
URL
</th>
<td>
https://[API endpoint]/services.[format]
</td>
</tr>
<tr>
<th scope="row">
Sample URL
</th>
<td>
https://api.city.gov/dev/v2/services.xml?jurisdiction_id=city.gov
</td>
</tr>
<tr>
<th scope="row">
Formats
</th>
<td>
XML (JSON available if denoted by <a href="/Service_Discovery" title="Service Discovery">Service Discovery</a>)
</td>
</tr>
<tr>
<th scope="row">
HTTP Method
</th>
<td>
GET
</td>
</tr>
<tr>
<th scope="row">
Requires API Key
</th>
<td>
No
</td>
</tr>
</tbody>
</table>
<p>
<br>
</p>
<h4> <span class="mw-headline" id="Required_Arguments">Required Arguments</span></h4>
<table class="spec-table arguments-table">
<tbody>
<tr>
<th>
Field Name
</th>
<th class="spec-description">
Description
</th>
<th class="spec-requirements">
Notes & Requirements
</th>
</tr>
<tr>
<td class="field">
<dl>
<dt>
jurisdiction_id
</dt>
</dl>
</td>
<td></td>
<td>
<span style="color: red">This is only required if the endpoint serves multiple jurisdictions</span>
</td>
</tr>
</tbody>
</table>
<h4> <span class="mw-headline" id="Response">Response</span></h4>
<table class="spec-table">
<tbody>
<tr>
<th>
Field Name
</th>
<th class="spec-description">
Description
</th>
<th class="spec-requirements">
Notes & Requirements
</th>
</tr>
<tr>
<th colspan="3" class="response-container">
services ⇊
</th>
</tr>
<tr>
<th colspan="3" class="response-container">
service ↴
</th>
</tr>
<tr>
<td class="field">
<dl>
<dt>
service_code
</dt>
</dl>
</td>
<td>
The unique identifier for the service request type
</td>
<td></td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
service_name
</dt>
</dl>
</td>
<td>
The human readable name of the service request type
</td>
<td></td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
description
</dt>
</dl>
</td>
<td>
A brief description of the service request type.
</td>
<td></td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
metadata
</dt>
</dl>
</td>
<td>
Determines whether there are additional form fields for this service type.
<ul>
<li>
<span class="strict-value">true</span>: This service request type requires additional metadata so the client will need to make a call to the <a href="#GET_Service_Definition">Service Definition</a> method.
</li>
<li>
<span class="strict-value">false</span>: No additional information is required and a call to the <a href="#GET_Service_Definition">Service Definition</a> method is not needed.
</li>
</ul>
</td>
<td>
Possible values: <span class="strict-value">true</span>, <span class="strict-value">false</span>.
</td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
type
</dt>
</dl>
</td>
<td>
<ul>
<li>
<span class="strict-value">realtime</span>: The service request ID will be returned immediately after the service request is submitted.
</li>
<li>
<span class="strict-value">batch</span>: A token will be returned immediately after the service request is submitted. This token can then be later used to return the service request ID.
</li>
<li>
<span class="strict-value">blackbox</span>: No service request ID will be returned after the service request is submitted
</li>
</ul>
</td>
<td>
Possible values: <span class="strict-value">realtime</span>, <span class="strict-value">batch</span>, <span class="strict-value">blackbox</span>.
</td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
keywords
</dt>
</dl>
</td>
<td>
A comma separated list of tags or keywords to help users identify the request type. This can provide synonyms of the service_name and group.
</td>
<td></td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
group
</dt>
</dl>
</td>
<td>
A category to group this service type within. This provides a way to group several service request types under one category such as "sanitation"
</td>
<td></td>
</tr>
<tr class="change-add">
<td class="field">
<dl>
<dt>
customer_required
</dt>
</dl>
</td>
<td>
A category to group this service type within. This provides a way to group several service request types under one category such as "sanitation"
</td>
<td>
Possible values: <span class="strict-value">required</span>, <span class="strict-value">optional</span>, <span class="strict-value">not_required</span>.
</td>
</tr>
<tr class="change-add">
<td class="field">
<dl>
<dt>
location_required
</dt>
</dl>
</td>
<td>
A category to group this service type within. This provides a way to group several service request types under one category such as "sanitation"
</td>
<td>
Possible values: <span class="strict-value">required</span>, <span class="strict-value">not_required</span>.
</td>
</tr>
<tr class="change-add">
<td class="field">
<dl>
<dt>
location_type
</dt>
</dl>
</td>
<td>
The type of location that should be provided:
<ul>
<li>
<span class="strict-value">any</span>: Any of the following types.
</li>
<li>
<span class="strict-value">residential</span>: A residential property UPRN as defined in the LLPG or text in the address_string.
</li>
<li>
<span class="strict-value">commercial</span>: A commercial property UPRN as defined in the LLPG or text in the address_string.
</li>
<li>
<span class="strict-value">street</span>: A USRN or text in the address_string.
</li>
<li>
<span class="strict-value">point</span>: A point e.g. long/lat
</li>
</ul>
</td>
<td>
Possible values: <span class="strict-value">any</span>, <span class="strict-value">residential</span>, <span class="strict-value">commercial</span>, <span class="strict-value">street</span>, <span class="strict-value">point</span>.
</td>
</tr>
</tbody>
</table>
<h4> <span class="mw-headline" id="Possible_Errors">Possible Errors</span></h4>
<p>
The numbers represent the HTTP status code returned for each error type:
</p>
<ul>
<li>
404 - jurisdiction_id provided was not found (specify in error response)
</li>
<li>
400 - jurisdiction_id was not provided (specify in error response)
</li>
<li>
400 - General service error (Anything that fails during service list processing. The client will need to notify us)
</li>
</ul>
<h3> <span class="mw-headline" id="GET_Service_Definition">GET Service Definition</span></h3>
<table class="method-table">
<tbody>
<tr>
<th scope="row">
Conditional
</th>
<td>
Yes - <span style="font-weight : bold; color: red">This call is only necessary if the Service selected has metadata set as <i>true</i> from the <i>GET Services</i> response</span>
</td>
</tr>
<tr>
<th scope="row">
Purpose
</th>
<td>
Define attributes associated with a service code. These attributes can be unique to the city/jurisdiction.
</td>
</tr>
<tr>
<th scope="row">
URL
</th>
<td>
https://[API endpoint]/services/[service_code].[format]
</td>
</tr>
<tr>
<th scope="row">
Sample URL
</th>
<td>
https://api.city.gov/dev/v2/services/033.xml?jurisdiction_id=city.gov
</td>
</tr>
<tr>
<th scope="row">
Formats
</th>
<td>
XML (JSON available if denoted by <a href="/Service_Discovery" title="Service Discovery">Service Discovery</a>)
</td>
</tr>
<tr>
<th scope="row">
HTTP Method
</th>
<td>
GET
</td>
</tr>
<tr>
<th scope="row">
Requires API Key
</th>
<td>
No
</td>
</tr>
</tbody>
</table>
<p>
<br>
</p>
<h4> <span class="mw-headline" id="Required_Arguments_2">Required Arguments</span></h4>
<table class="spec-table arguments-table">
<tbody>
<tr>
<th>
Field Name
</th>
<th class="spec-description">
Description
</th>
<th class="spec-requirements">
Notes & Requirements
</th>
</tr>
<tr>
<td class="field">
<dl>
<dt>
jurisdiction_id
</dt>
</dl>
</td>
<td></td>
<td>
<span style="color: red">This is only required if the endpoint serves multiple jurisdictions</span>
</td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
<span class="field-url">service_code</span>
</dt>
</dl>
</td>
<td></td>
<td>
The service_code is specified in the main URL path rather than an added query string parameter.
</td>
</tr>
</tbody>
</table>
<p>
<br>
</p>
<h4> <span class="mw-headline" id="Response_2">Response</span></h4>
<table class="spec-table">
<tbody>
<tr>
<th>
Field Name
</th>
<th class="spec-description">
Description
</th>
<th class="spec-requirements">
Notes & Requirements
</th>
</tr>
<tr>
<th colspan="3" class="response-container">
service_definition ↴
</th>
</tr>
<tr>
<td class="field">
<dl>
<dt>
service_code
</dt>
</dl>
</td>
<td>
Returns the service_code associated with the definition, the same one submitted for this call.
</td>
<td></td>
</tr>
<tr>
<th colspan="3" class="response-container">
attributes ⇊
</th>
</tr>
<tr>
<th colspan="3" class="response-container">
attribute ↴
</th>
</tr>
<tr>
<td class="field">
<dl>
<dt>
variable
</dt>
</dl>
</td>
<td>
<ul>
<li>
<span class="strict-value">true</span> denotes that user input is needed
</li>
<li>
<span class="strict-value">false</span> means the attribute is only used to present information to the user within the description field
</li>
</ul>
</td>
<td>
Possible values: <span class="strict-value">true</span>, <span class="strict-value">false</span>.
</td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
code
</dt>
</dl>
</td>
<td>
A unique identifier for the attribute
</td>
<td></td>
</tr>
<tr class="change-update">
<td class="field">
<dl>
<dt>
datatype
</dt>
</dl>
</td>
<td>
Denotes the type of field used for user input.
<ul>
<li>
<span class="strict-value">string</span>: A string of characters without line breaks. Represented in an HTML form using an <input> tag
</li>
<li>
<span class="strict-value">number</span>: A numeric value. Represented in an HTML form using an <input> tag
</li>
<li>
<span class="strict-value">datetime</span>: The input generated must be able to transform into a valid ISO 8601 date. Represented in an HTML form using <input> tags
</li>
<li>
<span class="strict-value">text</span>: A string of characters that may contain line breaks. Represented in an HTML form using an <textarea> tag
</li>
<li>
<span class="strict-value">singlevaluelist</span>: A set of predefined values (specified in this response) where only one value may be selected. Represented in an HTML form using the <select> and <option> tags
</li>
<li>
<span class="strict-value">multivaluelist</span>: A set of predefined values (specified in this response) where several values may be selected. Represented in an HTML form using the <select multiple="multiple"> and <option> tags
</li>
</ul>
<div class="change">
<p>The list of values to be expanded to include <a href="http://www.w3.org/TR/html5/forms.html#the-input-element">HTML5 input types</a> e.g. <span class="strict-value">hidden</span>, <span class="strict-value">tel</span>, <span class="strict-value">url</span>, <span class="strict-value">email</span>, <span class="strict-value">password</span>, <span class="strict-value">datetime</span>, <span class="strict-value">date</span>, <span class="strict-value">month</span>, <span class="strict-value">week</span>, <span class="strict-value">time</span>, <span class="strict-value">datetime-local</span>, <span class="strict-value">range</span>, <span class="strict-value">color</span>.</p>
</div>
</td>
<td>
Options: <span class="strict-value">string</span>, <span class="strict-value">number</span>, <span class="strict-value">datetime</span>, <span class="strict-value">text</span>, <span class="strict-value">singlevaluelist</span>, <span class="strict-value">multivaluelist</span>.
</td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
required
</dt>
</dl>
</td>
<td>
<ul>
<li>
<span class="strict-value">true</span> means that the value is required to submit service request
</li>
<li>
<span class="strict-value">false</span> means that the value not required.
</li>
</ul>
</td>
<td>
Options: <span class="strict-value">true</span>, <span class="strict-value">false</span>.
</td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
datatype_description
</dt>
</dl>
</td>
<td>
A description of the datatype which helps the user provide their input
</td>
<td></td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
order
</dt>
</dl>
</td>
<td>
The sort order that the attributes will be presented to the user. 1 is shown first in the list.
</td>
<td>
Any positive integer not used for other attributes in the same service_code
</td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
description
</dt>
</dl>
</td>
<td>
An description of the attribute field with instructions for the user to find and identify the requested information
</td>
<td></td>
</tr>
<tr class="change-add">
<td colspan="3">
The following attributes from the HTML5 specification should be available to support validation of the data including: <span class="strict-value">max</span>, <span class="strict-value">maxlength</span>, <span class="strict-value">min</span>, <span class="strict-value">pattern</span>, <span class="strict-value">placeholder</span>, <span class="strict-value">step</span>.
<br><em>Not sure how best to achieve this. Either add each of these as optional elements or have a <span class="strict-value">validation</span> element with child elements.</em>
</td>
</tr>
<tr>
<th colspan="3" class="response-container">
values ⇊
</th>
</tr>
<tr>
<th colspan="3" class="response-container">
value ↴
</th>
</tr>
<tr>
<td class="field">
<dl>
<dt>
key
</dt>
</dl>
</td>
<td>
The unique identifier associated with an option for singlevaluelist or multivaluelist. This is analogous to the value attribute in an html option tag.
</td>
<td></td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
name
</dt>
</dl>
</td>
<td>
The human readable title of an option for singlevaluelist or multivaluelist. This is analogous to the innerhtml text node of an html option tag.
</td>
<td></td>
</tr>
<tr class="change-add">
<td class="field">
<dl>
<dt>
group
</dt>
</dl>
</td>
<td>
This is analogous to the optgroup tag.
</td>
<td></td>
</tr>
</tbody>
</table>
<p>
<br>
</p>
<h4> <span class="mw-headline" id="Possible_Errors_2">Possible Errors</span></h4>
<p>
The numbers represent the HTTP status code returned for each error type:
</p>
<ul>
<li>
404 - service_code or jurisdiction_id provided were not found (specify in error response)
</li>
<li>
400 - service_code or jurisdiction_id was not provided (specify in error response)
</li>
<li>
400 - General service error (Anything that fails during service list processing. The client will need to notify us)
</li>
</ul>
<h3> <span class="mw-headline" id="POST_Service_Request">POST Service Request</span></h3>
<table class="method-table">
<tbody>
<tr>
<th scope="row">
Purpose
</th>
<td>
Create service requests
</td>
</tr>
<tr>
<th scope="row">
URL
</th>
<td>
https://[API endpoint]/requests.[format]
</td>
</tr>
<tr>
<th scope="row">
Sample URL
</th>
<td>
https://api.city.gov/dev/v2/requests.xml
</td>
</tr>
<tr>
<th scope="row">
Format sent
</th>
<td>
Content-Type: application/x-www-form-urlencoded
</td>
</tr>
<tr>
<th scope="row">
Formats returned
</th>
<td>
XML (JSON available if denoted by <a href="/Service_Discovery" title="Service Discovery">Service Discovery</a>)
</td>
</tr>
<tr>
<th scope="row">
HTTP Method
</th>
<td>
POST
</td>
</tr>
<tr>
<th scope="row">
Requires API Key
</th>
<td>
Yes
</td>
</tr>
</tbody>
</table>
<p>
<br>
</p>
<h4> <span class="mw-headline" id="Required_Arguments_3">Required Arguments</span></h4>
<table class="spec-table arguments-table">
<tbody>
<tr>
<th>
Field Name
</th>
<th class="spec-description">
Description
</th>
<th class="spec-requirements">
Notes & Requirements
</th>
</tr>
<tr>
<td class="field">
<dl>
<dt>
jurisdiction_id
</dt>
</dl>
</td>
<td></td>
<td>
<span style="color: red">This is only required if the endpoint serves multiple jurisdictions</span>
</td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
service_code
</dt>
</dl>
</td>
<td></td>
<td>
This is obtained from <a href="#GET_Service_List">GET Service List</a> method
</td>
</tr>
<tr class="change-update">
<td class="field">
<dl>
<dt>
<span class="field-alternatives">location parameter</span>
</dt>
</dl>
</td>
<td>
<span class="strikethrough">A full location parameter must be submitted.</span>
</td>
<td>
One of <span class="strict-value">lat</span> & <span class="strict-value">long</span> or <span class="strict-value">address_string</span> or <span class="strict-value">address_id</span>
</td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
attribute
</dt>
</dl>
</td>
<td>
An array of key/value responses based on Service Definitions.
</td>
<td>
This takes the form of attribute[code]=value where multiple code/value pairs can be specified as well as multiple values for the same code in the case of a multivaluelist datatype (attribute[code1][]=value1&attribute[code1][]=value2&attribute[code1][]=value3) - see example. <br><span style="color:red">This is only required if the service_code requires a service definition with required fields</span>.
</td>
</tr>
</tbody>
</table>
<p>
<br>
</p>
<h4> <span class="mw-headline" id="Optional_Arguments_2">Optional Arguments</span></h4>
<table class="spec-table arguments-table">
<tbody>
<tr>
<th>
Field Name
</th>
<th class="spec-description">
Description
</th>
<th class="spec-requirements">
Notes & Requirements
</th>
</tr>
<tr>
<td class="field">
<dl>
<dt>
lat
</dt>
</dl>
</td>
<td>
Latitude using the <a href="http://en.wikipedia.org/wiki/World_Geodetic_System" class="external text" rel="nofollow">(WGS84)</a> projection.
</td>
<td>
<span class="strict-value">lat</span> & <span class="strict-value">long</span> both need to be sent even though they are sent as two separate parameters. <span class="strict-value">lat</span> & <span class="strict-value">long</span> are required if no <span class="strict-value">address_string</span> or <span class="strict-value">address_id</span> is provided.
</td>
</tr>
<tr>
<td class="field">
<dl>
<dt>
long
</dt>
</dl>
</td>
<td>
Longitude using the <a href="http://en.wikipedia.org/wiki/World_Geodetic_System" class="external text" rel="nofollow">(WGS84)</a> projection.
</td>