forked from DigitaleDeltaOrg/dd-api-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdd.v20.html
1045 lines (1040 loc) · 187 KB
/
dd.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
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><head><title>Digitale Delta - 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 7.2.0"><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.12.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.12.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 - API API documentation <small>version 2.0.1</small></h1><p>http://api.rws.nl/dl/</p><p>Digital Delta API version 2.0.1</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 ... <em>(todo: refer to digitaldelta.org once it is on line)</em>.<br>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="document_history"><a href="#document_history">Document history</a></h3><table class="table"><thead><tr><th>Date</th><th>Author</th><th>Changes</th></tr></thead><tbody><tr><td>June 2018</td><td>DD team</td><td>Initial check in of DD-API-2.0 draft</td></tr></tbody></table><h3 id="the_api_specification"><a href="#the_api_specification">The API specification</a></h3><p>The API specification consists of two parts.</p><ul><li>The <em>Types</em> section describes the data types that are available for the resources. The figure below shows an overview of the resource objects and there relations.<br><em>Note 1</em>: The <em>Types</em> section in this main RAML file actually is empty. It includes the various type files in the <code>Libraries</code> directory.<br><em>Note 2</em>: Currently, the generated HTML documentation does not contain tables that describe the data types. However, their content can be seen in the response tabs of the requests. If you want to have a detailed look at the type definitions, open the RAML files in the <em>Libraries</em> directory.</li><li>The <em>/dd/2.0</em> resources section describes the available end-points.</li></ul><p>See the figure below for an overview of the various resource objects and their relations.</p><p></p><p> </p><p></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="end_points_specification"><a href="#end_points_specification">End points specification</a></h3><p>The table below contains the specification of end points. Click the <em>Get</em> button, and see the <em>Request</em> and <em>Response</em> tabs for details.</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="dd_2_0" class="panel-title">/dd/2.0</h3></div><div class="panel-body"><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_2_0_nodes"><span class="parent">/dd/2.0</span>/nodes</a> <span class="methods"><a href="#dd_2_0_nodes_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_2_0_nodes" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_2_0_nodes_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>A (data)node is an area from which resource objects can be retrieved.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_2_0_nodes_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/2.0</span>/nodes</h4></div><div class="modal-body"><div class="alert alert-info"><p>A (data)node is an area from which resource objects can be retrieved.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_2_0_nodes_get_request" data-toggle="tab">Request</a></li><li><a href="#dd_2_0_nodes_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_2_0_nodes_get_request"><h3>Query Parameters</h3><ul><li><strong>process</strong>: <em>(string)</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><li><strong>name</strong>: <em>(string)</em><p>(Partial) name of the node. Partial meaning startsWith(...).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>RwsPrimaryNode</code></pre></div></li><li><strong>page</strong>: <em>(integer)</em><p>Page number, starting with 1.</p></li><li><strong>pageSize</strong>: <em>(integer)</em><p>Requested response Page size. Minimum, maximum and default is defined by Provider. Minimum can never be lower than 1.</p></li></ul></div><div class="tab-pane" id="dd_2_0_nodes_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>: 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><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li><li><strong>paging</strong>: <em>(object)</em><p>The object contains urls and page size information to support back and forward paging</p><ul><li><strong>totalObjectCount</strong>: <em>(integer)</em><p>The actual number of objects available. When paging is used the response contains a subset of the total obejcts available up to the max page size.</p></li><li><strong>maxPageSize</strong>: <em>(integer - minimum: 1 - maximum: 10000)</em><p>Maximum number of objects in the response. Defined by the Provider of the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>10</code></pre></div></li><li><strong>minPageSize</strong>: <em>(integer - minimum: 1 - maximum: 10000)</em><p>Minimum number of objects in the response. Defined by the Provider of the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>10</code></pre></div></li><li><strong>self</strong>: <em>(union of DD-T.Url or nil)</em><p>Url of the current request.</p></li><li><strong>first</strong>: <em>(union of DD-T.Url or nil)</em><p>Url to the first page of the result set.</p></li><li><strong>prev</strong>: <em>required (union of DD-T.Url or nil)</em><p>Url to the previous page of the result set.</p></li><li><strong>next</strong>: <em>required (union of DD-T.Url or nil)</em><p>Url to the next page of the result set.</p></li><li><strong>last</strong>: <em>(union of DD-T.Url or nil)</em><p>Url to the last page of the result set.</p></li></ul></li><li><strong>results</strong>: <em>required (array of DD-T.Node)</em><p>List of Node objects</p><p><strong>Items</strong>: Node</p><div class="items"><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></div></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "tbd http://www.rws.nl/support/matroos"
},
"paging": {
"totalObjectCount": 2,
"prev": null,
"next": null,
"minPageSize": 1,
"maxPageSize": 100
},
"results": [
{
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"baseUrl": "https://www.rws.nl",
"name": "Matroos 1",
"description": "......"
},
{
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz890",
"baseUrl": "https://www.rws.nl",
"name": "Matroos 2",
"description": "......"
}
]
}
</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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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_2_0_nodes__nodeid_"><span class="parent">/dd/2.0/nodes</span>/{nodeId}</a> <span class="methods"><a href="#dd_2_0_nodes__nodeid__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_2_0_nodes__nodeid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_2_0_nodes__nodeid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Request a specific Node by its unique dentifier.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_2_0_nodes__nodeid__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/2.0/nodes</span>/{nodeId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Request a specific Node by its unique dentifier.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_2_0_nodes__nodeid__get_request" data-toggle="tab">Request</a></li><li><a href="#dd_2_0_nodes__nodeid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_2_0_nodes__nodeid__get_request"><h3>URI Parameters</h3><ul><li><strong>nodeId</strong>: <em>required (string)</em><p>An identifier can be anything expressed by a string.</p></li></ul><h3>Query Parameters</h3><ul><li><strong>process</strong>: <em>(string)</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_2_0_nodes__nodeid__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>: object</p><strong>Properties</strong><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><li><strong>provider</strong>: <em>required (object)</em><p>The system that generated the response.</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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz890",
"baseUrl": "https://www.rws.nl",
"name": "Matroos 2",
"description": "......",
"provider": {
"name": "Matroos",
"supportUrl": "tbd http://www.rws.nl/support/matroos"
}
}
</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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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_2_0_sources"><span class="parent">/dd/2.0</span>/sources</a> <span class="methods"><a href="#dd_2_0_sources_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_2_0_sources" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_2_0_sources_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>A (data)source describes the source of the data. A node can have multiple data sources.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_2_0_sources_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/2.0</span>/sources</h4></div><div class="modal-body"><div class="alert alert-info"><p>A (data)source describes the source of the data. A node can have multiple data sources.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_2_0_sources_get_request" data-toggle="tab">Request</a></li><li><a href="#dd_2_0_sources_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_2_0_sources_get_request"><h3>Query Parameters</h3><ul><li><strong>process</strong>: <em>(string)</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><li><strong>page</strong>: <em>(integer)</em><p>Page number, starting with 1.</p></li><li><strong>pageSize</strong>: <em>(integer)</em><p>Requested response Page size. Minimum, maximum and default is defined by Provider. Minimum can never be lower than 1.</p></li></ul></div><div class="tab-pane" id="dd_2_0_sources_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>: 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><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li><li><strong>paging</strong>: <em>(object)</em><p>The object contains urls and page size information to support back and forward paging</p><ul><li><strong>totalObjectCount</strong>: <em>(integer)</em><p>The actual number of objects available. When paging is used the response contains a subset of the total obejcts available up to the max page size.</p></li><li><strong>maxPageSize</strong>: <em>(integer - minimum: 1 - maximum: 10000)</em><p>Maximum number of objects in the response. Defined by the Provider of the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>10</code></pre></div></li><li><strong>minPageSize</strong>: <em>(integer - minimum: 1 - maximum: 10000)</em><p>Minimum number of objects in the response. Defined by the Provider of the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>10</code></pre></div></li><li><strong>self</strong>: <em>(union of DD-T.Url or nil)</em><p>Url of the current request.</p></li><li><strong>first</strong>: <em>(union of DD-T.Url or nil)</em><p>Url to the first page of the result set.</p></li><li><strong>prev</strong>: <em>required (union of DD-T.Url or nil)</em><p>Url to the previous page of the result set.</p></li><li><strong>next</strong>: <em>required (union of DD-T.Url or nil)</em><p>Url to the next page of the result set.</p></li><li><strong>last</strong>: <em>(union of DD-T.Url or nil)</em><p>Url to the last page of the result set.</p></li></ul></li><li><strong>results</strong>: <em>required (array of DD-T.Source)</em><p>List of Datasource.</p><p><strong>Items</strong>: Source</p><div class="items"><ul><li><strong>process</strong>: <em>required (string)</em><p>Name of the process.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>measurement, forecast, astronomical, advise</code></pre></div></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><p>An institution is an organisation that produces data for the DD-API.</p><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></div></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "tbd http://www.rws.nl/support/matroos"
},
"paging": {
"totalObjectCount": 2,
"prev": null,
"next": "https://some-url.nl/dd/2.0/sources?process=forecast&pageSize=2&page=2",
"minPageSize": 1,
"maxPageSize": 100
},
"results": [
{
"process": "forecast",
"name": "HIRLAM_7.2",
"description": "Weather forecast model",
"realizationCount": 24,
"institution": {
"name": "KNMI",
"description": "Dutch Weather"
}
},
{
"process": "forecast",
"name": "NATTEVINGERWERK",
"description": "some forecast model",
"realizationCount": 1,
"institution": {
"name": "some institute",
"description": "some unknown institute"
}
}
]
}
</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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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_2_0_locations"><span class="parent">/dd/2.0</span>/locations</a> <span class="methods"><a href="#dd_2_0_locations_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_2_0_locations" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_2_0_locations_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Location objects contains all information required to describe a location.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_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/2.0</span>/locations</h4></div><div class="modal-body"><div class="alert alert-info"><p>Location objects contains all information required to describe a location.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_2_0_locations_get_request" data-toggle="tab">Request</a></li><li><a href="#dd_2_0_locations_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_2_0_locations_get_request"><h3>Query Parameters</h3><ul><li><strong>process</strong>: <em>(string)</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><li><strong>boundingBox</strong>: <em>(array of DD-T.Double - minItems: 4 - maxItems: 4)</em><p>The specification of a bounding box using the longitude and latitude of the most SouthWest point followed by the most NorthEast points (GeoJSON).</p><p><strong>Example</strong>:</p><div class="examples"><p><strong>-bbox</strong>:<br></p><pre><code>[
4.123456,
52.123456,
10.123456,
55.123456
]</code></pre></div></li><li><strong>locationName</strong>: <em>(string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li><li><strong>nodeId</strong>: <em>(string)</em><p>This query parameter is deprecated.</p></li><li><strong>locationCode</strong>: <em>(string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>HVH</code></pre></div></li><li><strong>locationId</strong>: <em>(string)</em><p>An identifier can be anything expressed by a string.</p></li><li><strong>page</strong>: <em>(integer)</em><p>Page number, starting with 1.</p></li><li><strong>pageSize</strong>: <em>(integer)</em><p>Requested response Page size. Minimum, maximum and default is defined by Provider. Minimum can never be lower than 1.</p></li><li><strong>locationFilter</strong>: <em>(string)</em><p>New, optional functionality.</p></li></ul></div><div class="tab-pane" id="dd_2_0_locations_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>: 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><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li><li><strong>paging</strong>: <em>(object)</em><p>The object contains urls and page size information to support back and forward paging</p><ul><li><strong>totalObjectCount</strong>: <em>(integer)</em><p>The actual number of objects available. When paging is used the response contains a subset of the total obejcts available up to the max page size.</p></li><li><strong>maxPageSize</strong>: <em>(integer - minimum: 1 - maximum: 10000)</em><p>Maximum number of objects in the response. Defined by the Provider of the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>10</code></pre></div></li><li><strong>minPageSize</strong>: <em>(integer - minimum: 1 - maximum: 10000)</em><p>Minimum number of objects in the response. Defined by the Provider of the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>10</code></pre></div></li><li><strong>self</strong>: <em>(union of DD-T.Url or nil)</em><p>Url of the current request.</p></li><li><strong>first</strong>: <em>(union of DD-T.Url or nil)</em><p>Url to the first page of the result set.</p></li><li><strong>prev</strong>: <em>required (union of DD-T.Url or nil)</em><p>Url to the previous page of the result set.</p></li><li><strong>next</strong>: <em>required (union of DD-T.Url or nil)</em><p>Url to the next page of the result set.</p></li><li><strong>last</strong>: <em>(union of DD-T.Url or nil)</em><p>Url to the last page of the result set.</p></li></ul></li><li><strong>results</strong>: <em>required (array of DD-T.Location)</em><p>List of Location objects</p><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 (union of DD-T.Geometry or 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><strong>Example</strong>:</p><div class="examples"><pre><code>HVH</code></pre></div></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><ul></ul></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": "Matroos",
"supportUrl": "tbd http://www.rws.nl/support/matroos"
},
"paging": {
"totalObjectCount": 5,
"prev": null,
"next": "https://some-url.nl/dd/2.0/locations?process=forecast&pageSize=2&page=2",
"minPageSize": 1,
"maxPageSize": 100
},
"results": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
4.123456,
52.123456
]
},
"properties": {
"locationName": "Maarssen.Oostkanaaldijk",
"locationNameSpace": "NL.RWS.WM"
}
},
{
"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"
}
}
]
}
</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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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_2_0_locations_geojson"><span class="parent">/dd/2.0/locations</span>/geojson</a> <span class="methods"><a href="#dd_2_0_locations_geojson_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_2_0_locations_geojson" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_2_0_locations_geojson_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve location resources. Response is in GeoJSON FeatureCollection format (see <a href="https://tools.ietf.org/html/rfc7946#page-12">https://tools.ietf.org/html/rfc7946#page-12</a>).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_2_0_locations_geojson_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/2.0/locations</span>/geojson</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve location resources. Response is in GeoJSON FeatureCollection format (see <a href="https://tools.ietf.org/html/rfc7946#page-12">https://tools.ietf.org/html/rfc7946#page-12</a>).</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_2_0_locations_geojson_get_request" data-toggle="tab">Request</a></li><li><a href="#dd_2_0_locations_geojson_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_2_0_locations_geojson_get_request"><h3>Query Parameters</h3><ul><li><strong>process</strong>: <em>(string)</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><li><strong>boundingBox</strong>: <em>(array of DD-T.Double - minItems: 4 - maxItems: 4)</em><p>The specification of a bounding box using the longitude and latitude of the most SouthWest point followed by the most NorthEast points (GeoJSON).</p><p><strong>Example</strong>:</p><div class="examples"><p><strong>-bbox</strong>:<br></p><pre><code>[
4.123456,
52.123456,
10.123456,
55.123456
]</code></pre></div></li><li><strong>locationName</strong>: <em>(string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li><li><strong>nodeId</strong>: <em>(string)</em><p>This query parameter is deprecated.</p></li><li><strong>locationCode</strong>: <em>(string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>HVH</code></pre></div></li><li><strong>locationId</strong>: <em>(string)</em><p>An identifier can be anything expressed by a string.</p></li><li><strong>page</strong>: <em>(integer)</em><p>Page number, starting with 1.</p></li><li><strong>pageSize</strong>: <em>(integer)</em><p>Requested response Page size. Minimum, maximum and default is defined by Provider. Minimum can never be lower than 1.</p></li><li><strong>locationFilter</strong>: <em>(string)</em><p>New, optional functionality.</p></li></ul></div><div class="tab-pane" id="dd_2_0_locations_geojson_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>: object</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
4.123456,
52.123456
]
},
"properties": {
"locationName": "Maarssen.Oostkanaaldijk",
"locationNameSpace": "NL.RWS.WM"
}
},
{
"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"
}
}
]
}
</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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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_2_0_locations__locationid_"><span class="parent">/dd/2.0/locations</span>/{locationId}</a> <span class="methods"><a href="#dd_2_0_locations__locationid__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_2_0_locations__locationid_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Request a specific location by its id. Response is always in GeoJSON Feature format (see <a href="https://tools.ietf.org/html/rfc7946#page-11">https://tools.ietf.org/html/rfc7946#page-11</a>).</p></div><div class="list-group"><div onclick="window.location.href = '#dd_2_0_locations__locationid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Request a specific Location by its unique dentifier.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_2_0_locations__locationid__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/2.0/locations</span>/{locationId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Request a specific Location by its unique dentifier.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_2_0_locations__locationid__get_request" data-toggle="tab">Request</a></li><li><a href="#dd_2_0_locations__locationid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_2_0_locations__locationid__get_request"><h3>URI Parameters</h3><ul><li><strong>locationId</strong>: <em>required (string)</em><p>An identifier can be anything expressed by a string.</p></li></ul><h3>Query Parameters</h3><ul><li><strong>process</strong>: <em>(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_2_0_locations__locationid__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>: 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",
"provider": {
"name": "Matroos",
"supportUrl": "tbd http://www.rws.nl/support/matroos"
}
}
}
</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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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_2_0_observationtypes"><span class="parent">/dd/2.0</span>/observationTypes</a> <span class="methods"><a href="#dd_2_0_observationtypes_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_2_0_observationtypes" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_2_0_observationtypes_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>ObservationType objects describe all attributes to correctly interpret what has been measured, and in what way. It is essential to have the quantity field.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_2_0_observationtypes_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/2.0</span>/observationTypes</h4></div><div class="modal-body"><div class="alert alert-info"><p>ObservationType objects describe all attributes to correctly interpret what has been measured, and in what way. It is essential to have the quantity field.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_2_0_observationtypes_get_request" data-toggle="tab">Request</a></li><li><a href="#dd_2_0_observationtypes_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_2_0_observationtypes_get_request"><h3>Query Parameters</h3><ul><li><strong>process</strong>: <em>(string)</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><li><strong>observationTypeId</strong>: <em>(string)</em><p>An identifier can be anything expressed by a string.</p></li><li><strong>quantity</strong>: <em>(string)</em><p>Retrieve only observation types that contain the specified quantity.</p></li><li><strong>parameterCode</strong>: <em>(string)</em><p>Retrieve only observation types that contain the specified parameter code.</p></li><li><strong>page</strong>: <em>(integer)</em><p>Page number, starting with 1.</p></li><li><strong>pageSize</strong>: <em>(integer)</em><p>Requested response Page size. Minimum, maximum and default is defined by Provider. Minimum can never be lower than 1.</p></li><li><strong>observationTypeFilter</strong>: <em>(string)</em><p>New, optional functionality.</p></li></ul></div><div class="tab-pane" id="dd_2_0_observationtypes_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>: 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><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li><li><strong>paging</strong>: <em>(object)</em><p>The object contains urls and page size information to support back and forward paging</p><ul><li><strong>totalObjectCount</strong>: <em>(integer)</em><p>The actual number of objects available. When paging is used the response contains a subset of the total obejcts available up to the max page size.</p></li><li><strong>maxPageSize</strong>: <em>(integer - minimum: 1 - maximum: 10000)</em><p>Maximum number of objects in the response. Defined by the Provider of the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>10</code></pre></div></li><li><strong>minPageSize</strong>: <em>(integer - minimum: 1 - maximum: 10000)</em><p>Minimum number of objects in the response. Defined by the Provider of the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>10</code></pre></div></li><li><strong>self</strong>: <em>(union of DD-T.Url or nil)</em><p>Url of the current request.</p></li><li><strong>first</strong>: <em>(union of DD-T.Url or nil)</em><p>Url to the first page of the result set.</p></li><li><strong>prev</strong>: <em>required (union of DD-T.Url or nil)</em><p>Url to the previous page of the result set.</p></li><li><strong>next</strong>: <em>required (union of DD-T.Url or nil)</em><p>Url to the next page of the result set.</p></li><li><strong>last</strong>: <em>(union of DD-T.Url or nil)</em><p>Url to the last page of the result set.</p></li></ul></li><li><strong>results</strong>: <em>required (array of DD-T.ObservationType)</em><p>List of ObservationType objects</p><p><strong>Items</strong>: ObservationType</p><div class="items"><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 DD-T.Aspect - minItems: 0)</em><p>An array of aspects.</p><p><strong>Items</strong>: Aspect</p><div class="items"><ul><li><strong>name</strong>: <em>required (string)</em><p>The name of the aspect.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>measurement</code></pre></div></li><li><strong>unit</strong>: <em>required (string)</em><p>Unit of measurement of the aspect.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>m/s</code></pre></div></li></ul></div></li></ul></li></ul></div></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "tbd http://www.rws.nl/support/matroos"
},
"paging": {
"totalObjectCount": 4,
"prev": null,
"next": "https://some-url.nl/dd/2.0/observationTypes?process=forecast&pageSize=2&page=2",
"minPageSize": 1,
"maxPageSize": 100
},
"results": [
{
"url": "https://some-url.nl/dd/2.0/observationTypes/abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"id": "Neerslag",
"quantity": "Neerslag",
"compartment": "LT",
"description": "Neerslag",
"unit": "mm/d"
},
{
"url": "https://some-url.nl/dd/2.0/observationTypes/abcdefgh-ijkl-mnop-qrst-293892832",
"id": "Verdamping",
"quantity": "Verdamping",
"compartment": "LT",
"description": "Verdamping",
"unit": "mm/d"
}
]
}
</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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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_2_0_observationtypes__observationtypeid_"><span class="parent">/dd/2.0/observationTypes</span>/{observationTypeId}</a> <span class="methods"><a href="#dd_2_0_observationtypes__observationtypeid__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_2_0_observationtypes__observationtypeid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_2_0_observationtypes__observationtypeid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Request a specific ObservationType by its unique identifier.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_2_0_observationtypes__observationtypeid__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/2.0/observationTypes</span>/{observationTypeId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Request a specific ObservationType by its unique identifier.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_2_0_observationtypes__observationtypeid__get_request" data-toggle="tab">Request</a></li><li><a href="#dd_2_0_observationtypes__observationtypeid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_2_0_observationtypes__observationtypeid__get_request"><h3>URI Parameters</h3><ul><li><strong>observationTypeId</strong>: <em>required (string)</em><p>An identifier can be anything expressed by a string.</p></li></ul><h3>Query Parameters</h3><ul><li><strong>process</strong>: <em>(string)</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_2_0_observationtypes__observationtypeid__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>: object</p><strong>Properties</strong><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 DD-T.Aspect - minItems: 0)</em><p>An array of aspects.</p><p><strong>Items</strong>: Aspect</p><div class="items"><ul><li><strong>name</strong>: <em>required (string)</em><p>The name of the aspect.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>measurement</code></pre></div></li><li><strong>unit</strong>: <em>required (string)</em><p>Unit of measurement of the aspect.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>m/s</code></pre></div></li></ul></div></li></ul></li><li><strong>provider</strong>: <em>required (object)</em><p>The system that generated the response.</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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"url": "https://some-url.nl/dd/v2/observationtypes/abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"id": "Neerslag",
"quantity": "Neerslag",
"compartment": "LT",
"description": "Neerslag",
"unit": "mm/d",
"provider": {
"name": "Matroos",
"supportUrl": "tbd http://www.rws.nl/support/matroos"
}
}
</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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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_2_0_timeseries"><span class="parent">/dd/2.0</span>/timeseries</a> <span class="methods"><a href="#dd_2_0_timeseries_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_2_0_timeseries" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_2_0_timeseries_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>TimeSeriesType objects describe the type of measurement the timeseries contains. These can be for example raw measurements, but also aggregations or simulations. This information could be needed to correctly interpret the measurement values. A request where both startTime and endTime are omitted returns a response with just the metadata (implicit includeMetaData = true).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_2_0_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/2.0</span>/timeseries</h4></div><div class="modal-body"><div class="alert alert-info"><p>TimeSeriesType objects describe the type of measurement the timeseries contains. These can be for example raw measurements, but also aggregations or simulations. This information could be needed to correctly interpret the measurement values. A request where both startTime and endTime are omitted returns a response with just the metadata (implicit includeMetaData = true).</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_2_0_timeseries_get_request" data-toggle="tab">Request</a></li><li><a href="#dd_2_0_timeseries_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_2_0_timeseries_get_request"><h3>Query Parameters</h3><ul><li><strong>process</strong>: <em>(string)</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><li><strong>startTime</strong>: <em>(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>locationCode</strong>: <em>(string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>HVH</code></pre></div></li><li><strong>locationName</strong>: <em>(string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Hoek-van-Holland</code></pre></div></li><li><strong>sourceName</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>observationTypeId</strong>: <em>(string)</em><p>An identifier can be anything expressed by a string.</p></li><li><strong>realizationCount</strong>: <em>(integer)</em><p>Added Count as this is the name in ObservationType response.</p></li><li><strong>parameterCode</strong>: <em>(string)</em><p>Implementation is optional. Preferably to be implemented by means of the generic filtering mechanism.</p></li><li><strong>quantity</strong>: <em>(string)</em><p>Implementation is optional. Preferably to be implemented by means of the generic filtering mechanism.</p></li><li><strong>valueType</strong>: <em>(string)</em><p>Value type (float, integer, categorized).</p></li><li><strong>nodeId</strong>: <em>(string)</em><p>An identifier can be anything expressed by a string.</p></li><li><strong>qualifier</strong>: <em>(string)</em><p>Filter for the optional qualifier property.</p></li><li><strong>aspectSet</strong>: <em>(string)</em><p>Remark: Only required for systems that implement aspect sets</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>MinimumMaximumAverage</code></pre></div></li><li><strong>quantityName</strong>: <em>(string)</em><p>Remark: Only required for systems that are accessed by RWS's MKK-DL</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>WaterLevel</code></pre></div></li><li><strong>intervalLength</strong>: <em>(string - default: 10min)</em><p>Remark: Only required for systems that are accessed by RWS's MKK-DL</p></li><li><strong>page</strong>: <em>(integer)</em><p>Page number, starting with 1.</p></li><li><strong>pageSize</strong>: <em>(integer)</em><p>Requested response Page size. Minimum, maximum and default is defined by Provider. Minimum can never be lower than 1.</p></li><li><strong>timeseriesFilter</strong>: <em>(string)</em><p>New, optional functionality.</p></li><li><strong>locationFilter</strong>: <em>(string)</em><p>New, optional functionality.</p></li><li><strong>observationTypeFilter</strong>: <em>(string)</em><p>New, optional functionality.</p></li></ul></div><div class="tab-pane" id="dd_2_0_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>: 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><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-07-05T15&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li><li><strong>paging</strong>: <em>(object)</em><p>The object contains urls and page size information to support back and forward paging</p><ul><li><strong>totalObjectCount</strong>: <em>(integer)</em><p>The actual number of objects available. When paging is used the response contains a subset of the total obejcts available up to the max page size.</p></li><li><strong>maxPageSize</strong>: <em>(integer - minimum: 1 - maximum: 10000)</em><p>Maximum number of objects in the response. Defined by the Provider of the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>10</code></pre></div></li><li><strong>minPageSize</strong>: <em>(integer - minimum: 1 - maximum: 10000)</em><p>Minimum number of objects in the response. Defined by the Provider of the response.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>10</code></pre></div></li><li><strong>self</strong>: <em>(union of DD-T.Url or nil)</em><p>Url of the current request.</p></li><li><strong>first</strong>: <em>(union of DD-T.Url or nil)</em><p>Url to the first page of the result set.</p></li><li><strong>prev</strong>: <em>required (union of DD-T.Url or nil)</em><p>Url to the previous page of the result set.</p></li><li><strong>next</strong>: <em>required (union of DD-T.Url or nil)</em><p>Url to the next page of the result set.</p></li><li><strong>last</strong>: <em>(union of DD-T.Url or nil)</em><p>Url to the last page of the result set.</p></li></ul></li><li><strong>results</strong>: <em>required (array of DD-T.Timeseries)</em><p>List of Timeseries objects</p><p><strong>Items</strong>: Timeseries</p><div class="items"><ul><li><strong>node</strong>: <em>(object)</em><p>Node objects contain the properties of the DD-node that contains the data. A node is an operational implementation of the Digital Delta specification.</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>An identifier can be anything expressed by a string.</p></li><li><strong>source</strong>: <em>required (object)</em><p>Describes the type of data in the time series, and the owner of the data.</p><ul><li><strong>process</strong>: <em>required (string)</em><p>Name of the process.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>measurement, forecast, astronomical, advise</code></pre></div></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><p>An institution is an organisation that produces data for the DD-API.</p><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>Generic DD API 2.0 Location object, structured according to GeoJSON. Most attributes are optional, since the content returned in the response depends on whether it is a /dd or a /dd-oper request. Location attributes are placed within the properties group of the GeoJSON object.</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 (union of DD-T.Geometry or 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><strong>Example</strong>:</p><div class="examples"><pre><code>HVH</code></pre></div></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><ul></ul></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></li><li><strong>observationType</strong>: <em>required (object)</em><p>Generic DD API 2.0 quantity/parameter object. The DD-OPER API response returns a subset of the attributes.</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 DD-T.Aspect - minItems: 0)</em><p>An array of aspects.</p><p><strong>Items</strong>: Aspect</p><div class="items"><ul><li><strong>name</strong>: <em>required (string)</em><p>The name of the aspect.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>measurement</code></pre></div></li><li><strong>unit</strong>: <em>required (string)</em><p>Unit of measurement of the aspect.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>m/s</code></pre></div></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>(union of number or string)</em><p>The type of values in the time series ('string' in case of categorized values, like 'natuurlijk' vs 'aangelegd'). Also known as QuantityValue.</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 DD-T.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 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>resultTime</strong>: <em>(datetime)</em><p>Result time.</p></li><li><strong>value</strong>: <em>(union of number or string)</em><p>The type of values in the time series ('string' in case of categorized values, like 'natuurlijk' vs 'aangelegd'). Also known as QuantityValue.</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>Defines the quality of the result (confidence).</p></li><li><strong>additionalQuality</strong>: <em>(number)</em><p>Provides detailed information on specific Quality numbers.</p></li><li><strong>aspects</strong>: <em>(array of union)</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 DD-T.PointsValue)</em><p><strong>Items</strong>: PointsValue</p><div class="items"><ul><li><strong>coordinates</strong>: <em>required (array of DD-T.Double - minItems: 2 - maxItems: 3)</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 of number or string)</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": "Matroos",
"supportUrl": "tbd http://www.rws.nl/support/matroos",
"apiVersion": "2.0",
"responseType": "TimeseriesListResponse",
"responseTimestamp": "2018-07-05T15:11:36.123456Z"
},
"paging": {
"totalObjectCount": 2,
"prev": null,
"next": "https://some-url.nl/dd/2.0/sources?process=forecast&pageSize=2&page=2",
"minPageSize": 1,
"maxPageSize": 100
},
"results": [
{
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"url": "https://some-url.nl/dd/v2/timeseries/abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"node": {
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"baseUrl": "https://www.rws.nl",
"name": "Matroos 1",
"description": "......"
},
"source": {
"process": "forecast",
"name": "HIRLAM_7.2",
"description": "Weather forecast model",
"realizationCount": 24,
"institution": {
"name": "KNMI",
"description": "Dutch We...."
}
},
"location": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
4.709151955388156,
52.74587223407126,
0
]
},
"properties": {
"node": {
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"baseUrl": "https://www.rws.nl",
"name": "Matroos 1",
"description": "......"
},
"url": "https://some-url.nl/dd/v2/locations/abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"locationId": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"locationCode": "ResultLocA",
"locationName": "HIRLAM result location A",
"locationNameSpace": "NL.RWS.WM"
}
},
"observationType": {
"url": "https://some-url.nl/dd/v2/observationtypes/abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"id": "Neerslag",
"quantity": "Neerslag",
"compartment": "LT",
"description": "Neerslag",
"unit": "mm/d"
},
"analysisTime": "2010-12-12T15:15:00Z",
"startTime": "2010-12-12T16:00:00Z",
"endTime": "2010-12-12T18:00:00Z",
"realization": 13,
"events": [
{
"timeStamp": "2010-12-12T16:00:00Z",
"value": 6.46
},
{
"timeStamp": "2010-12-12T17:00:00Z",
"value": 4.4
},
{
"timeStamp": "2010-12-12T18:00:00Z",
"value": 4.86
}
]
},
{
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"url": "https://some-url.nl/dd/v2/timeseries/abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"node": {
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"baseUrl": "https://some-waterboard-lizard.nl/dd/v2/nodes/abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"name": "Lizard",
"description": "......"
},
"source": {
"process": "measurement",
"institution": {
"name": "Aa en Maas",
"description": "Waterboard Aa en Maas"
}
},
"location": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
4.80,
52.2
]
},
"properties": {
"node": {
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"baseUrl": "https://some-waterboard-lizard.nl/dd/v2/nodes/abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"name": "Lizard",
"description": "......"
},
"url": "https://some-url.nl/dd/v2/locations/abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"locationId": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"locationCode": "STUW_A_BOVEN",
"locationName": "Lith.Stuw-A-boven"
}
},
"observationType": {
"url": "https://some-url.nl/dd/v2/observationtypes/abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"quantity": "waterhoogte",
"parameterCode": "WATHTE",
"compartment": "OW",
"description": "Water level, average in 10 min intervals",
"unit": "m"
},
"startTime": "2010-12-12T16:00:00Z",
"endTime": "2010-12-12T18:00:00Z",
"events": [
{
"timeStamp": "2010-12-12T16:00:00Z",
"value": 6.46,
"quality": 0
},
{
"timeStamp": "2010-12-12T17:00:00Z",
"value": 4.4,
"quality": 0
},
{
"timeStamp": "2010-12-12T18:00:00Z",
"value": 4.86,
"quality": 0
}
]
},
{
"id": "Maarssen.Oostkanaaldijk.Concentration.Phosphor",
"url": "https://some-url.nl/dd/v2/timeseries/Maarssen.Oostkanaaldijk.Concentration.Phosphor",
"node": {
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"baseUrl": "https://www.rws.nl",
"name": "LMW-Next",
"description": "......"
},
"source": {
"process": "measurement",
"institution": {
"name": "RWS",
"description": "Waterboard Aa en Maas"
}
},
"location": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
4.750563993334143,
53.02409080390675
]
},
"properties": {
"node": {
"id": "abcdefgh-ijkl-mnop-qrst-uvwxyz123456",
"baseUrl": "https://www.rws.nl",
"name": "LMW-Next",
"description": "......"
},
"url": "https://some-url.nl/dd/v2/locations/NL.RWS.WM.Maarssen.Oostkanaaldijk",
"locationId": "NL.RWS.WM.Maarssen.Oostkanaaldijk",
"locationCode": "OSTKDK",
"locationName": "Maarssen.Oostkanaaldijk",
"parentName": "noordzeekanaal-amsterdamrijnkanaal",
"locationNameSpace": "NL.RWS.WM"
}
},
"observationType": {
"url": "https://some-url.nl/dd/v2/observationtypes/Concentration.Phosphor",
"id": "Concentration.Phosphor",
"quantity": "Concentration",
"unit": "ppm",
"parameterCode": "Phosphor",
"compartment": "OW"
},
"startTime": "2010-12-12T16:00:00Z",
"endTime": "2010-12-12T21:00:00Z",
"events": [
{
"timeStamp": "2010-12-12T16:00:00Z",
"startTime": "2010-12-12T15:30:00Z",
"endTime": "2010-12-12T16:29:59Z",
"resultTime": "2010-12-12T16:35:00Z",
"value": 0.46
},
{
"timeStamp": "2010-12-12T17:00:00Z",
"startTime": "2010-12-12T16:30:00Z",
"endTime": "2010-12-12T17:29:59Z",
"resultTime": "2010-12-12T17:35:00Z",
"value": 0.4
},
{
"timeStamp": "2010-12-12T18:00:00Z",
"startTime": "2010-12-12T16:30:00Z",
"endTime": "2010-12-12T17:29:59Z",
"resultTime": "2010-12-12T17:35:00Z",
"value": 0.36
},
{
"timeStamp": "2010-12-12T19:00:00Z",
"startTime": "2010-12-12T18:30:00Z",
"endTime": "2010-12-12T19:29:59Z",
"resultTime": "2010-12-12T19:35:00Z",
"value": 0.27
},
{
"timeStamp": "2010-12-12T20:00:00Z",
"startTime": "2010-12-12T19:30:00Z",
"endTime": "2010-12-12T20:29:59Z",
"resultTime": "2010-12-12T20:35:00Z",
"value": 0.26
},
{
"timeStamp": "2010-12-12T21:00:00Z",
"startTime": "2010-12-12T20:30:00Z",
"endTime": "2010-12-12T21:29:59Z",
"resultTime": "2010-12-12T21:35:00Z",
"value": 0.3
}
]
}
]
}
</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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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>: object</p><strong>Properties</strong><ul><li><strong>type</strong>: <em>(string)</em><p>Type of error.</p></li><li><strong>title</strong>: <em>(string)</em><p>Title of the error.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Error processing the request.</code></pre></div></li><li><strong>status</strong>: <em>(integer)</em><p>The HTTP error code number (HTTP Status Code).</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>404</code></pre></div></li><li><strong>detail</strong>: <em>(string)</em><p>Details of the error</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Request resulted in a response that was too large.</code></pre></div></li><li><strong>instance</strong>: <em>(union of string or nil)</em><p>Reference to the error for the provider.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>https://myservice/meaningOrError400</code></pre></div></li><li><strong>errors</strong>: <em>(array of DD-T.FilterError)</em><p>Error details. More than one error can occur within the problem.</p><p><strong>Items</strong>: FilterError</p><div class="items"><ul><li><strong>errorType</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Unknown comparer.</code></pre></div></li><li><strong>context</strong>: <em>required (string)</em><p><strong>Example</strong>:</p><div class="examples"><pre><code>Field 'locationCode'.</code></pre></div></li></ul></div></li><li><strong>typeinfo</strong>: <em>(union of string or nil)</em><p>Link to information on the type of error. ??? Why not use 'type'. is link according RFC7807</p></li><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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"provider": {
"name": "Matroos",
"supportUrl": "http://www.rws.nl/support/matroos",
"apiVersion": "2.0"
},
"type": "https://content.matroos.rws.nl/ValidatieFout",
"title": "Hier staat wat er mis is gegaan",
"status": 404,
"detail": "Verplichte query parameter ontbreekt.",
"instance": "urn: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_2_0_timeseries__timeseriesid_"><span class="parent">/dd/2.0/timeseries</span>/{timeseriesId}</a> <span class="methods"><a href="#dd_2_0_timeseries__timeseriesid__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_dd_2_0_timeseries__timeseriesid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#dd_2_0_timeseries__timeseriesid__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Request a specific (single) Timeseries by its unique identifier.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="dd_2_0_timeseries__timeseriesid__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/2.0/timeseries</span>/{timeseriesId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Request a specific (single) Timeseries by its unique identifier.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#dd_2_0_timeseries__timeseriesid__get_request" data-toggle="tab">Request</a></li><li><a href="#dd_2_0_timeseries__timeseriesid__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="dd_2_0_timeseries__timeseriesid__get_request"><h3>URI Parameters</h3><ul><li><strong>timeseriesId</strong>: <em>required (string)</em><p>An identifier can be anything expressed by a string.</p></li></ul><h3>Query Parameters</h3><ul><li><strong>process</strong>: <em>(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_2_0_timeseries__timeseriesid__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>: object</p><strong>Properties</strong><ul><li><strong>node</strong>: <em>(object)</em><p>Node objects contain the properties of the DD-node that contains the data. A node is an operational implementation of the Digital Delta specification.</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>An identifier can be anything expressed by a string.</p></li><li><strong>source</strong>: <em>required (object)</em><p>Describes the type of data in the time series, and the owner of the data.</p><ul><li><strong>process</strong>: <em>required (string)</em><p>Name of the process.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>measurement, forecast, astronomical, advise</code></pre></div></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><p>An institution is an organisation that produces data for the DD-API.</p><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>Generic DD API 2.0 Location object, structured according to GeoJSON. Most attributes are optional, since the content returned in the response depends on whether it is a /dd or a /dd-oper request. Location attributes are placed within the properties group of the GeoJSON object.</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 (union of DD-T.Geometry or 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><strong>Example</strong>:</p><div class="examples"><pre><code>HVH</code></pre></div></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><ul></ul></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></li><li><strong>observationType</strong>: <em>required (object)</em><p>Generic DD API 2.0 quantity/parameter object. The DD-OPER API response returns a subset of the attributes.</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 DD-T.Aspect - minItems: 0)</em><p>An array of aspects.</p><p><strong>Items</strong>: Aspect</p><div class="items"><ul><li><strong>name</strong>: <em>required (string)</em><p>The name of the aspect.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>measurement</code></pre></div></li><li><strong>unit</strong>: <em>required (string)</em><p>Unit of measurement of the aspect.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>m/s</code></pre></div></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>(union of number or string)</em><p>The type of values in the time series ('string' in case of categorized values, like 'natuurlijk' vs 'aangelegd'). Also known as QuantityValue.</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 DD-T.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 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>resultTime</strong>: <em>(datetime)</em><p>Result time.</p></li><li><strong>value</strong>: <em>(union of number or string)</em><p>The type of values in the time series ('string' in case of categorized values, like 'natuurlijk' vs 'aangelegd'). Also known as QuantityValue.</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>Defines the quality of the result (confidence).</p></li><li><strong>additionalQuality</strong>: <em>(number)</em><p>Provides detailed information on specific Quality numbers.</p></li><li><strong>aspects</strong>: <em>(array of union)</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 DD-T.PointsValue)</em><p><strong>Items</strong>: PointsValue</p><div class="items"><ul><li><strong>coordinates</strong>: <em>required (array of DD-T.Double - minItems: 2 - maxItems: 3)</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 of number or string)</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><li><strong>provider</strong>: <em>required (object)</em><p>The system that generated the response.</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&colon;11&colon;36.123Z, 2018-07-05T15&colon;11&colon;36.123456Z, 2018-07-05T15&colon;11&colon;36.000Z</code></pre></div></li></ul></li></ul><p><strong>Example</strong>:</p><div class="examples"><pre><code>{
"node": {
"name": "LMW-Next",
"baseUrl": "https://www.rws.nl",
"description": "......"
},
"source": {
"process": "forecast",
"institution": {
"name": "RWS",
"description": "...."
}
},
"location": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
4.750563993334143,
53.02409080390675
]
},
"properties": {
"locationId": "NL.RWS.WM.Maarssen.Oostkanaaldijk",
"locationCode": "OSTKDK",
"locationName": "Maarssen.Oostkanaaldijk",
"locationNameSpace": "NL.RWS.WM"
}
},
"observationType": {
"id": "WaterLevel",
"quantity": "WaterLevel",
"unit": "m",
"compartment": "OW"
},
"startTime": "2010-12-12T16:00:00Z",
"endTime": "2010-12-12T21:00:00Z",
"events": [
{
"timeStamp": "2010-12-12T16:00:00Z",
"startTime": "2010-12-12T15:30:00Z",
"endTime": "2010-12-12T16:29:59Z",
"resultTime": "2010-12-12T16:35:00Z",
"value": 0.46
},
{
"timeStamp": "2010-12-12T17:00:00Z",
"startTime": "2010-12-12T16:30:00Z",
"endTime": "2010-12-12T17:29:59Z",
"resultTime": "2010-12-12T17:35:00Z",
"value": 0.4
},
{
"timeStamp": "2010-12-12T18:00:00Z",
"startTime": "2010-12-12T16:30:00Z",
"endTime": "2010-12-12T17:29:59Z",
"resultTime": "2010-12-12T17:35:00Z",
"value": 0.36
},
{
"timeStamp": "2010-12-12T19:00:00Z",
"startTime": "2010-12-12T18:30:00Z",
"endTime": "2010-12-12T19:29:59Z",
"resultTime": "2010-12-12T19:35:00Z",
"value": 0.27
},
{
"timeStamp": "2010-12-12T20:00:00Z",
"startTime": "2010-12-12T19:30:00Z",
"endTime": "2010-12-12T20:29:59Z",
"resultTime": "2010-12-12T20:35:00Z",
"value": 0.26
},
{
"timeStamp": "2010-12-12T21:00:00Z",
"startTime": "2010-12-12T20:30:00Z",
"endTime": "2010-12-12T21:29:59Z",
"resultTime": "2010-12-12T21:35:00Z",
"value": 0.3
}
],