forked from DigitaleDeltaOrg/dd-api-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdd-oper.v20.html
750 lines (745 loc) · 60.2 KB
/
dd-oper.v20.html
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
<!DOCTYPE HTML><html><head><title>Digitale Delta - Operational (DD-OPER) API API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/raml2html/raml2html 6.4.1"><link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/styles/default.min.css"><script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/highlight.min.js"></script><script type="text/javascript">
$(document).ready(function() {
$('.page-header pre code, .top-resource-description pre code, .modal-body pre code').each(function(i, block) {
hljs.highlightBlock(block);
});
$('[data-toggle]').click(function() {
var selector = $(this).data('target') + ' pre code';
$(selector).each(function(i, block) {
hljs.highlightBlock(block);
});
});
// open modal on hashes like #_action_get
$(window).bind('hashchange', function(e) {
var anchor_id = document.location.hash.substr(1); //strip #
var element = $('#' + anchor_id);
// do we have such element + is it a modal? --> show it
if (element.length && element.hasClass('modal')) {
element.modal('show');
}
});
// execute hashchange on first page load
$(window).trigger('hashchange');
// remove url fragment on modal hide
$('.modal').on('hidden.bs.modal', function() {
try {
if (history && history.replaceState) {
history.replaceState({}, '', '#');
}
} catch(e) {}
});
});
</script><style>
.hljs {
background: transparent;
}
.parent {
color: #999;
}
.list-group-item > .badge {
float: none;
margin-right: 6px;
}
.panel-title > .methods {
float: right;
}
.badge {
border-radius: 0;
text-transform: uppercase;
width: 70px;
font-weight: normal;
color: #f3f3f6;
line-height: normal;
}
.badge_get {
background-color: #63a8e2;
}
.badge_post {
background-color: #6cbd7d;
}
.badge_put {
background-color: #22bac4;
}
.badge_delete {
background-color: #d26460;
}
.badge_patch {
background-color: #ccc444;
}
.list-group, .panel-group {
margin-bottom: 0;
}
.panel-group .panel+.panel-white {
margin-top: 0;
}
.panel-group .panel-white {
border-bottom: 1px solid #F5F5F5;
border-radius: 0;
}
.panel-white:last-child {
border-bottom-color: white;
-webkit-box-shadow: none;
box-shadow: none;
}
.panel-white .panel-heading {
background: white;
}
.tab-pane ul {
padding-left: 2em;
}
.tab-pane h1 {
font-size: 1.3em;
}
.tab-pane h2 {
font-size: 1.2em;
padding-bottom: 4px;
border-bottom: 1px solid #ddd;
}
.tab-pane h3 {
font-size: 1.1em;
}
.tab-content {
border-left: 1px solid #ddd;
border-right: 1px solid #ddd;
border-bottom: 1px solid #ddd;
padding: 10px;
}
#sidebar {
margin-top: 30px;
padding-right: 5px;
overflow: auto;
height: 90%;
}
.top-resource-description {
border-bottom: 1px solid #ddd;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description {
border-bottom: 1px solid #fcfcfc;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description p:last-child {
margin: 0;
}
.list-group .badge {
float: left;
}
.method_description {
margin-left: 85px;
}
.method_description p:last-child {
margin: 0;
}
.list-group-item {
cursor: pointer;
}
.list-group-item:hover {
background-color: #f5f5f5;
}
pre code {
overflow: auto;
word-wrap: normal;
white-space: pre;
}
.items {
background: #f5f5f5;
color: #333;
border: 1px solid #ccc;
border-radius: 4px;
padding: 9.5px;
margin: 0 0 10px;
font-size: 13px;
line-height: 1.42857143;
}
.examples {
margin-left: 0.5em;
}
.resource-modal li > ul {
margin-bottom: 1em;
}
</style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>Digitale Delta - Operational (DD-OPER) API API documentation <small>version 2.0</small></h1><p>http://api.rws.nl/dl/</p><p>Digital Delta - Operational API</p><h3 id="introduction"><a href="#introduction">Introduction</a></h3><p>The Digital Delta is a distributed network in which various data sources exchange information using a standard web service interface. The architecture and additional description of the Digital Delta can be found on ... (TODO refer to digitaldelta.org once it on line). The present document contains the specification of the Digital Delta web service API. It uses the <a href="http://raml.org">RAML standard</a> as the definition language.<br></p><h3 id="the_api_specification"><a href="#the_api_specification">The API specification</a></h3><p>This API describes 'DD-OPER', which is a series of additional endpoints to the 'DD API'. The structure of the /timeseries response of DD-OPER API is in line with the /timeseries response defined by DD-API, but will provide a different (sub)set of the information.</p><p><img src="https://github.com/DigitaleDeltaOrg/dd-api-spec/blob/2.0/documentation/DD-API-2.0-resource-objects.png?raw=true"></p><h3 id="modification_history"><a href="#modification_history">Modification History</a></h3><table class="table"><thead><tr><th>Date</th><th>Author</th><th>Changes</th></tr></thead><tbody><tr><td>2018-04-01</td><td>RWS</td><td>New version created based on DD API 1.0 and MKK-DL API 1.0</td></tr><tr><td>2018-04-20</td><td>RWS</td><td>End-points and request parameters finalised. Naming conventions alligned with DD API 1.9 proposal.</td></tr><tr><td>2018-07-07</td><td>RWS</td><td>Changed to dd-oper version 2.0 and now as Extension of DD-API 2.0 raml.</td></tr><tr><td>2018-07-18</td><td>RWS</td><td>Change to error/problem response due to DD API 2.0 change.</td></tr><tr><td>2018-09-11</td><td>RWS</td><td>References to '/Libraries' changed to 'libraries'</td></tr></tbody></table><h3 id="todo"><a href="#todo">Todo</a></h3><ul><li>Update documentation/description texts. It will also be placed in external files such that updates will not impact raml itself.</li><li>Add error response codes to all responses. most are done, just need sanity check.</li></ul></div><div class="panel panel-default"><div class="panel-heading"><h3 id="dd_oper_2_0" class="panel-title">/dd-oper/2.0</h3></div><div class="panel-body"><div class="top-resource-description"><p>The 'dd-oper' section in the url is mandatory as it is used to distinguish similar endpoints in the DD API (/dd/2.0).</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_dd_oper_2_0_aspectsets"><span class="parent">/dd-oper/2.0</span>/aspectSets</a> <span class="methods"><a href="#dd_oper_2_0_aspectsets_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_oper_2_0_aspectsets" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Retrieves full list of available aspect sets.</p></div><div class="list-group"><div onclick="window.location.href = '#dd_oper_2_0_aspectsets_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_oper_2_0_aspectsets_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/dd-oper/2.0</span>/aspectSets</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#dd_oper_2_0_aspectsets_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_oper_2_0_aspectsets_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Succesfully retrieved resource</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: GENERIC-RESP.BaseResponseHeader</p><strong>Properties</strong><ul><li><strong>results</strong>: <em>required (array of AspectSet)</em><p><strong>Items</strong>: AspectSet</p><div class="items"><ul><li><strong>name</strong>: <em>required (string)</em><p>Name of an AspectSet. If implementing systems require an aspect-filter in the request-url and it is omitted, "default" is taken.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>MinimumMaximumAverage</code></pre></div></li><li><strong>aspects</strong>: <em>required (array of Aspect)</em><p><strong>Items</strong>: Aspect</p><div class="items"><ul><li><strong>name</strong>: <em>required (string)</em></li><li><strong>unit</strong>: <em>required (string)</em></li></ul></div></li></ul></div></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "MKK-DL",
"supportUrl": "http://www.rws.nl/support/mkk-dl",
"responseType": "AspectSetsListResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"results": [
{
"name": "WaterLevelMinMaxAver",
"aspects": [
{
"name": "minimun",
"unit": "mm"
},
{
"name": "maximum",
"unit": "mm"
},
{
"name": "average",
"unit": "mm"
}
]
},
{
"name": "WaterTemperatureRange",
"aspects": [
{
"name": "Minimum95%Accuracy",
"unit": "C"
},
{
"name": "Minimum80%Accuracy",
"unit": "C"
},
{
"name": "average",
"unit": "C"
},
{
"name": "Maximum95%Accuracy",
"unit": "C"
},
{
"name": "Maximum80%Accuracy",
"unit": "C"
}
]
}
]
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_dd_oper_2_0_locations"><span class="parent">/dd-oper/2.0</span>/locations</a> <span class="methods"><a href="#dd_oper_2_0_locations_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_oper_2_0_locations" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The Locations endpoint returns the complete list of locations within the NL.RWS.WM namespace that the Provider offers. There are no filterings options.</p></div><div class="list-group"><div onclick="window.location.href = '#dd_oper_2_0_locations_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_oper_2_0_locations_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/dd-oper/2.0</span>/locations</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#dd_oper_2_0_locations_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_oper_2_0_locations_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: GENERIC-RESP.BaseResponseHeader</p><strong>Properties</strong><ul><li><strong>results</strong>: <em>required (array of Location)</em><p><strong>Items</strong>: Location</p><div class="items"><ul><li><strong>type</strong>: <em>required (Feature)</em><p>Type of GeoJSON object. In the DD-API the only allowed type is "Feature".</p></li><li><strong>geometry</strong>: <em>required (DD-T.Geometry | nil)</em><p>The coordinate(s) of the Location are placed within the "geometry" section of the GeoJSON object. DD-API uses Point and Multi-Point locations, but is not restricted to these two.</p></li><li><strong>properties</strong>: <em>(object)</em><p>The attributes of the Location object are placed within the properties group of the GeoJSON object.</p><ul><li><strong>url</strong>: <em>(string)</em><p>Url describing the location object. (Not provided in case of /dd-oper requests.)</p></li><li><strong>node</strong>: <em>(object)</em><p>Specification of the node where the location is stored.</p><ul><li><strong>id</strong>: <em>(string)</em><p>Id of the node.</p></li><li><strong>name</strong>: <em>required (string)</em><p>The name of the node.</p></li><li><strong>description</strong>: <em>(string)</em><p>The description of the node.</p></li><li><strong>baseUrl</strong>: <em>(string)</em><p>The base URL of the node.</p></li></ul></li><li><strong>locationId</strong>: <em>(string)</em><p>Id of the location.</p></li><li><strong>locationCode</strong>: <em>(string)</em><p>Code of the location.</p></li><li><strong>locationName</strong>: <em>(string)</em><p>Name of the location.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li><li><strong>referenceLevel</strong>: <em>(string)</em><p>GeoJSON element. Specifies the reference plane for the altitude coordinates (third). For example "NAP".</p></li><li><strong>crs</strong>: <em>(object)</em><p>GeoJSON Coordinate Reference System element. According to GeoJSON the CRS always as to be "WGS84", hence the crs element has been removed from the GeoJSON Feature object. However, the DD-API still has the field, to be able to specify that the data is provided in another CRS (although this is discouraged). If present, the crs property should be according to the now obsolete GeoJSON specification (see <a href="http://geojson.org/geojson-spec#coordinate-reference-system-objects">http://geojson.org/geojson-spec#coordinate-reference-system-objects</a>).</p></li><li><strong>locationNameSpace</strong>: <em>(string)</em><p>Remark: Only used in DD-OPER response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>NL.RWS.WM</code></pre></div></li><li><strong>displayNameDetail</strong>: <em>(string)</em><p>Remark: Only used in DD-OPER response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li><li><strong>displayNameGlobal</strong>: <em>(string)</em><p>Remark: Only used in DD-OPER response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li><li><strong>displayNameSpace</strong>: <em>(string)</em><p>Remark: Only used in DD-OPER response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>NL.RWS.WM</code></pre></div></li><li><strong>parentName</strong>: <em>(string)</em><p>Remark: Only used in DD-OPER response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li><li><strong></strong></li></ul></li></ul></div></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "MKK-DL",
"supportUrl": "tbd http://www.rws.nl/support/mkk-dl",
"responseType": "LocationListResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"results": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
4.123456,
52.123456
]
},
"properties": {
"locationName": "Maarssen.Oostkanaaldijk",
"locationNameSpace": "NL.RWS.WM",
"displayNameGlobal": "Maarssen",
"displayNameDetail": "Oostkanaaldijk",
"parentName": "noordzeekanaal-amsterdamrijnkanaal",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:28992"
}
},
"referenceLevel": "NAP"
}
},
{
"type": "Feature",
"geometry": {
"type": "MultiPoint",
"coordinates": [
[
4.123456,
52.123456
],
[
4.123456,
52.123456,
-1.0
],
[
4.123456,
52.123456,
-2.0
]
]
},
"properties": {
"locationName": "Maarssen.Westkanaaldijk",
"locationNameSpace": "NL.RWS.WM",
"displayNameGlobal": "Maarssen",
"displayNameDetail": "Westkanaaldijk",
"parentName": "noordzeekanaal-amsterdamrijnkanaal",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:28992"
}
},
"referenceLevel": "NAP"
}
}
]
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_dd_oper_2_0_locations__locationname_"><span class="parent">/dd-oper/2.0/locations</span>/{locationName}</a> <span class="methods"><a href="#dd_oper_2_0_locations__locationname__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_oper_2_0_locations__locationname_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Request a specific location by its matching name (caseless match).</p></div><div class="list-group"><div onclick="window.location.href = '#dd_oper_2_0_locations__locationname__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>The resource request for details of a single location is not yet supported</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_oper_2_0_locations__locationname__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/dd-oper/2.0/locations</span>/{locationName}</h4></div><div class="modal-body"><div class="alert alert-info"><p>The resource request for details of a single location is not yet supported</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_oper_2_0_locations__locationname__get_request" data-toggle="tab">Request</a></li><li><a href="#dd_oper_2_0_locations__locationname__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_oper_2_0_locations__locationname__get_request"><h3>URI Parameters</h3><ul><li><strong>locationName</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li></ul></div><div class="tab-pane" id="dd_oper_2_0_locations__locationname__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
4.123456,
52.123456
]
},
"properties": {
"locationName": "Maarssen.Oostkanaaldijk",
"locationNameSpace": "NL.RWS.WM",
"displayNameGlobal": "Maarssen",
"displayNameDetail": "Oostkanaaldijk",
"parentName": "noordzeekanaal-amsterdamrijnkanaal",
"crs": "only if not WGS84, i.e. ETR89",
"referenceLevel": "NAP",
"provider": {
"name": "MKK-DL",
"supportUrl": "tbd http://www.rws.nl/support/mkk-dl",
"responseType": "LocationResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
}
}
}
</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: DD-T.Error</p><strong>Properties</strong><ul><li><strong>provider</strong>: <em>required (object)</em><p>Information regarding the system that is responsible for the response. Provides support contact information in case there are issues with response format or content.</p><ul><li><strong>name</strong>: <em>(string)</em><p>Name of the provider (of the service).</p></li><li><strong>supportUrl</strong>: <em>(string)</em><p>Url to information for the provider (of the service).</p></li><li><strong>apiVersion</strong>: <em>(string)</em><p>API Version with which the result set was generated. Can be used to parse the response.</p></li><li><strong>responseType</strong>: <em>(string)</em><p>Name of the type of the result set. Can be used to parse the response.</p></li><li><strong>responseTimestamp</strong>: <em>(string - minLength: 24)</em><p>Timestamp when this response was created.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15:11:36.123Z, 2018-07-05T15:11:36.123456Z, 2018-07-05T15:11:36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "MKK-DL",
"supportUrl": "http://www.rws.nl/support/mkk-dl",
"responseType": "ProblemResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"type": "https://content.mkk-dl.rws.nl/c/esb/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn:esblog:2018-01-01:23:59:59.99999Z"
}
</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: DD-T.Error</p><strong>Properties</strong><ul><li><strong>provider</strong>: <em>required (object)</em><p>Information regarding the system that is responsible for the response. Provides support contact information in case there are issues with response format or content.</p><ul><li><strong>name</strong>: <em>(string)</em><p>Name of the provider (of the service).</p></li><li><strong>supportUrl</strong>: <em>(string)</em><p>Url to information for the provider (of the service).</p></li><li><strong>apiVersion</strong>: <em>(string)</em><p>API Version with which the result set was generated. Can be used to parse the response.</p></li><li><strong>responseType</strong>: <em>(string)</em><p>Name of the type of the result set. Can be used to parse the response.</p></li><li><strong>responseTimestamp</strong>: <em>(string - minLength: 24)</em><p>Timestamp when this response was created.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15:11:36.123Z, 2018-07-05T15:11:36.123456Z, 2018-07-05T15:11:36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "MKK-DL",
"supportUrl": "http://www.rws.nl/support/mkk-dl",
"responseType": "ProblemResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"type": "https://content.mkk-dl.rws.nl/c/esb/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn:esblog:2018-01-01:23:59:59.99999Z"
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_dd_oper_2_0_locations__locationname__quantities"><span class="parent">/dd-oper/2.0/locations/{locationName}</span>/quantities</a> <span class="methods"><a href="#dd_oper_2_0_locations__locationname__quantities_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_oper_2_0_locations__locationname__quantities" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>The quantities endpoint returns the list of parameters available at the selected location.</p></div><div class="list-group"><div onclick="window.location.href = '#dd_oper_2_0_locations__locationname__quantities_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_oper_2_0_locations__locationname__quantities_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/dd-oper/2.0/locations/{locationName}</span>/quantities</h4></div><div class="modal-body"><ul class="nav nav-tabs"><li class="active"><a href="#dd_oper_2_0_locations__locationname__quantities_get_request" data-toggle="tab">Request</a></li><li><a href="#dd_oper_2_0_locations__locationname__quantities_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_oper_2_0_locations__locationname__quantities_get_request"><h3>URI Parameters</h3><ul><li><strong>locationName</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li></ul></div><div class="tab-pane" id="dd_oper_2_0_locations__locationname__quantities_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>provider</strong>: <em>(object)</em><p>Information regarding the system that is responsible for the response. Provides support contact information in case there are issues with response format or content.</p><ul><li><strong>name</strong>: <em>(string)</em><p>Name of the provider (of the service).</p></li><li><strong>supportUrl</strong>: <em>(string)</em><p>Url to information for the provider (of the service).</p></li><li><strong>apiVersion</strong>: <em>(string)</em><p>API Version with which the result set was generated. Can be used to parse the response.</p></li><li><strong>responseType</strong>: <em>(string)</em><p>Name of the type of the result set. Can be used to parse the response.</p></li><li><strong>responseTimestamp</strong>: <em>(string - minLength: 24)</em><p>Timestamp when this response was created.</p></li></ul></li><li><strong>results</strong>: <em>required (array of QuantityName)</em></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "MKK-DL",
"supportUrl": "http://www.rws.nl/support/mkk-dl",
"responseType": "QuantityListResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"results": [
"WaterLevel",
"WaterTemperature",
"WaveHeight"
]
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_dd_oper_2_0_locations__locationname__quantities__quantityname_"><span class="parent">/dd-oper/2.0/locations/{locationName}/quantities</span>/{quantityName}</a> <span class="methods"><a href="#dd_oper_2_0_locations__locationname__quantities__quantityname__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_oper_2_0_locations__locationname__quantities__quantityname_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_oper_2_0_locations__locationname__quantities__quantityname__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Request a specific quantity by its name. This request is not yet supported.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_oper_2_0_locations__locationname__quantities__quantityname__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/dd-oper/2.0/locations/{locationName}/quantities</span>/{quantityName}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Request a specific quantity by its name. This request is not yet supported.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_oper_2_0_locations__locationname__quantities__quantityname__get_request" data-toggle="tab">Request</a></li><li><a href="#dd_oper_2_0_locations__locationname__quantities__quantityname__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_oper_2_0_locations__locationname__quantities__quantityname__get_request"><h3>URI Parameters</h3><ul><li><strong>locationName</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li><li><strong>quantityName</strong>: <em>required (string)</em><p>A name referencing a category of time series. The quantity names are predefined. For example 'WaterLevel', 'WaterTemperature', 'WaveHeight'. Remark: Only used in DD-OPER</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>WaterLevel</code></pre></div></li></ul></div><div class="tab-pane" id="dd_oper_2_0_locations__locationname__quantities__quantityname__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: GENERIC-RESP.BaseResponseHeader</p><strong>Properties</strong><ul><li><strong>result</strong>: <em>required (object)</em><ul><li><strong>quantityName</strong>: <em>required (string)</em><p>A name referencing a category of time series. The quantity names are predefined. For example 'WaterLevel', 'WaterTemperature', 'WaveHeight'. Remark: Only used in DD-OPER</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>WaterLevel</code></pre></div></li><li><strong>aspectSets</strong>: <em>(array of AspectSet)</em><p><strong>Items</strong>: AspectSet</p><div class="items"><ul><li><strong>name</strong>: <em>required (string)</em><p>Name of an AspectSet. If implementing systems require an aspect-filter in the request-url and it is omitted, "default" is taken.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>MinimumMaximumAverage</code></pre></div></li><li><strong>aspects</strong>: <em>required (array of Aspect)</em><p><strong>Items</strong>: Aspect</p><div class="items"><ul><li><strong>name</strong>: <em>required (string)</em></li><li><strong>unit</strong>: <em>required (string)</em></li></ul></div></li></ul></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "MKK-DL",
"supportUrl": "http://www.rws.nl/support/mkk-dl",
"responseType": "QuantityResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"result": {
"quantityName": "WaterLevel",
"aspectSets": [
{
"name": "WaterLevelMinMaxAver",
"aspects": [
{
"name": "minimun",
"unit": "mm"
},
{
"name": "maximum",
"unit": "mm"
},
{
"name": "average",
"unit": "mm"
}
]
}
]
}
}
</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: DD-T.Error</p><strong>Properties</strong><ul><li><strong>provider</strong>: <em>required (object)</em><p>Information regarding the system that is responsible for the response. Provides support contact information in case there are issues with response format or content.</p><ul><li><strong>name</strong>: <em>(string)</em><p>Name of the provider (of the service).</p></li><li><strong>supportUrl</strong>: <em>(string)</em><p>Url to information for the provider (of the service).</p></li><li><strong>apiVersion</strong>: <em>(string)</em><p>API Version with which the result set was generated. Can be used to parse the response.</p></li><li><strong>responseType</strong>: <em>(string)</em><p>Name of the type of the result set. Can be used to parse the response.</p></li><li><strong>responseTimestamp</strong>: <em>(string - minLength: 24)</em><p>Timestamp when this response was created.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15:11:36.123Z, 2018-07-05T15:11:36.123456Z, 2018-07-05T15:11:36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "MKK-DL",
"supportUrl": "http://www.rws.nl/support/mkk-dl",
"responseType": "ProblemResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"type": "https://content.mkk-dl.rws.nl/c/esb/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn:esblog:2018-01-01:23:59:59.99999Z"
}
</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: DD-T.Error</p><strong>Properties</strong><ul><li><strong>provider</strong>: <em>required (object)</em><p>Information regarding the system that is responsible for the response. Provides support contact information in case there are issues with response format or content.</p><ul><li><strong>name</strong>: <em>(string)</em><p>Name of the provider (of the service).</p></li><li><strong>supportUrl</strong>: <em>(string)</em><p>Url to information for the provider (of the service).</p></li><li><strong>apiVersion</strong>: <em>(string)</em><p>API Version with which the result set was generated. Can be used to parse the response.</p></li><li><strong>responseType</strong>: <em>(string)</em><p>Name of the type of the result set. Can be used to parse the response.</p></li><li><strong>responseTimestamp</strong>: <em>(string - minLength: 24)</em><p>Timestamp when this response was created.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15:11:36.123Z, 2018-07-05T15:11:36.123456Z, 2018-07-05T15:11:36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "MKK-DL",
"supportUrl": "http://www.rws.nl/support/mkk-dl",
"responseType": "ProblemResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"type": "https://content.mkk-dl.rws.nl/c/esb/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn:esblog:2018-01-01:23:59:59.99999Z"
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_dd_oper_2_0_locations__locationname__quantities__quantityname__timeseries"><span class="parent">/dd-oper/2.0/locations/{locationName}/quantities/{quantityName}</span>/timeseries</a> <span class="methods"><a href="#dd_oper_2_0_locations__locationname__quantities__quantityname__timeseries_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_oper_2_0_locations__locationname__quantities__quantityname__timeseries" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_oper_2_0_locations__locationname__quantities__quantityname__timeseries_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve resource</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_oper_2_0_locations__locationname__quantities__quantityname__timeseries_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/dd-oper/2.0/locations/{locationName}/quantities/{quantityName}</span>/timeseries</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve resource</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_oper_2_0_locations__locationname__quantities__quantityname__timeseries_get_request" data-toggle="tab">Request</a></li><li><a href="#dd_oper_2_0_locations__locationname__quantities__quantityname__timeseries_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_oper_2_0_locations__locationname__quantities__quantityname__timeseries_get_request"><h3>URI Parameters</h3><ul><li><strong>locationName</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li><li><strong>quantityName</strong>: <em>required (string)</em><p>A name referencing a category of time series. The quantity names are predefined. For example 'WaterLevel', 'WaterTemperature', 'WaveHeight'. Remark: Only used in DD-OPER</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>WaterLevel</code></pre></div></li></ul><h3>Query Parameters</h3><ul><li><strong>startTime</strong>: <em>required (datetime)</em><p>Start date/time of the time series, or the Start date/time of the interval for an individual value in the series. Uses the UCT (Zulu) notation.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2016-01-01T12:45:00Z</code></pre></div></li><li><strong>endTime</strong>: <em>(datetime)</em><p>The End date/time of the time series, or the End date/time of the interval for an individual value in the series. Uses the UCT (Zulu) notation. The endtime is exlusive, hence the requested period ends just before the given time. 2018-01-01T00:00:00Z - 2018-01-01T00:00:10Z specifies a 10 minute period starting at midnight and ending at 2018-01-01T00:09:59.99999Z</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-01-01T00:00:00Z</code></pre></div></li><li><strong>intervalLength</strong>: <em>(string - default: 10min)</em><p>Interval length of the sequence.</p></li><li><strong>aspectSet</strong>: <em>(string - default: standard)</em><p>Name of an AspectSet. If implementing systems require an aspect-filter in the request-url and it is omitted, "default" is taken.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>MinimumMaximumAverage</code></pre></div></li><li><strong>process</strong>: <em>required (string - default: measurement)</em><p>The name of the mechanism to collect/derive the time series value. When accessing RWS' DD-API, providing a processName as query parameter is required. The process names are pre-defined (see examples). Extending the processname with a suffix, referencing a more detailed mechanism like a specific calculation model, is not allowed. Other implementions dot need to implement this query-parameter.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>measurement, forecast, astronomical, advise</code></pre></div></li></ul></div><div class="tab-pane" id="dd_oper_2_0_locations__locationname__quantities__quantityname__timeseries_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><p>Succesfully retrieved timeseries</p><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: GENERIC-RESP.BaseResponseHeader</p><strong>Properties</strong><ul><li><strong>results</strong>: <em>required (array of Timeseries)</em><p>Timeseries objects with multiple event values. Defined as List for compatibility with DD API.</p><p><strong>Items</strong>: Timeseries</p><div class="items"><ul><li><strong>node</strong>: <em>(object)</em><p>Reference to the DD-node that contains the data of the time series.</p><ul><li><strong>id</strong>: <em>(string)</em><p>Id of the node.</p></li><li><strong>name</strong>: <em>required (string)</em><p>The name of the node.</p></li><li><strong>description</strong>: <em>(string)</em><p>The description of the node.</p></li><li><strong>baseUrl</strong>: <em>(string)</em><p>The base URL of the node.</p></li></ul></li><li><strong>url</strong>: <em>(string)</em><p>The provider's URL for the time series.</p></li><li><strong>id</strong>: <em>(string)</em><p>The IdL of the time series.</p></li><li><strong>source</strong>: <em>required (object)</em><p>Source of the time series.</p><ul><li><strong>process</strong>: <em>required (string)</em><p>Name of the process.</p></li><li><strong>name</strong>: <em>(string)</em><p>A name describing the source, e.g. a model name.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>rws_prediction</code></pre></div></li><li><strong>description</strong>: <em>(string)</em><p>Additional description of the data source (might contain a URL to a site with information on the model).</p></li><li><strong>realizationCount</strong>: <em>(integer)</em><p>if present, and larger then 1, the results are part of an ensemble run</p></li><li><strong>institution</strong>: <em>required (object)</em><ul><li><strong>name</strong>: <em>required (string)</em><p>The name of the institution that produced and/or owns the data</p></li><li><strong>description</strong>: <em>(string)</em><p>Additional description of the institution</p></li></ul></li></ul></li><li><strong>location</strong>: <em>required (object)</em><p>Location of the time series.</p><ul><li><strong>type</strong>: <em>required (Feature)</em><p>Type of GeoJSON object. In the DD-API the only allowed type is "Feature".</p></li><li><strong>geometry</strong>: <em>required (DD-T.Geometry | nil)</em><p>The coordinate(s) of the Location are placed within the "geometry" section of the GeoJSON object. DD-API uses Point and Multi-Point locations, but is not restricted to these two.</p></li><li><strong>properties</strong></li></ul></li><li><strong>observationType</strong>: <em>required (object)</em><p>Observation type of the time series (concentration, parameter, etc.).</p><ul><li><strong>id</strong>: <em>(string)</em><p>Id of the observation type.</p></li><li><strong>url</strong>: <em>(string)</em><p>The provider's URL for the time series.</p></li><li><strong>node</strong>: <em>(object)</em><p>Reference to the DD-node that contains the data of the time series.</p><ul><li><strong>id</strong>: <em>(string)</em><p>Id of the node.</p></li><li><strong>name</strong>: <em>required (string)</em><p>The name of the node.</p></li><li><strong>description</strong>: <em>(string)</em><p>The description of the node.</p></li><li><strong>baseUrl</strong>: <em>(string)</em><p>The base URL of the node.</p></li></ul></li><li><strong>quantity</strong>: <em>(string)</em><p>Quantity (grootheid) of the observation type.</p></li><li><strong>parameterCode</strong>: <em>(string)</em><p>Parameter code specifying the observationtype. Non-biological observation types follow the Aquo standards.</p></li><li><strong>description</strong>: <em>(string)</em><p>Description of the observation type.</p></li><li><strong>unit</strong>: <em>(string)</em><p>(Measurement) unit of the observation type.</p></li><li><strong>compartment</strong>: <em>(string)</em><p>The compartment in which the measurement/computation is available. Standardised Aquo compartments.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>OW, DL, GW, LW</code></pre></div></li><li><strong>qualifier</strong>: <em>(string)</em><p>Additional qualification of the measurement or computation. Can be used for the Aqou 'hoedanigheid'.</p></li><li><strong>quantityName</strong>: <em>(string)</em><p>Composed name of the quantity(.parameterCode) that was measured or computed. Remark: Only used in DD-OPER response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>WaterLevel</code></pre></div></li><li><strong>aspectSet</strong>: <em>(object)</em><p>Optional, currently only provided and used by RWS.</p><ul><li><strong>name</strong>: <em>required (string)</em><p>Name of an AspectSet. If implementing systems require an aspect-filter in the request-url and it is omitted, "default" is taken.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>MinimumMaximumAverage</code></pre></div></li><li><strong>aspects</strong>: <em>required (array of Aspect)</em><p><strong>Items</strong>: Aspect</p><div class="items"><ul><li><strong>name</strong>: <em>required (string)</em></li><li><strong>unit</strong>: <em>required (string)</em></li></ul></div></li></ul></li></ul></li><li><strong>startTime</strong>: <em>required (datetime)</em><p>Start date-time of the time series (the first timestamp/value pair available in the series).</p></li><li><strong>endTime</strong>: <em>required (datetime)</em><p>End date-time of the time series (the last timestamp/value pair available in the series).</p></li><li><strong>analysisTime</strong>: <em>(datetime)</em><p>Analysis date-time of the time series.</p></li><li><strong>realization</strong>: <em>(number)</em><p>Realization count.</p></li><li><strong>intervalLength</strong>: <em>(number)</em><p>Specifies the interval between events in the time series. If present and set to 'null', the time series is non-equidistant. TODO: decide on options for units.</p></li><li><strong>valueType</strong>: <em>(string)</em><p>The data type of the measured or computed data (float, integer, categorized). Default: float.</p></li><li><strong>qualifier</strong>: <em>(string)</em><p>Additional qualification of the measurement or computation.</p></li><li><strong>events</strong>: <em>(array of Event)</em><p>If no startTime and no endTime are provided in the /time series-query, only meta-data is provided, so the events are not present.</p><p><strong>Items</strong>: Event</p><div class="items"><ul><li><strong>timeStamp</strong>: <em>(datetime)</em><p>Timestamp of the occurrence of the event.</p></li><li><strong>startTime</strong>: <em>(datetime)</em><p>Start time.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2016-01-01T12:45:00Z</code></pre></div></li><li><strong>endTime</strong>: <em>(datetime)</em><p>End time.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-01-01T00:00:00Z</code></pre></div></li><li><strong>resultTime</strong>: <em>(datetime)</em><p>Result time.</p></li><li><strong>value</strong>: <em>(union)</em><p>The measured or computed value for a scalar value, i.e. in case there are no aspects and/or multiple points per event.</p></li><li><strong>limitSymbol</strong>: <em>(string)</em><p>Specifies that the value is e.g. higher (or lower) then the value in "value". Known limitSymbols are "<", ">", "<=", ">="</p></li><li><strong>quality</strong>: <em>(number)</em><p>Indicator for the quality of the measured or computed value in the 'value' attribute.</p></li><li><strong>additionalQuality</strong>: <em>(number)</em><p>Additional information on the value in the 'quality' attribute.</p></li><li><strong>aspects</strong>: <em>(DD-T.AspectValue[] | DD-T.AspectPointsValue[])</em><p>When the time series contains aspects the value/quality/unit are given in an object for each aspect or aspect+point.</p></li><li><strong>points</strong>: <em>(array of PointsValue)</em><p>When the time series contains multiple points the value/quantity/unit are given in an object for each point.</p><p><strong>Items</strong>: PointsValue</p><div class="items"><ul><li><strong>coordinates</strong>: <em>required (array of Double)</em><p>A location specified in an array with longitude, lattitude and optional altitude.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
4.234,
5.23423
]</code></pre></div></li><li><strong>value</strong>: <em>required (union)</em><p>The value of the measured or computed data.</p></li><li><strong>limitSymbol</strong>: <em>(string)</em><p>Specifies that the value is e.g. higher (or lower) then the value in "value". Known limitSymbols are "<", ">", "<=", ">="</p></li><li><strong>quality</strong>: <em>(number)</em><p>Indicator for the quality of the measured or computed value in the 'value' attribute.</p></li><li><strong>additionalQuality</strong>: <em>(number)</em><p>Additional information on the value in the 'quality' attribute.</p></li></ul></div></li></ul></div></li></ul></div></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "LMW-Next",
"supportUrl": "http://www.rws.nl/support/lmw-next",
"responseType": "timeseriesListResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"results": [ {
"source": {
"process": "measurement",
"institution": {
"name": "RWS"
}
},
"location": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
4.1333300,
51.9775000
]
},
"properties": {
"locationName": "AmsterdamRijnKanaal.Oostkanaaldijk",
"locationNameSpace": "NL.RWS.WM",
"displayNameGlobal": "AmsterdamRijnKanaal",
"displayNameDetail": "Oostkanaaldijk KP112",
"parentName": "noordzeekanaal-amsterdamrijnkanaal",
"referenceLevel": "WaterOppervlakte",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:28992"
}
}
}
},
"observationType": {
"quantityName": "WaterLevel",
"aspectSet": {
"name": "WaterLevelMinMax",
"aspects": [{
"name": "average",
"unit": "m"
},
{
"name": "minimum",
"unit": "m"
},
{
"name": "maximum",
"unit": "m"
}
]
}
},
"startTime": "2017-02-07T13:05:30Z",
"endTime": "2017-02-07T13:06:30Z",
"events": [{
"timeStamp": "2017-02-07T13:05:30Z",
"startTime": "2017-02-07T13:05:00Z",
"endTime": "2017-02-07T13:05:59Z",
"aspects": [{
"name": "average",
"points": [{
"coordinates": [
4.1333300,
51.9775000,
1.1
],
"quality": 1,
"value": 10
},
{
"coordinates": [
4.1333300,
51.9775000,
0.8
],
"quality": 13,
"additionalQuality": 88,
"value": 11
},
{
"coordinates": [
4.1333300,
51.9775000,
0.4
],
"quality": 1,
"value": 12
},
{
"coordinates": [
4.1333300,
51.9775000, -0.1
],
"quality": 1,
"value": 13
}
]
},
{
"name": "minimum",
"points": [{
"coordinates": [
4.1333300,
51.9775000,
1.1
],
"quality": 1,
"value": 9
},
{
"coordinates": [
4.1333300,
51.9775000,
0.8
],
"quality": 1,
"value": 10
},
{
"coordinates": [
4.1333300,
51.9775000,
0.4
],
"quality": 1,
"value": 11
},
{
"coordinates": [
4.1333300,
51.9775000, -0.1
],
"quality": 1,
"value": 12
}
]
},
{
"name": "maximum",
"points": [{
"coordinates": [
4.1333300,
51.9775000,
1.1
],
"quality": 1,
"value": 11
},
{
"coordinates": [
4.1333300,
51.9775000,
0.8
],
"quality": 1,
"value": 12
},
{
"coordinates": [
4.1333300,
51.9775000,
0.4
],
"quality": 1,
"value": 13
},
{
"coordinates": [
4.1333300,
51.9775000, -0.1
],
"quality": 1,
"value": 14
}
]
}
]
},
{
"timeStamp": "2017-02-07T13:06:30Z",
"startTime": "2017-02-07T13:06:00Z",
"endTime": "2017-02-07T13:06:59Z",
"aspects": [{
"name": "average",
"points": [{
"coordinates": [
4.1333300,
51.9775000,
1.1
],
"quality": 1,
"value": 10.5
},
{
"coordinates": [
4.1333300,
51.9775000,
0.8
],
"quality": 1,
"value": 11.5
},
{
"coordinates": [
4.1333300,
51.9775000,
0.4
],
"quality": 1,
"value": 12.5
},
{
"coordinates": [
4.1333300,
51.9775000, -0.1
],
"quality": 1,
"value": 13.5
}
]
},
{
"name": "minimum",
"points": [{
"coordinates": [
4.1333300,
51.9775000,
1.1
],
"quality": 1,
"value": 9.5
},
{
"coordinates": [
4.1333300,
51.9775000,
0.8
],
"quality": 1,
"value": 10.5
},
{
"coordinates": [
4.1333300,
51.9775000,
0.4
],
"quality": 1,
"value": 11.5
},
{
"coordinates": [
4.1333300,
51.9775000, -0.1
],
"quality": 1,
"value": 12.5
}
]
},
{
"name": "maximum",
"points": [{
"coordinates": [
4.1333300,
51.9775000,
1.1
],
"quality": 1,
"value": 11.5
},
{
"coordinates": [
4.1333300,
51.9775000,
0.8
],
"quality": 1,
"value": 12.5
},
{
"coordinates": [
4.1333300,
51.9775000,
0.4
],
"quality": 1,
"value": 13.5
},
{
"coordinates": [
4.1333300,
51.9775000, -0.1
],
"quality": 1,
"value": 14.5
}
]
}
]
}
]
}
]
}
</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/400" target="_blank">400</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: DD-T.Error</p><strong>Properties</strong><ul><li><strong>provider</strong>: <em>required (object)</em><p>Information regarding the system that is responsible for the response. Provides support contact information in case there are issues with response format or content.</p><ul><li><strong>name</strong>: <em>(string)</em><p>Name of the provider (of the service).</p></li><li><strong>supportUrl</strong>: <em>(string)</em><p>Url to information for the provider (of the service).</p></li><li><strong>apiVersion</strong>: <em>(string)</em><p>API Version with which the result set was generated. Can be used to parse the response.</p></li><li><strong>responseType</strong>: <em>(string)</em><p>Name of the type of the result set. Can be used to parse the response.</p></li><li><strong>responseTimestamp</strong>: <em>(string - minLength: 24)</em><p>Timestamp when this response was created.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15:11:36.123Z, 2018-07-05T15:11:36.123456Z, 2018-07-05T15:11:36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "MKK-DL",
"supportUrl": "http://www.rws.nl/support/mkk-dl",
"responseType": "ProblemResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"type": "https://content.mkk-dl.rws.nl/c/esb/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn:esblog:2018-01-01:23:59:59.99999Z"
}
</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/500" target="_blank">500</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: DD-T.Error</p><strong>Properties</strong><ul><li><strong>provider</strong>: <em>required (object)</em><p>Information regarding the system that is responsible for the response. Provides support contact information in case there are issues with response format or content.</p><ul><li><strong>name</strong>: <em>(string)</em><p>Name of the provider (of the service).</p></li><li><strong>supportUrl</strong>: <em>(string)</em><p>Url to information for the provider (of the service).</p></li><li><strong>apiVersion</strong>: <em>(string)</em><p>API Version with which the result set was generated. Can be used to parse the response.</p></li><li><strong>responseType</strong>: <em>(string)</em><p>Name of the type of the result set. Can be used to parse the response.</p></li><li><strong>responseTimestamp</strong>: <em>(string - minLength: 24)</em><p>Timestamp when this response was created.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15:11:36.123Z, 2018-07-05T15:11:36.123456Z, 2018-07-05T15:11:36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "MKK-DL",
"supportUrl": "http://www.rws.nl/support/mkk-dl",
"responseType": "ProblemResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"type": "https://content.mkk-dl.rws.nl/c/esb/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn:esblog:2018-01-01:23:59:59.99999Z"
}
</code></pre></div></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#dd_oper_2_0">/dd-oper/2.0</a></li></ul></div></div></div></div></body></html>