-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
spatial.json
1604 lines (1604 loc) · 63.6 KB
/
spatial.json
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
{
"swagger": "2.0",
"info": {
"title": "Azure Maps Spatial Service",
"version": "1.0",
"description": "Azure Maps Spatial REST APIs"
},
"host": "atlas.microsoft.com",
"schemes": [
"https"
],
"consumes": [],
"produces": [
"application/json",
"application/xml"
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.",
"scopes": {
"user_impersonation": "Impersonates a user's Azure Active Directory account."
}
},
"apiKeyQuery": {
"type": "apiKey",
"description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.",
"name": "subscription-key",
"in": "query"
}
},
"security": [
{
"azure_auth": []
},
{
"apiKeyQuery": []
}
],
"responses": {
"202": {
"description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.",
"headers": {
"Location": {
"type": "string",
"description": "New URL to check for the results of the long running process."
}
}
},
"400": {
"description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.",
"schema": {
"$ref": "#/definitions/ODataErrorResponse"
}
},
"401": {
"description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.",
"schema": {
"$ref": "#/definitions/ODataErrorResponse"
},
"headers": {
"WWW-Authenticate": {
"type": "string",
"description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\""
}
}
},
"403": {
"description": "Permission, capacity, or authentication issues.",
"schema": {
"$ref": "#/definitions/ODataErrorResponse"
}
},
"404": {
"description": "Not Found: the requested resource could not be found, but it may be available again in the future.",
"schema": {
"$ref": "#/definitions/ODataErrorResponse"
}
},
"500": {
"description": "An error occurred while processing the request. Please try again later.",
"schema": {
"$ref": "#/definitions/ODataErrorResponse"
}
}
},
"parameters": {
"ClientId": {
"name": "x-ms-client-id",
"description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.",
"type": "string",
"in": "header",
"required": false,
"x-ms-parameter-location": "client"
},
"SubscriptionKey": {
"name": "subscription-key",
"description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.",
"type": "string",
"in": "query",
"required": false,
"x-ms-parameter-location": "client"
},
"ApiVersion": {
"name": "api-version",
"description": "Version number of Azure Maps API. Current version is 1.0",
"type": "string",
"in": "query",
"required": true,
"default": "1.0",
"x-ms-parameter-location": "client"
},
"JsonFormat": {
"name": "format",
"description": "Desired format of the response. Only `json` format is supported.",
"type": "string",
"in": "path",
"required": true,
"enum": [
"json"
],
"x-ms-enum": {
"name": "JsonFormat",
"modelAsString": true,
"values": [
{
"value": "json",
"description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)"
}
]
},
"x-ms-parameter-location": "method"
},
"TextFormat": {
"name": "format",
"description": "Desired format of the response. Value can be either _json_ or _xml_.",
"type": "string",
"in": "path",
"required": true,
"enum": [
"json",
"xml"
],
"x-ms-enum": {
"name": "TextFormat",
"modelAsString": true,
"values": [
{
"value": "json",
"description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)"
},
{
"value": "xml",
"description": "[The Extensible Markup Language](https://www.w3.org/TR/xml/)"
}
]
},
"x-ms-parameter-location": "method"
},
"Mode": {
"name": "mode",
"in": "query",
"description": "Mode of the geofencing async event mechanism.",
"required": false,
"type": "string",
"enum": [
"All",
"EnterAndExit"
],
"x-ms-enum": {
"name": "GeofenceMode",
"modelAsString": true,
"values": [
{
"value": "All",
"description": "Publish all the query results to Azure Maps account event subscription."
},
{
"value": "EnterAndExit",
"description": "Only publish result when user location is considered as crossing geofencing boarder."
}
]
},
"x-ms-parameter-location": "method"
},
"UdidSpatial": {
"name": "udid",
"in": "query",
"description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"SpatialDataUploadFormat": {
"name": "dataFormat",
"description": "Data format of the content being uploaded. Currently, only `geojson` format is supported.",
"type": "string",
"in": "query",
"required": true,
"enum": [
"geojson"
],
"x-ms-enum": {
"name": "SpatialDataUploadFormat",
"modelAsString": true,
"values": [
{
"value": "geojson",
"description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format."
}
]
},
"x-ms-parameter-location": "method"
}
},
"paths": {
"/spatial/geofence/{format}": {
"get": {
"x-publish": true,
"description": "**Search Geofence Get API**\n\n**Applies to:** S1 Pricing tier.\n\nThe Geofence Get API allows you to retrieve the proximity of a coordinate to a \ngeofence that has been uploaded to the Data service. You can use the \n[Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) to upload \na geofence or set of fences. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) \nfor more details on the geofence data format. To query the proximity of a coordinate, you supply the location of the object you are tracking as well\nas the ID for the fence or set of fences, and the response will contain information about\nthe distance from the outer edge of the geofence. A negative value signifies that the \ncoordinate is inside of the fence while a positive value means that it is outside of the\nfence.<br><br>This API can be used for a variety of scenarios that include things like asset \ntracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).\nTo test this API, you can upload the sample data from Post Geofence API examples(Request Body) via Data Upload API and replace the [udid] from the sample request below with the udid returned by Data Upload API.\n\n\n### Geofencing InnerError code\n\nIn geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`.\n\ninnererror.code | error.message\n---------------------------- | -------------------------------------- \nNullDeviceId | Device Id should not be null.\nNullUdid\t | Udid should not be null.\nUdidWrongFormat| Udid should be acquired from user data ingestion API.\nInvalidUserTime| Usertime is invalid.\nInvalidSearchBuffer| Searchbuffer is invalid.\nInvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters.\nInvalidLatLon| Lat and/or lon parameters are invalid.\nInvalidIsAsyncValue| The IsAsync parameter is invalid.\nInvalidModeValue| The mode parameter invalid.\nInvalidJson| Geofencing data is not a valid json file.\nNotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections.\nInvalidGeoJson| Geofencing data is invalid.\nNoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id.\nNoUserDataWithUdid|\tCan't find user geofencing data with provided udId.",
"operationId": "Spatial_GetGeofence",
"x-ms-examples": {
"Geofence": {
"$ref": "./examples/GetGeofence.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/JsonFormat"
},
{
"name": "deviceId",
"in": "query",
"description": "ID of the device",
"required": true,
"type": "string"
},
{
"name": "udId",
"in": "query",
"description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.",
"required": true,
"type": "string"
},
{
"name": "lat",
"in": "query",
"description": "The latitude of the location being passed. Example: 48.36.",
"required": true,
"type": "number"
},
{
"name": "lon",
"in": "query",
"description": "The longitude of the location being passed. Example: -124.63.",
"required": true,
"type": "number"
},
{
"name": "z",
"in": "query",
"description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion is used. Example: 200.",
"required": false,
"type": "number"
},
{
"name": "userTime",
"in": "query",
"description": "The user request time. If not presented in the request, the default value is DateTime.Now.",
"required": false,
"type": "string"
},
{
"name": "searchBuffer",
"in": "query",
"description": "The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.",
"required": false,
"type": "number",
"minimum": 0,
"maximum": 500,
"default": 50
},
{
"name": "isAsync",
"in": "query",
"description": "If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.",
"required": false,
"type": "boolean",
"default": false
},
{
"$ref": "#/parameters/Mode"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK The X-Correlation-id header value is present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.",
"headers": {
"X-Correlation-id": {
"description": "Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/GeofenceResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
},
"post": {
"x-publish": true,
"description": "**Search Geofence Post API**\n**Applies to:** S1 Pricing tier.\nThe Geofence Post API allows you to retrieve the proximity of a coordinate to a provided geofence or set of fences. With POST call, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) for more details on the geofence data format. The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.<br><br>This API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).",
"operationId": "Spatial_PostGeofence",
"x-ms-examples": {
"Geofence": {
"$ref": "./examples/PostGeofence.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/JsonFormat"
},
{
"name": "deviceId",
"in": "query",
"description": "ID of the device",
"required": true,
"type": "string"
},
{
"name": "lat",
"in": "query",
"description": "The latitude of the location being passed. Example: 48.36.",
"required": true,
"type": "number"
},
{
"name": "lon",
"in": "query",
"description": "The longitude of the location being passed. Example: -124.63.",
"required": true,
"type": "number"
},
{
"name": "z",
"in": "query",
"description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion geofencing is applied. Example: 200.",
"required": false,
"type": "number"
},
{
"name": "userTime",
"in": "query",
"description": "The user request time. If not presented in the request, the default value is DateTime.UtcNow.",
"required": false,
"type": "string"
},
{
"name": "searchBuffer",
"in": "query",
"description": "The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.",
"required": false,
"type": "number",
"minimum": 0,
"maximum": 500,
"default": 50
},
{
"name": "isAsync",
"in": "query",
"description": "If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.",
"required": false,
"type": "boolean",
"default": false
},
{
"$ref": "#/parameters/Mode"
},
{
"name": "searchGeofenceRequestBody",
"in": "body",
"description": "The geofencing GeoJSON data.",
"required": true,
"schema": {
"$ref": "#/definitions/GeoJSONFeatureCollection"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK The X-Correlation-id header value is present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.",
"headers": {
"X-Correlation-id": {
"description": "Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/GeofenceResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
},
"/spatial/buffer/{format}": {
"post": {
"x-publish": true,
"description": "**Applies to**: S1 pricing tier.\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.",
"operationId": "Spatial_PostBuffer",
"x-ms-examples": {
"PostBuffer": {
"$ref": "./examples/PostBuffer.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/JsonFormat"
},
{
"name": "bufferRequestBody",
"in": "body",
"description": "The FeatureCollection and the list of distances (one per feature or one for all features).",
"required": true,
"schema": {
"$ref": "#/definitions/BufferRequestBody"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BufferResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
},
"get": {
"x-publish": true,
"description": "**Applies to**: S1 pricing tier.\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postbuffer#examples) examples(Request Body without distances array) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getbuffer#examples) with the udid returned by Data Upload API.",
"operationId": "Spatial_GetBuffer",
"x-ms-examples": {
"GetBuffer": {
"$ref": "./examples/GetBuffer.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/JsonFormat"
},
{
"$ref": "#/parameters/UdidSpatial"
},
{
"name": "distances",
"in": "query",
"description": "The list of distances (one per feature or one for all features), delimited by semicolons. For example, 12.34;-56.78. Positive distance will generate a buffer outside of the feature, whereas negative distance will generate a buffer inside of the feature. If the negative distance larger than the geometry itself, an empty polygon will be returned.",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BufferResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
},
"/spatial/closestPoint/{format}": {
"post": {
"x-publish": true,
"description": "**Applies to**: S1 pricing tier.\n\nThis API returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.",
"operationId": "Spatial_PostClosestPoint",
"x-ms-examples": {
"PostClosestPoint": {
"$ref": "./examples/PostClosestPoint.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/JsonFormat"
},
{
"name": "lat",
"in": "query",
"description": "The base point latitude of the location being passed. Example: 47.622942.",
"required": true,
"type": "number"
},
{
"name": "lon",
"in": "query",
"description": "The base point longitude of the location being passed. Example: -122.316456.",
"required": true,
"type": "number"
},
{
"name": "numberOfClosestPoints",
"in": "query",
"description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50",
"required": false,
"type": "integer"
},
{
"name": "closestPointRequestBody",
"in": "body",
"description": "The FeatureCollection of Point geometries from which closest point to source point should be determined. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.",
"required": true,
"schema": {
"$ref": "#/definitions/GeoJSONFeatureCollection"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PostClosestPointResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
},
"get": {
"x-publish": true,
"description": "**Applies to**: S1 pricing tier.\n\nThis API returns the closest point between a base point and a given set of points in the user uploaded data set identified by udid. The set of target points is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postclosestpoint#examples) examples(Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getclosestpoint#examples) with the udid returned by Data Upload API.",
"operationId": "Spatial_GetClosestPoint",
"x-ms-examples": {
"GetClosestPoint": {
"$ref": "./examples/GetClosestPoint.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/JsonFormat"
},
{
"$ref": "#/parameters/UdidSpatial"
},
{
"name": "lat",
"in": "query",
"description": "The base point latitude of the location being passed. Example: 47.622942.",
"required": true,
"type": "number"
},
{
"name": "lon",
"in": "query",
"description": "The base point longitude of the location being passed. Example: -122.316456.",
"required": true,
"type": "number"
},
{
"name": "numberOfClosestPoints",
"in": "query",
"description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50",
"required": false,
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/GetClosestPointResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
},
"/spatial/pointInPolygon/{format}": {
"post": {
"x-publish": true,
"description": "**Applies to**: S1 pricing tier.\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.",
"operationId": "Spatial_PostPointInPolygon",
"x-ms-examples": {
"PostPointInPolygon": {
"$ref": "./examples/PostPointInPolygon.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/JsonFormat"
},
{
"name": "lat",
"in": "query",
"description": "The base point latitude of the location being passed. Example: 47.622942.",
"required": true,
"type": "number"
},
{
"name": "lon",
"in": "query",
"description": "The base point longitude of the location being passed. Example: -122.316456.",
"required": true,
"type": "number"
},
{
"name": "pointInPolygonRequestBody",
"in": "body",
"description": "A FeatureCollection with a set of Polygon/MultiPolygon geometries. The maximum number of vertices accepted to form a Polygon is 10,000. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.",
"required": true,
"schema": {
"$ref": "#/definitions/GeoJSONFeatureCollection"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PostPointInPolygonResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
},
"get": {
"x-publish": true,
"description": "**Applies to**: S1 pricing tier.\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postpointinpolygon#examples) examples(Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getpointinpolygon#examples) with the udid returned by Data Upload API.",
"operationId": "Spatial_GetPointInPolygon",
"x-ms-examples": {
"GetPointInPolygon": {
"$ref": "./examples/GetPointInPolygon.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/JsonFormat"
},
{
"$ref": "#/parameters/UdidSpatial"
},
{
"name": "lat",
"in": "query",
"description": "The base point latitude of the location being passed. Example: 47.622942.",
"required": true,
"type": "number"
},
{
"name": "lon",
"in": "query",
"description": "The base point longitude of the location being passed. Example: -122.316456.",
"required": true,
"type": "number"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/GetPointInPolygonResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
},
"/spatial/greatCircleDistance/{format}": {
"get": {
"x-publish": true,
"description": "**Applies to**: S1 pricing tier.\n\nThis API will return the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.",
"operationId": "Spatial_GetGreatCircleDistance",
"x-ms-examples": {
"GetGreatCircleDistance": {
"$ref": "./examples/GetGreatCircleDistance.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/JsonFormat"
},
{
"name": "query",
"in": "query",
"description": "The Coordinates through which the distance is calculated, delimited by a colon. Two coordinates are required. The first one is the source point coordinate and the last is the target point coordinate. For example, 47.622942,122.316456:57.673988,127.121513",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/GreatCircleDistanceResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
}
},
"definitions": {
"ODataErrorResponse": {
"type": "object",
"description": "This response object is returned when an error occurs in the Maps API.",
"properties": {
"error": {
"$ref": "#/definitions/ODataError"
}
}
},
"ODataError": {
"type": "object",
"description": "This object is returned when an error occurs in the Maps API.",
"properties": {
"code": {
"type": "string",
"readOnly": true,
"description": "The ODataError code."
},
"message": {
"type": "string",
"readOnly": true,
"description": "If available, a human readable description of the error."
},
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/ODataError"
}
},
"target": {
"type": "string",
"readOnly": true,
"description": "If available, the target causing the error."
}
}
},
"SpatialCoordinate": {
"description": "A location represented as a latitude and longitude",
"type": "object",
"properties": {
"lat": {
"description": "Latitude property",
"type": "number",
"format": "double",
"readOnly": true
},
"lon": {
"description": "Longitude property",
"type": "number",
"format": "double",
"readOnly": true
}
}
},
"GeoJSONFeatureCollection": {
"description": "A valid `GeoJSON FeatureCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details.",
"type": "object",
"properties": {
"type": {
"description": "Specifies the `type` for the object. Value should always be equal to \"FeatureCollection\".",