-
Notifications
You must be signed in to change notification settings - Fork 5k
/
search.json
3580 lines (3580 loc) · 147 KB
/
search.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 Search Service",
"version": "1.0",
"description": "Azure Maps Search 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#### Notes\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* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe 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* \nUsage 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 that 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.\n\n 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.\n\n 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 (Azure AD) 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 Azure AD 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"
}
},
"202Async": {
"description": "**Supported only for async request.**\nRequest 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."
}
}
}
},
"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 the 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"
},
"LimitSearch": {
"name": "limit",
"in": "query",
"description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100",
"required": false,
"type": "integer",
"default": 10,
"minimum": 1,
"maximum": 100,
"x-ms-parameter-location": "method"
},
"Offset": {
"name": "ofs",
"in": "query",
"description": "Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900",
"required": false,
"type": "integer",
"default": 0,
"minimum": 0,
"maximum": 1900,
"x-ms-parameter-location": "method"
},
"OptionalBiasLat": {
"name": "lat",
"in": "query",
"description": "Latitude where results should be biased. E.g. 37.337",
"required": false,
"type": "number",
"x-ms-parameter-location": "method"
},
"OptionalBiasLon": {
"name": "lon",
"in": "query",
"description": "Longitude where results should be biased. E.g. -121.89",
"required": false,
"type": "number",
"x-ms-parameter-location": "method"
},
"BoundingBoxTopLeft": {
"x-client-name": "BoundingBoxTopLeft",
"name": "topLeft",
"in": "query",
"description": "Top left position of the bounding box. E.g. 37.553,-122.453",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"BoundingBoxBottomRight": {
"x-client-name": "BoundingBoxBottomRight",
"name": "btmRight",
"in": "query",
"description": "Bottom right position of the bounding box. E.g. 37.553,-122.453",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"RequiredBiasLat": {
"name": "lat",
"in": "query",
"description": "Latitude where results should be biased. E.g. 37.337.",
"required": true,
"type": "number",
"x-ms-parameter-location": "method"
},
"RequiredBiasLon": {
"name": "lon",
"in": "query",
"description": "Longitude where results should be biased. E.g. -121.89.",
"required": true,
"type": "number",
"x-ms-parameter-location": "method"
},
"Language": {
"name": "language",
"in": "query",
"description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"Query": {
"name": "query",
"in": "query",
"description": "The applicable query string. Must be properly URL encoded.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"Position": {
"name": "query",
"in": "query",
"description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"View": {
"name": "view",
"in": "query",
"description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"SearchIndexSet": {
"name": "idxSet",
"in": "query",
"description": "A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"Addr",
"Geo",
"PAD",
"POI",
"Str",
"Xstr"
],
"x-ms-enum": {
"name": "SearchIndexSet",
"modelAsString": true,
"values": [
{
"value": "Addr",
"description": "Address range interpolation"
},
{
"value": "Geo",
"description": "Geographies"
},
{
"value": "PAD",
"description": "Point Addresses"
},
{
"value": "POI",
"description": "Points of interest"
},
{
"value": "Str",
"description": "Streets"
},
{
"value": "Xstr",
"description": "Cross Streets (Intersections)"
}
]
}
},
"collectionFormat": "csv",
"x-ms-parameter-location": "method"
},
"ExtendedPostalCodesFor": {
"name": "extendedPostalCodesFor",
"in": "query",
"description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **Addr** = Address ranges \n\n **Geo** = Geographies \n\n **PAD** = Point Addresses \n\n **POI** = Points of Interest \n\n **Str** = Streets \n\n **XStr** = Cross Streets (intersections)\n\nValue should be a comma separated list of index types (in any order) or **None** for no indexes.\n\nBy default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=PAD,Addr,POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent.",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"ExtendedPostalCodesForPoi": {
"name": "extendedPostalCodesFor",
"in": "query",
"description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **POI** = Points of Interest \n\nValue should be **POI** or **None** to disable extended postal codes.\n\nBy default extended postal codes are included.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent.",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"Typeahead": {
"name": "typeahead",
"in": "query",
"description": "Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode",
"required": false,
"type": "boolean",
"default": false,
"x-ms-parameter-location": "method"
},
"CategorySet": {
"name": "categorySet",
"in": "query",
"description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: \n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ",
"required": false,
"type": "array",
"items": {
"type": "integer"
},
"collectionFormat": "csv",
"x-ms-parameter-location": "method"
},
"CountrySet": {
"name": "countrySet",
"in": "query",
"description": "Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"x-ms-parameter-location": "method"
},
"Radius": {
"name": "radius",
"in": "query",
"description": "The radius in meters to for the results to be constrained to the defined area",
"required": false,
"type": "number",
"x-ms-parameter-location": "method"
},
"PoiQuery": {
"name": "query",
"in": "query",
"description": "The POI name to search for (e.g., \"statue of liberty\", \"starbucks\", \"pizza\"). Must be properly URL encoded.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"BrandSet": {
"name": "brandSet",
"in": "query",
"description": "A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a \",\" in their name should be put into quotes.\n\nUsage examples:\n\n brandSet=Foo\n\n brandSet=Foo,Bar\n\n brandSet=\"A,B,C Comma\",Bar",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv",
"x-ms-parameter-location": "method"
},
"ConnectorSet": {
"name": "connectorSet",
"in": "query",
"description": "A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.\n\nAvailable connector types are:\n * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets).\n * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.\n * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.\n * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.\n * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.\n * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.\n * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration.\n * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard.\n * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.\n\nUsage examples:\n\n connectorSet=IEC62196Type2CableAttached\n connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached",
"required": false,
"type": "array",
"items": {
"type": "string",
"enum": [
"StandardHouseholdCountrySpecific",
"IEC62196Type1",
"IEC62196Type1CCS",
"IEC62196Type2CableAttached",
"IEC62196Type2Outlet",
"IEC62196Type2CCS",
"IEC62196Type3",
"Chademo",
"IEC60309AC1PhaseBlue",
"IEC60309DCWhite",
"Tesla"
],
"x-ms-enum": {
"name": "ConnectorSet",
"modelAsString": true,
"values": [
{
"value": "StandardHouseholdCountrySpecific",
"description": "These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage.\n\nSee also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets)"
},
{
"value": "IEC62196Type1",
"description": "Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure."
},
{
"value": "IEC62196Type1CCS",
"description": "Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging."
},
{
"value": "IEC62196Type2CableAttached",
"description": "Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point"
},
{
"value": "IEC62196Type2Outlet",
"description": "Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point."
},
{
"value": "IEC62196Type2CCS",
"description": "Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging."
},
{
"value": "IEC62196Type3",
"description": "Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure."
},
{
"value": "Chademo",
"description": "CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging."
},
{
"value": "IEC60309AC1PhaseBlue",
"description": "Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration."
},
{
"value": "IEC60309DCWhite",
"description": "Industrial White connector is a DC connector defined in the IEC 60309 standard."
},
{
"value": "Tesla",
"description": "The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe."
}
]
}
},
"collectionFormat": "csv",
"x-ms-parameter-location": "method"
},
"OpeningHours": {
"name": "openingHours",
"description": "Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available.\nSupported value: nextSevenDays",
"type": "string",
"in": "query",
"required": false,
"enum": [
"nextSevenDays"
],
"x-ms-enum": {
"name": "OpeningHours",
"modelAsString": true,
"values": [
{
"value": "nextSevenDays",
"description": "Shows the hours of operation for the next week, starting with the current day in the local time of the POI."
}
]
},
"x-ms-parameter-location": "method"
}
},
"paths": {
"/search/polygon/{format}": {
"get": {
"x-publish": true,
"description": "**Get Polygon**\n\n\n**Applies to**: S1 pricing tier.\n\n\nThe Get Polygon service allows you to request the geometry data such as a city or country outline for a set of entities, previously retrieved from an Online Search request in GeoJSON format. The geometry ID is returned in the dataSources object under \"geometry\" and \"id\" in either a Search Address or Search Fuzzy call.\n\nPlease note that any geometry ID retrieved from an Online Search endpoint has a limited lifetime. The client should not store geometry IDs in persistent storage for later referral, as the stability of these identifiers is not guaranteed for a long period of time. It is expected that a request to the Polygon method is made within a few minutes of the request to the Online Search method that provided the ID. The service allows for batch requests up to 20 identifiers.",
"operationId": "Search_GetSearchPolygon",
"x-ms-examples": {
"Get the Geometry using the geometry id returned by the previous Search": {
"$ref": "./examples/GetSearchPolygon.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/JsonFormat"
},
{
"name": "geometries",
"in": "query",
"description": "Comma separated list of geometry UUIDs, previously retrieved from an Online Search request.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SearchPolygonResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
},
"produces": [
"application/json"
]
}
},
"/search/fuzzy/{format}": {
"get": {
"x-publish": true,
"description": "\n**Free Form Search**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThe basic default API is Free Form Search which handles the most fuzzy of inputs handling any combination of address or POI tokens. This search API is the canonical 'single line search'. The Free Form Search API is a seamless combination of POI search and geocoding. The API can also be weighted with a contextual position (lat./lon. pair), or fully constrained by a coordinate and radius, or it can be executed more generally without any geo biasing anchor point.<br><br>We strongly advise you to use the 'countrySet' parameter to specify only the countries for which your application needs coverage, as the default behavior will be to search the entire world, potentially returning unnecessary results.<br><br> E.g.: `countrySet`=US,FR <br><br>Please see [Search Coverage](https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) for a complete list of all the supported countries.<br><br>Most Search queries default to `maxFuzzyLevel`=2 to gain performance and also reduce unusual results. This new default can be overridden as needed per request by passing in the query param `maxFuzzyLevel`=3 or 4.",
"operationId": "Search_GetSearchFuzzy",
"x-ms-examples": {
"Search City Seattle": {
"$ref": "./examples/GetSearchFuzzy.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TextFormat"
},
{
"name": "query",
"in": "query",
"description": "The applicable query string (e.g., \"seattle\", \"pizza\"). Can _also_ be specified as a comma separated string composed by latitude followed by longitude (e.g., \"47.641268, -122.125679\"). Must be properly URL encoded.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"$ref": "#/parameters/Typeahead"
},
{
"$ref": "#/parameters/LimitSearch"
},
{
"$ref": "#/parameters/Offset"
},
{
"$ref": "#/parameters/CategorySet"
},
{
"$ref": "#/parameters/CountrySet"
},
{
"$ref": "#/parameters/OptionalBiasLat"
},
{
"$ref": "#/parameters/OptionalBiasLon"
},
{
"$ref": "#/parameters/Radius"
},
{
"$ref": "#/parameters/BoundingBoxTopLeft"
},
{
"$ref": "#/parameters/BoundingBoxBottomRight"
},
{
"$ref": "#/parameters/Language"
},
{
"$ref": "#/parameters/ExtendedPostalCodesFor"
},
{
"name": "minFuzzyLevel",
"in": "query",
"description": "Minimum fuzziness level to be used. Default: 1, minimum: 1 and maximum: 4\n\n* Level 1 has no spell checking.\n\n* Level 2 uses normal n-gram spell checking. For example, query \"restrant\" can be matched to \"restaurant.\"\n\n* Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for \"rstrnt\" to \"restaurant\" matching. Shingle spell checking is for \"mountainview\" to \"mountain view\" matching.\n\n* Level 4 doesn’t add any more spell checking functions.\n\n\n\nThe search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.",
"required": false,
"type": "integer",
"default": 1,
"minimum": 1,
"maximum": 4
},
{
"name": "maxFuzzyLevel",
"in": "query",
"description": "Maximum fuzziness level to be used. Default: 2, minimum: 1 and maximum: 4\n\n* Level 1 has no spell checking.\n\n* Level 2 uses normal n-gram spell checking. For example, query \"restrant\" can be matched to \"restaurant.\"\n\n* Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for \"rstrnt\" to \"restaurant\" matching. Shingle spell checking is for \"mountainview\" to \"mountain view\" matching.\n\n* Level 4 doesn’t add any more spell checking functions.\n\n\n\nThe search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.",
"required": false,
"type": "integer",
"default": 2,
"minimum": 1,
"maximum": 4
},
{
"$ref": "#/parameters/SearchIndexSet"
},
{
"$ref": "#/parameters/BrandSet"
},
{
"$ref": "#/parameters/ConnectorSet"
},
{
"$ref": "#/parameters/View"
},
{
"$ref": "#/parameters/OpeningHours"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SearchFuzzyResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
},
"/search/poi/{format}": {
"get": {
"x-publish": true,
"description": "**Get POI by Name**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nPoints of Interest (POI) Search allows you to request POI results by name. Search supports additional query parameters such as language and filtering results by area of interest driven by country or bounding box. Endpoint will return only POI results matching the query string. Response includes POI details such as address, coordinate location and category.",
"operationId": "Search_GetSearchPOI",
"x-ms-examples": {
"Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results": {
"$ref": "./examples/GetSearchPOI.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TextFormat"
},
{
"name": "query",
"in": "query",
"description": "The POI name to search for (e.g., \"statue of liberty\", \"starbucks\"), must be properly URL encoded.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"$ref": "#/parameters/Typeahead"
},
{
"$ref": "#/parameters/LimitSearch"
},
{
"$ref": "#/parameters/Offset"
},
{
"$ref": "#/parameters/CategorySet"
},
{
"$ref": "#/parameters/CountrySet"
},
{
"$ref": "#/parameters/OptionalBiasLat"
},
{
"$ref": "#/parameters/OptionalBiasLon"
},
{
"$ref": "#/parameters/Radius"
},
{
"$ref": "#/parameters/BoundingBoxTopLeft"
},
{
"$ref": "#/parameters/BoundingBoxBottomRight"
},
{
"$ref": "#/parameters/Language"
},
{
"$ref": "#/parameters/ExtendedPostalCodesForPoi"
},
{
"$ref": "#/parameters/BrandSet"
},
{
"$ref": "#/parameters/ConnectorSet"
},
{
"$ref": "#/parameters/View"
},
{
"$ref": "#/parameters/OpeningHours"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SearchPoiResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
},
"/search/nearby/{format}": {
"get": {
"x-publish": true,
"description": "**Nearby Search**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nIf you have a use case for only retrieving POI results around a specific location, the nearby search method may be the right choice. This endpoint will only return POI results, and does not take in a search query parameter.",
"operationId": "Search_GetSearchNearby",
"x-ms-examples": {
"Search for any points of interest (POI) within 5 miles of Manhattan NY and return the top 10 results": {
"$ref": "./examples/GetSearchNearby.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TextFormat"
},
{
"$ref": "#/parameters/RequiredBiasLat"
},
{
"$ref": "#/parameters/RequiredBiasLon"
},
{
"$ref": "#/parameters/LimitSearch"
},
{
"$ref": "#/parameters/Offset"
},
{
"$ref": "#/parameters/CategorySet"
},
{
"$ref": "#/parameters/CountrySet"
},
{
"name": "radius",
"in": "query",
"description": "The radius in meters to for the results to be constrained to the defined area, Min value is 1, Max Value is 50000.",
"required": false,
"type": "number"
},
{
"$ref": "#/parameters/Language"
},
{
"$ref": "#/parameters/ExtendedPostalCodesFor"
},
{
"$ref": "#/parameters/BrandSet"
},
{
"$ref": "#/parameters/ConnectorSet"
},
{
"$ref": "#/parameters/View"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SearchNearbyResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
},
"/search/poi/category/{format}": {
"get": {
"x-publish": true,
"description": "**Get POI by Category**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nPoints of Interest (POI) Category Search allows you to request POI results from given category. Search allows to query POIs from one category at a time. Endpoint will only return POI results which are categorized as specified. Response includes POI details such as address, coordinate location and classification.",
"operationId": "Search_GetSearchPOICategory",
"x-ms-examples": {
"Search for atm's within 2 miles of Times Square NY and return the top 3 results": {
"$ref": "./examples/GetSearchPOICategory.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},
{
"$ref": "#/parameters/SubscriptionKey"
},
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/TextFormat"
},
{
"name": "query",
"in": "query",
"description": "The POI category to search for (e.g., \"AIRPORT\", \"RESTAURANT\"), must be properly URL encoded. Supported main categories can be requested by calling [Get Search POI Category Tree API](https://aka.ms/AzureMapsPOICategoryTree). List of available categories can also be found [here](https://docs.microsoft.com/azure/azure-maps/supported-search-categories). We recommend to use POI Search Category Tree API to request the supported categories.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"$ref": "#/parameters/Typeahead"
},
{
"$ref": "#/parameters/LimitSearch"
},
{
"$ref": "#/parameters/Offset"
},
{
"$ref": "#/parameters/CategorySet"
},
{
"$ref": "#/parameters/CountrySet"
},
{
"$ref": "#/parameters/OptionalBiasLat"
},
{
"$ref": "#/parameters/OptionalBiasLon"
},
{
"$ref": "#/parameters/Radius"
},
{
"$ref": "#/parameters/BoundingBoxTopLeft"
},
{
"$ref": "#/parameters/BoundingBoxBottomRight"
},
{
"$ref": "#/parameters/Language"
},
{
"$ref": "#/parameters/ExtendedPostalCodesFor"
},
{
"$ref": "#/parameters/BrandSet"
},
{
"$ref": "#/parameters/ConnectorSet"
},
{
"$ref": "#/parameters/View"
},
{
"$ref": "#/parameters/OpeningHours"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SearchPoiCategoryResponse"
}
},
"400": {
"$ref": "#/responses/400"
},
"401": {
"$ref": "#/responses/401"
},
"403": {
"$ref": "#/responses/403"
},
"404": {
"$ref": "#/responses/404"
},
"500": {
"$ref": "#/responses/500"
}
}
}
},
"/search/poi/category/tree/{format}": {
"get": {
"x-publish": true,
"description": "**Get POI Category Tree**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nPOI Category API provides a full list of supported Points of Interest (POI) categories and subcategories together with their translations and synonyms. The returned content can be used to provide more meaningful results through other Search Service APIs, like [Get Search POI](https://docs.microsoft.com/rest/api/maps/search/getsearchpoi).",
"operationId": "Search_GetSearchPOICategoryTreePreview",
"x-ms-examples": {
"Get the POI Category Tree (only partial response shown below)": {
"$ref": "./examples/GetPOICategoryTree.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ClientId"
},