-
Notifications
You must be signed in to change notification settings - Fork 7
/
apiary.apib
4061 lines (3145 loc) · 140 KB
/
apiary.apib
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
FORMAT: 1A
HOST: http://localhost
# gost
GOST (Go-SensorThings) is an IoT Platform written in Golang (Go). It implements the Sensing profile (part 1) of the OGC SensorThings API.
The OGC SensorThings API provides an open standard-based and geospatial-enabled framework to interconnect the Internet of Things devices, data, and applications over the Web.
Official OGC documentation can be found here: http://docs.opengeospatial.org/is/15-078r6/15-078r6.html
**Paging**
Responses that include only a partial set of the items identified by the request URL contain a link that allows retrieving the next partial set of items. This link is called a nextLink; its representation is format-specific. The final partial set of items shall not contain a nextLink.
The nextLink annotation indicates that a response is only a subset of the requested collection of entities or collection of entity references. It contains a URL that allows retrieving the next subset of the requested collection.
SensorThings clients shall treat the URL of the nextLink as opaque, and shall not append system query options to the URL of a next link. Services may not allow a change of format on requests for subsequent pages using the next link.
## Version [/version]
### Get version info [GET]
Retrieve the current running GOST server and SensorThings API version
+ Response 200 (application/json)
+ Body
{
"gostServerVersion": {
"version": "v0.5"
},
"sensorThingsApiVersion": {
"version": "v1.0"
}
}
## Root [/v1.0]
Access to all resources begins at the base resource path.
Navigating to the base resource path will return a JSON array of the available SensorThings resource endpoints.
### Get SensorThings resource endpoints [GET]
+ Response 200 (application/json)
{
"value": [
{
"name": "Things",
"url": "http://localhost/v1.0/Things"
},
{
"name": "Datastreams",
"url": "http://localhost/v1.0/Datastreams"
},
{
"name": "ObservedProperties",
"url": "http://localhost/v1.0/ObservedProperties"
},
{
"name": "HistoricalLocations",
"url": "http://localhost/v1.0/HistoricalLocations"
},
{
"name": "Locations",
"url": "http://localhost/v1.0/Locations"
},
{
"name": "Sensors",
"url": "http://localhost/v1.0/Sensors"
},
{
"name": "Observations",
"url": "http://localhost/v1.0/Observations"
},
{
"name": "FeaturesOfInterest",
"url": "http://localhost/v1.0/FeaturesOfInterest"
}
]
}
## Things [/v1.0/Things]
Thing in SensorThings represents a physical object in the real world. A Thing is a good starting
point in which to start creating the SensorThings model structure. A Thing has a Location and one or
more Datastreams to collect Observations. A minimal Thing can be created without a Location and Datastream
and there are options to create a Things with a nested linked Location and Datastream.
| Property | Required | Type | Definition |
|:---------|----------|------|-------------|
|`name`|mandatory|string|A property provides a label for Thing entity, commonly a descriptive name|
|`description`|mandatory|string|This is a short description of the corresponding Thing entity|
|`properties`|optional|JSON object|A JSON Object containing user-annotated properties as key-value pairs|
| Related entity | Required |
|:---------|----------|
|`Locations`|optional|
|`HistoricalLocations`|optional|
|`Datastreams`|optional|
### Get Things [GET]
+ Request
Retrieve all Things.
+ Body
+ Response 200 (application/json)
{
"@iot.count": 2,
"value": [
{
"@iot.id": 2,
"@iot.selfLink": "http://localhost/v1.0/Things(2)",
"name": "Netatmo 2",
"description": "Netatmo PK",
"properties": {
"organisation": "Geodan",
"owner": "Henk"
},
"Locations@iot.navigationLink": "http://localhost/v1.0/Things(2)/Locations",
"Datastreams@iot.navigationLink": "http://localhost/v1.0/Things(2)/Datastreams",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Things(2)/HistoricalLocations"
},
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Things(1)",
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Locations@iot.navigationLink": "http://localhost/v1.0/Things(1)/Locations",
"Datastreams@iot.navigationLink": "http://localhost/v1.0/Things(1)/Datastreams",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Things(1)/HistoricalLocations"
}
]
}
### Get Thing by id [GET /v1.0/Things({id})]
+ Parameters
+ id (number) - {INT} id of the Thing to retrieve
+ Request
Retrieve a specific Thing by given id.
+ Body
+ Response 200 (application/json)
+ Body
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Things(1)",
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Locations@iot.navigationLink": "http://localhost/v1.0/Things(1)/Locations",
"Datastreams@iot.navigationLink": "http://localhost/v1.0/Things(1)/Datastreams",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Things(1)/HistoricalLocations"
}
+ Response 404 (application/json)
+ Body
{
"error": {
"status": "Not Found",
"code": 404,
"message": [
"Thing not found"
]
}
}
### Get Things by Location [GET /v1.0/Locations({id})/Things]
+ Parameters
+ id (number) - {INT} ID of the Location to retrieve the things for
+ Request
Get all Things related to the specified Location
+ Body
+ Response 200 (application/json)
{
"@iot.count": 1,
"value": [
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Things(1)",
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Locations@iot.navigationLink": "http://localhost/v1.0/Things(1)/Locations",
"Datastreams@iot.navigationLink": "http://localhost/v1.0/Things(1)/Datastreams",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Things(1)/HistoricalLocations"
}
]
}
### Get Thing by HistoricalLocation [GET /v1.0/HistoricalLocations({id})/Thing]
+ Parameters
+ id (number) - {INT} ID of the HistoricalLocations to retrieve the Thing for
+ Request
Get Thing related to the specified HistoricalLocation
+ Body
+ Response 200 (application/json)
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Things(1)",
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Locations@iot.navigationLink": "http://localhost/v1.0/Things(1)/Locations",
"Datastreams@iot.navigationLink": "http://localhost/v1.0/Things(1)/Datastreams",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Things(1)/HistoricalLocations"
}
### Get Thing by Datastream [GET /v1.0/Datastreams({id})/Thing]
+ Parameters
+ id (number) - {INT} ID of the Datastream to retrieve the Thing for
+ Request
Get Thing related to the specified Datastream
+ Body
+ Response 200 (application/json)
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Things(1)",
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Locations@iot.navigationLink": "http://localhost/v1.0/Things(1)/Locations",
"Datastreams@iot.navigationLink": "http://localhost/v1.0/Things(1)/Datastreams",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Things(1)/HistoricalLocations"
}
### Post Thing [POST]
+ Request (application/json)
Add a new Thing to the Things collection
+ Body
{
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
}
}
+ Response 201 (application/json)
+ Headers
Location: /v1.0/Things(1)
+ Body
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Things(1)",
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Locations@iot.navigationLink": "http://localhost/v1.0/Things(1)/Locations",
"Datastreams@iot.navigationLink": "http://localhost/v1.0/Things(1)/Datastreams",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Things(1)/HistoricalLocations"
}
### Post Thing with new Location [POST]
+ Request (application/json)
Add a new Thing to the Things collection including a new Location
+ Body
{
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Locations": [
{
"name": "President Kennedylaan 1",
"description": "Geodan building Amsterdam",
"encodingType": "application/vnd.geo+json",
"location": {
"type": "Point",
"coordinates": [4.91320,
52.34227]
}
}
]
}
+ Response 201 (application/json)
+ Headers
Location: /v1.0/Things(1)
+ Body
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Things(1)",
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Datastreams@iot.navigationLink": "http://localhost/v1.0/Things(1)/Datastreams",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Things(1)/HistoricalLocations",
"Locations": [
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Locations(1)",
"name": "President Kennedylaan 1",
"description": "Geodan building Amsterdam",
"encodingType": "application/vnd.geo+json",
"location": {
"type": "Point",
"coordinates": [4.91320,
52.34227]
},
"Things@iot.navigationLink": "http://localhost/v1.0/Locations(1)/Things",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Locations(1)/HistoricalLocations"
}
]
}
+ Response 400 (application/json)
+ Body
{
"error": {
"status": "Bad Request",
"code": 400,
"message": [
"Missing mandatory parameter: ....."
]
}
}
### Post Thing with existing Location [POST]
+ Request (application/json)
Add a new Thing to the Things collection linking an existing Location to it
+ Body
{
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Locations": [
{"@iot.id":"1"}
]
}
+ Response 201 (application/json)
+ Headers
Location: /v1.0/Things(1)
+ Body
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Things(1)",
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Datastreams@iot.navigationLink": "http://localhost/v1.0/Things(1)/Datastreams",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Things(1)/HistoricalLocations",
"Locations": [
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Locations(1)",
"Things@iot.navigationLink": "http://localhost/v1.0/Locations(1)/Things",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Locations(1)/HistoricalLocations"
}
]
}
+ Response 400 (application/json)
+ Body
{
"error": {
"status": "Bad Request",
"code": 400,
"message": [
"Location does not exist",
]
}
}
### Post Thing ULTIMATE [POST]
+ Request (application/json)
Add a new Thing with Location and Datastream including a new Sensor, ObservedProperty and Observation
+ Body
{
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Locations": [
{
"name": "President Kennedylaan 1",
"description": "Geodan building Amsterdam",
"encodingType": "application/vnd.geo+json",
"location": {
"type": "Point",
"coordinates": [4.91320,
52.34227]
}
}
],
"Datastreams": [{
"name": "Temperature",
"unitOfMeasurement": {
"name": "Celsius",
"symbol": "C",
"definition": "http://www.qudt.org/qudt/owl/1.0.0/unit/Instances.html#Celsius"
},
"description": "Temperature measurement",
"observationType": "http://www.opengis.net/def/observationType/OGC-OM/2.0/OM_Measurement",
"ObservedProperty": {
"name": "Temperature",
"definition": "http://www.qudt.org/qudt/owl/1.0.0/quantity/Instances.html#Temperature",
"description": "Temperature in situ"
},
"Sensor": {
"name": "DHT22",
"description": "Digital temperature and humidity sensor",
"encodingType": "application/pdf",
"metadata": "https://www.sparkfun.com/datasheets/Sensors/Temperature/DHT22.pdf"
},
"Observations": [
{
"phenomenonTime": "2017-07-21T11:48:21.321Z",
"resultTime" : "2017-07-21T11:48:21.321Z",
"result" : 38
}
]
}]
}
+ Response 201 (application/json)
+ Headers
Location: /v1.0/Things(1)
+ Body
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost:8080/v1.0/Things(1)",
"name": "Netatmo 1",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"HistoricalLocations@iot.navigationLink": "http://localhost:8080/v1.0/Things(1)/HistoricalLocations",
"Locations": [
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost:8080/v1.0/Locations(1)",
"name": "President Kennedylaan 1",
"description": "Geodan building Amsterdam",
"encodingType": "application/vnd.geo+json",
"location": {
"coordinates": [
4.9132,
52.34227
],
"type": "Point"
},
"Things@iot.navigationLink": "http://localhost:8080/v1.0/Locations(1)/Things",
"HistoricalLocations@iot.navigationLink": "http://localhost:8080/v1.0/Locations(1)/HistoricalLocations"
}
],
"Datastreams": [
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost:8080/v1.0/Datastreams(1)",
"name": "Temperature",
"description": "Temperature measurement",
"unitOfMeasurement": {
"definition": "http://www.qudt.org/qudt/owl/1.0.0/unit/Instances.html#Celsius",
"name": "Celsius",
"symbol": "C"
},
"observationType": "http://www.opengis.net/def/observationType/OGC-OM/2.0/OM_Measurement",
"Thing@iot.navigationLink": "http://localhost:8080/v1.0/Datastreams(1)/Thing",
"Sensor@iot.navigationLink": "http://localhost:8080/v1.0/Datastreams(1)/Sensor",
"ObservedProperty@iot.navigationLink": "http://localhost:8080/v1.0/Datastreams(1)/ObservedProperty",
"Observations": [
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost:8080/v1.0/Observations(1)",
"phenomenonTime": "2017-07-21T11:48:21.321Z",
"result": 38,
"Datastream@iot.navigationLink": "http://localhost:8080/v1.0/Observations(1)/Datastream",
"FeatureOfInterest@iot.navigationLink": "http://localhost:8080/v1.0/Observations(1)/FeatureOfInterest",
"resultTime": "2017-07-21T11:48:21.321Z"
}
]
}
]
}
+ Response 400 (application/json)
+ Body
{
"error": {
"status": "Bad Request",
"code": 400,
"message": [
...,
]
}
}
### Patch Thing [PATCH /v1.0/Things({id})]
+ Parameters
+ id (number) - {INT} ID of Thing to patch
+ Request (application/json)
Patch a specified Thing
+ Body
{
"name": "ALL YOUR BASE",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
},
"Locations": [
{
"@iot.id": "1"
}
]
}
+ Response 200 (application/json)
+ Body
{
"@iot.id": 1,
"name": "ALL YOUR BASE",
"description": "Netatmo VZ",
"properties": {
"organisation": "Geodan",
"owner": "Tim"
}
}
+ Response 404 (application/json)
+ Body
{
"error": {
"status": "Not Found",
"code": 404,
"message": [
"thing not found"
]
}
}
### Delete Thing [DELETE /v1.0/Things({id})]
+ Parameters
+ id (number) - {INT} ID of thing to delete
+ Response 200 (application/json)
Delete a specified Thing from the Things collection
+ Body
+ Response 404 (application/json)
+ Body
{
"error": {
"status": "Not Found",
"code": 404,
"message": [
"thing not found"
]
}
}
## Locations [/v1.0/Locations]
The Location entity locates the Thing(s) it associated with. A Thing’s Location entity is defined as the last known location of the Thing.
A Thing can have multiple Locations if all Locations are different representations of same Location with different encodingType.
| Property | Required | Type | Definition |
|:---------|----------|------|-------------|
|`name`|mandatory|string|A property provides a label for Location entity, commonly a descriptive name|
|`description`|mandatory|string|The description about the Location|
|`encodingType`|mandatory|ValueCode|The encoding type of the Location property. Its value is one of the ValueCode enumeration|
|`location`|mandatory|Any (Depends on encodingType)|The location type is defined by encodingType|
| encodingType ValueCodes | Type |
|:---------|---------|
|`application/vnd.geo+json`|GeoJSON|
| Related entity | Required |
|:---------|----------|
|`Things`|optional|
|`HistoricalLocations`|optional|
### Get Locations [GET]
+ Request
Retrieve all Locations.
+ Body
+ Response 200 (application/json)
{
"@iot.count": 2,
"value": [
{
"@iot.id": 2,
"@iot.selfLink": "http://localhost/v1.0/Locations(2)",
"name": "Buitenhaven 27-A",
"description": "Geodan building 's-Hertogenbosch",
"encodingType": "application/vnd.geo+json",
"location": {
"type": "Point",
"coordinates": [5.29969,
51.69176]
},
"Things@iot.navigationLink": "http://localhost/v1.0/Locations(2)/Things",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Locations(2)/HistoricalLocations"
},
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Locations(1)",
"name": "President Kennedylaan 1",
"description": "Geodan building Amsterdam",
"encodingType": "application/vnd.geo+json",
"location": {
"type": "Point",
"coordinates": [4.91320,
52.34227]
},
"Things@iot.navigationLink": "http://localhost/v1.0/Locations(1)/Things",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Locations(1)/HistoricalLocations"
}
]
}
### Get Location by id [GET /v1.0/Locations({id})]
+ Parameters
+ id (number) - {INT} id of the Location to retrieve
+ Request
Retrieve a specific Location by given id.
+ Body
+ Response 200 (application/json)
+ Body
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Locations(1)",
"name": "President Kennedylaan 1",
"description": "Geodan building Amsterdam",
"encodingType": "application/vnd.geo+json",
"location": {
"type": "Point",
"coordinates": [4.91320,
52.34227]
},
"Things@iot.navigationLink": "http://localhost/v1.0/Locations(1)/Things",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Locations(1)/HistoricalLocations"
}
+ Response 404 (application/json)
+ Body
{
"error": {
"status": "Not Found",
"code": 404,
"message": [
"location not found"
]
}
}
### Get Locations by Thing [GET /v1.0/Things({id})/Locations]
+ Parameters
+ id (number) - {INT} id of the Thing to retrieve Locations for
+ Request
Retrieve locations by specified Thing
+ Body
+ Response 200 (application/json)
+ Body
{
"@iot.count": 1,
"value": [
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Locations(1)",
"name": "President Kennedylaan 1",
"description": "Geodan building",
"encodingType": "application/vnd.geo+json",
"location": {
"coordinates": [
4.9132,
52.34227
],
"type": "Point"
},
"Things@iot.navigationLink": "http://localhost/v1.0/Locations(1)/Things",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Locations(1)/HistoricalLocations"
}
]
}
+ Response 404 (application/json)
+ Body
{
"error": {
"status": "Not Found",
"code": 404,
"message": [
"Thing not found"
]
}
}
### Get Locations by HistoricalLocations [GET /v1.0/HistoricalLocations({id})/Locations]
+ Parameters
+ id (number) - {INT} id of the HistoricalLocation to retrieve Locations for
+ Request
Retrieve locations by specified HistoricalLocation
+ Body
+ Response 200 (application/json)
+ Body
{
"@iot.count": 1,
"value": [
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Locations(1)",
"name": "President Kennedylaan 1",
"description": "Geodan building",
"encodingType": "application/vnd.geo+json",
"location": {
"coordinates": [
4.9132,
52.34227
],
"type": "Point"
},
"Things@iot.navigationLink": "http://localhost/v1.0/Locations(1)/Things",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Locations(1)/HistoricalLocations"
}
]
}
+ Response 404 (application/json)
+ Body
{
"error": {
"status": "Not Found",
"code": 404,
"message": [
"HistoricalLocation not found"
]
}
}
### Post Location [POST]
+ Request (application/json)
Add a new Location to the Locations collection
+ Body
{
"name": "President Kennedylaan 1",
"description": "Geodan building",
"encodingType": "application/vnd.geo+json",
"location": {
"coordinates": [
4.9132,
52.34227
],
"type": "Point"
},
}
+ Response 201 (application/json)
+ Headers
Location: /v1.0/Locations(1)
+ Body
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Locations(1)",
"name": "President Kennedylaan 1",
"description": "Geodan building",
"encodingType": "application/vnd.geo+json",
"location": {
"coordinates": [
4.9132,
52.34227
],
"type": "Point"
},
"Things@iot.navigationLink": "http://localhost/v1.0/Locations(1)/Things",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Locations(1)/HistoricalLocations"
}
+ Response 400 (application/json)
+ Body
{
"error": {
"status": "Bad Request",
"code": 400,
"message": [
"Missing mandatory parameter: ....."
]
}
}
### Post Location by Thing [POST /v1.0/Things({id})/Locations]
+ Parameters
+ id (number) - {INT} id of the Thing to set the location for
+ Request (application/json)
Add a new Location and link to Thing
+ Body
{
"name": "President Kennedylaan 1",
"description": "Geodan building",
"encodingType": "application/vnd.geo+json",
"location": {
"coordinates": [
4.9132,
52.34227
],
"type": "Point"
},
}
+ Response 201 (application/json)
+ Headers
Location: /v1.0/Locations(1)
+ Body
{
"@iot.id": 1,
"@iot.selfLink": "http://localhost/v1.0/Locations(1)",
"name": "President Kennedylaan 1",
"description": "Geodan building",
"encodingType": "application/vnd.geo+json",
"location": {
"coordinates": [
4.9132,
52.34227
],
"type": "Point"
},
"Things@iot.navigationLink": "http://localhost/v1.0/Locations(1)/Things",
"HistoricalLocations@iot.navigationLink": "http://localhost/v1.0/Locations(1)/HistoricalLocations"
}
+ Response 400 (application/json)
+ Body
{
"error": {
"status": "Bad Request",
"code": 400,
"message": [
"Missing mandatory parameter: ....."
]
}
}
### Patch Location [PATCH /v1.0/Locations({id})]
+ Parameters
+ id (number) - {INT} ID of Location to patch
+ Request (application/json)
Patch a specified Location
+ Body
{
"name": "ALL YOUR BASE",
"description": "Geodan building",
"encodingType": "application/vnd.geo+json",
"location": {
"coordinates": [
4.9132,
52.34227
],
"type": "Point"
}
}
+ Response 200 (application/json)